Class protos.google.cloud.asset.v1.IamPolicySearchResult (5.1.0)

Represents an IamPolicySearchResult.

Package

@google-cloud/asset

Constructors

(constructor)(properties)

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

Constructs a new IamPolicySearchResult.

Parameter
NameDescription
properties IIamPolicySearchResult

Properties to set

Properties

assetType

public assetType: string;

IamPolicySearchResult assetType.

explanation

public explanation?: (google.cloud.asset.v1.IamPolicySearchResult.IExplanation|null);

IamPolicySearchResult explanation.

folders

public folders: string[];

IamPolicySearchResult folders.

organization

public organization: string;

IamPolicySearchResult organization.

policy

public policy?: (google.iam.v1.IPolicy|null);

IamPolicySearchResult policy.

project

public project: string;

IamPolicySearchResult project.

resource

public resource: string;

IamPolicySearchResult resource.

Methods

create(properties)

public static create(properties?: google.cloud.asset.v1.IIamPolicySearchResult): google.cloud.asset.v1.IamPolicySearchResult;

Creates a new IamPolicySearchResult instance using the specified properties.

Parameter
NameDescription
properties IIamPolicySearchResult

Properties to set

Returns
TypeDescription
IamPolicySearchResult

IamPolicySearchResult instance

decode(reader, length)

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

Decodes an IamPolicySearchResult message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
IamPolicySearchResult

IamPolicySearchResult

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
IamPolicySearchResult

IamPolicySearchResult

encode(message, writer)

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

Encodes the specified IamPolicySearchResult message. Does not implicitly messages.

Parameters
NameDescription
message IIamPolicySearchResult

IamPolicySearchResult message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
NameDescription
message IIamPolicySearchResult

IamPolicySearchResult message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

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

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
IamPolicySearchResult

IamPolicySearchResult

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for IamPolicySearchResult

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this IamPolicySearchResult to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message IamPolicySearchResult

IamPolicySearchResult

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies an IamPolicySearchResult message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not