Class protos.google.cloud.asset.v1.ResourceSearchResult (5.5.0)

Represents a ResourceSearchResult.

Package

@google-cloud/asset

Constructors

(constructor)(properties)

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

Constructs a new ResourceSearchResult.

Parameter
NameDescription
properties IResourceSearchResult

Properties to set

Properties

additionalAttributes

public additionalAttributes?: (google.protobuf.IStruct|null);

ResourceSearchResult additionalAttributes.

assetType

public assetType: string;

ResourceSearchResult assetType.

attachedResources

public attachedResources: google.cloud.asset.v1.IAttachedResource[];

ResourceSearchResult attachedResources.

createTime

public createTime?: (google.protobuf.ITimestamp|null);

ResourceSearchResult createTime.

description

public description: string;

ResourceSearchResult description.

displayName

public displayName: string;

ResourceSearchResult displayName.

effectiveTags

public effectiveTags: google.cloud.asset.v1.IEffectiveTagDetails[];

ResourceSearchResult effectiveTags.

folders

public folders: string[];

ResourceSearchResult folders.

kmsKey

public kmsKey: string;

ResourceSearchResult kmsKey.

kmsKeys

public kmsKeys: string[];

ResourceSearchResult kmsKeys.

labels

public labels: { [k: string]: string };

ResourceSearchResult labels.

location

public location: string;

ResourceSearchResult location.

name

public name: string;

ResourceSearchResult name.

networkTags

public networkTags: string[];

ResourceSearchResult networkTags.

organization

public organization: string;

ResourceSearchResult organization.

parentAssetType

public parentAssetType: string;

ResourceSearchResult parentAssetType.

parentFullResourceName

public parentFullResourceName: string;

ResourceSearchResult parentFullResourceName.

project

public project: string;

ResourceSearchResult project.

relationships

public relationships: { [k: string]: google.cloud.asset.v1.IRelatedResources };

ResourceSearchResult relationships.

sccSecurityMarks

public sccSecurityMarks: { [k: string]: string };

ResourceSearchResult sccSecurityMarks.

state

public state: string;

ResourceSearchResult state.

tagKeys

public tagKeys: string[];

ResourceSearchResult tagKeys.

tags

public tags: google.cloud.asset.v1.ITag[];

ResourceSearchResult tags.

tagValueIds

public tagValueIds: string[];

ResourceSearchResult tagValueIds.

tagValues

public tagValues: string[];

ResourceSearchResult tagValues.

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

ResourceSearchResult updateTime.

versionedResources

public versionedResources: google.cloud.asset.v1.IVersionedResource[];

ResourceSearchResult versionedResources.

Methods

create(properties)

public static create(properties?: google.cloud.asset.v1.IResourceSearchResult): google.cloud.asset.v1.ResourceSearchResult;

Creates a new ResourceSearchResult instance using the specified properties.

Parameter
NameDescription
properties IResourceSearchResult

Properties to set

Returns
TypeDescription
ResourceSearchResult

ResourceSearchResult instance

decode(reader, length)

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

Decodes a ResourceSearchResult 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
ResourceSearchResult

ResourceSearchResult

decodeDelimited(reader)

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

Decodes a ResourceSearchResult message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
ResourceSearchResult

ResourceSearchResult

encode(message, writer)

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

Encodes the specified ResourceSearchResult message. Does not implicitly messages.

Parameters
NameDescription
message IResourceSearchResult

ResourceSearchResult 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.IResourceSearchResult, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IResourceSearchResult

ResourceSearchResult 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.ResourceSearchResult;

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

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

Plain object

Returns
TypeDescription
ResourceSearchResult

ResourceSearchResult

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ResourceSearchResult

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 ResourceSearchResult to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message ResourceSearchResult

ResourceSearchResult

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a ResourceSearchResult 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