Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class protos.google.cloud.asset.v1.IamPolicyAnalysisQuery.Options (4.2.0)

Represents an Options.

Package

@google-cloud/asset

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.asset.v1.IamPolicyAnalysisQuery.IOptions);

Constructs a new Options.

Parameter

Name	Description
properties	`IOptions` Properties to set

Properties

analyzeServiceAccountImpersonation

public analyzeServiceAccountImpersonation: boolean;

Options analyzeServiceAccountImpersonation.

expandGroups

public expandGroups: boolean;

Options expandGroups.

expandResources

public expandResources: boolean;

Options expandResources.

expandRoles

public expandRoles: boolean;

Options expandRoles.

outputGroupEdges

public outputGroupEdges: boolean;

Options outputGroupEdges.

outputResourceEdges

public outputResourceEdges: boolean;

Options outputResourceEdges.

Methods

create(properties)

public static create(properties?: google.cloud.asset.v1.IamPolicyAnalysisQuery.IOptions): google.cloud.asset.v1.IamPolicyAnalysisQuery.Options;

Creates a new Options instance using the specified properties.

Parameter

Name	Description
properties	`IOptions` Properties to set

Returns

Type	Description
google.cloud.asset.v1.IamPolicyAnalysisQuery.Options	Options instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.asset.v1.IamPolicyAnalysisQuery.Options;

Decodes an Options message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.cloud.asset.v1.IamPolicyAnalysisQuery.Options	Options

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.asset.v1.IamPolicyAnalysisQuery.Options;

Decodes an Options message from the specified reader or buffer, length delimited.

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.cloud.asset.v1.IamPolicyAnalysisQuery.Options	Options

encode(message, writer)

public static encode(message: google.cloud.asset.v1.IamPolicyAnalysisQuery.IOptions, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Options message. Does not implicitly messages.

Parameters

Name	Description
message	`IOptions` Options message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.asset.v1.IamPolicyAnalysisQuery.IOptions, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Options message, length delimited. Does not implicitly messages.

Parameters

Name	Description
message	`IOptions` Options message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.asset.v1.IamPolicyAnalysisQuery.Options;

Creates an Options message from a plain object. Also converts values to their respective internal types.

Parameter

Name	Description
object	`{ [k: string]: any }` Plain object

Returns

Type	Description
google.cloud.asset.v1.IamPolicyAnalysisQuery.Options	Options

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for Options

Parameter

Name	Description
typeUrlPrefix	`string` your custom typeUrlPrefix(default "type.googleapis.com")

Returns

Type	Description
string	The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this Options to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: google.cloud.asset.v1.IamPolicyAnalysisQuery.Options, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from an Options message. Also converts values to other types if specified.

Parameters

Name	Description
message	`google.cloud.asset.v1.IamPolicyAnalysisQuery.Options` Options
options	`$protobuf.IConversionOptions` Conversion options

Returns

Type	Description
{ [k: string]: any }	Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies an Options message.

Parameter

Name	Description
message	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not