Class ResourceSearchResult (3.31.0) 

public final class ResourceSearchResult extends GeneratedMessageV3 implements ResourceSearchResultOrBuilder

A result of Resource Search, containing information of a cloud resource. Next ID: 34

Protobuf type google.cloud.asset.v1.ResourceSearchResult

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ResourceSearchResult

Static Fields

ADDITIONAL_ATTRIBUTES_FIELD_NUMBER

public static final int ADDITIONAL_ATTRIBUTES_FIELD_NUMBER
Field Value
Type Description
int

ASSET_TYPE_FIELD_NUMBER

public static final int ASSET_TYPE_FIELD_NUMBER
Field Value
Type Description
int

ATTACHED_RESOURCES_FIELD_NUMBER

public static final int ATTACHED_RESOURCES_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

EFFECTIVE_TAGS_FIELD_NUMBER

public static final int EFFECTIVE_TAGS_FIELD_NUMBER
Field Value
Type Description
int

FOLDERS_FIELD_NUMBER

public static final int FOLDERS_FIELD_NUMBER
Field Value
Type Description
int

KMS_KEYS_FIELD_NUMBER

public static final int KMS_KEYS_FIELD_NUMBER
Field Value
Type Description
int

KMS_KEY_FIELD_NUMBER

public static final int KMS_KEY_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

LOCATION_FIELD_NUMBER

public static final int LOCATION_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

NETWORK_TAGS_FIELD_NUMBER

public static final int NETWORK_TAGS_FIELD_NUMBER
Field Value
Type Description
int

ORGANIZATION_FIELD_NUMBER

public static final int ORGANIZATION_FIELD_NUMBER
Field Value
Type Description
int

PARENT_ASSET_TYPE_FIELD_NUMBER

public static final int PARENT_ASSET_TYPE_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FULL_RESOURCE_NAME_FIELD_NUMBER

public static final int PARENT_FULL_RESOURCE_NAME_FIELD_NUMBER
Field Value
Type Description
int

PROJECT_FIELD_NUMBER

public static final int PROJECT_FIELD_NUMBER
Field Value
Type Description
int

RELATIONSHIPS_FIELD_NUMBER

public static final int RELATIONSHIPS_FIELD_NUMBER
Field Value
Type Description
int

SCC_SECURITY_MARKS_FIELD_NUMBER

public static final int SCC_SECURITY_MARKS_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

TAGS_FIELD_NUMBER

public static final int TAGS_FIELD_NUMBER
Field Value
Type Description
int

TAG_KEYS_FIELD_NUMBER

public static final int TAG_KEYS_FIELD_NUMBER
Field Value
Type Description
int

TAG_VALUES_FIELD_NUMBER

public static final int TAG_VALUES_FIELD_NUMBER
Field Value
Type Description
int

TAG_VALUE_IDS_FIELD_NUMBER

public static final int TAG_VALUE_IDS_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

VERSIONED_RESOURCES_FIELD_NUMBER

public static final int VERSIONED_RESOURCES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ResourceSearchResult getDefaultInstance()
Returns
Type Description
ResourceSearchResult

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ResourceSearchResult.Builder newBuilder()
Returns
Type Description
ResourceSearchResult.Builder

newBuilder(ResourceSearchResult prototype)

public static ResourceSearchResult.Builder newBuilder(ResourceSearchResult prototype)
Parameter
Name Description
prototype ResourceSearchResult
Returns
Type Description
ResourceSearchResult.Builder

parseDelimitedFrom(InputStream input)

public static ResourceSearchResult parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ResourceSearchResult
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ResourceSearchResult parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResourceSearchResult
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ResourceSearchResult parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ResourceSearchResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ResourceSearchResult parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResourceSearchResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ResourceSearchResult parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ResourceSearchResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ResourceSearchResult parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResourceSearchResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ResourceSearchResult parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ResourceSearchResult
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ResourceSearchResult parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResourceSearchResult
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ResourceSearchResult parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ResourceSearchResult
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ResourceSearchResult parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResourceSearchResult
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ResourceSearchResult parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ResourceSearchResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ResourceSearchResult parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResourceSearchResult
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ResourceSearchResult> parser()
Returns
Type Description
Parser<ResourceSearchResult>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Labels associated with this resource. See Labelling and grouping Google Cloud resources for more information. This field is available only when the resource's Protobuf contains it.

To search against the labels:

  • Use a field query:
    • query on any label's key or value. Example: labels:prod
    • query by a given label. Example: labels.env:prod
    • query by a given label's existence. Example: labels.env:*
  • Use a free text query. Example: prod

map<string, string> labels = 7;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsRelationships(String key)

public boolean containsRelationships(String key)

A map of related resources of this resource, keyed by the relationship type. A relationship type is in the format of {SourceType}{ACTION}{DestType}. Example: DISK_TO_INSTANCE, DISK_TO_NETWORK, INSTANCE_TO_INSTANCEGROUP. See supported relationship types.

map<string, .google.cloud.asset.v1.RelatedResources> relationships = 21;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsSccSecurityMarks(String key)

public boolean containsSccSecurityMarks(String key)

The actual content of Security Command Center security marks associated with the asset.

Note that both staging & prod SecurityMarks are attached on prod resources. In CAS preprod/prod, both staging & prod SecurityMarks are ingested and returned in the following security_marks map. In that case, the prefix "staging." will be added to the keys of all the staging marks. To search against SCC SecurityMarks field:

  • Use a field query:
    • query by a given key value pair. Example: sccSecurityMarks.foo=bar
    • query by a given key's existence. Example: sccSecurityMarks.foo:*

map<string, string> scc_security_marks = 32;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAdditionalAttributes()

public Struct getAdditionalAttributes()

The additional searchable attributes of this resource. The attributes may vary from one resource type to another. Examples: projectId for Project, dnsName for DNS ManagedZone. This field contains a subset of the resource metadata fields that are returned by the List or Get APIs provided by the corresponding Google Cloud service (e.g., Compute Engine). see API references and supported searchable attributes to see which fields are included.

You can search values of these fields through free text search. However, you should not consume the field programically as the field names and values may change as the Google Cloud service updates to a new incompatible API version.

To search against the additional_attributes:

  • Use a free text query to match the attributes values. Example: to search additional_attributes = { dnsName: "foobar" }, you can issue a query foobar.

.google.protobuf.Struct additional_attributes = 9;

Returns
Type Description
Struct

The additionalAttributes.

getAdditionalAttributesOrBuilder()

public StructOrBuilder getAdditionalAttributesOrBuilder()

The additional searchable attributes of this resource. The attributes may vary from one resource type to another. Examples: projectId for Project, dnsName for DNS ManagedZone. This field contains a subset of the resource metadata fields that are returned by the List or Get APIs provided by the corresponding Google Cloud service (e.g., Compute Engine). see API references and supported searchable attributes to see which fields are included.

You can search values of these fields through free text search. However, you should not consume the field programically as the field names and values may change as the Google Cloud service updates to a new incompatible API version.

To search against the additional_attributes:

  • Use a free text query to match the attributes values. Example: to search additional_attributes = { dnsName: "foobar" }, you can issue a query foobar.

.google.protobuf.Struct additional_attributes = 9;

Returns
Type Description
StructOrBuilder

getAssetType()

public String getAssetType()

The type of this resource. Example: compute.googleapis.com/Disk.

To search against the asset_type:

  • Specify the asset_type field in your search request.

string asset_type = 2;

Returns
Type Description
String

The assetType.

getAssetTypeBytes()

public ByteString getAssetTypeBytes()

The type of this resource. Example: compute.googleapis.com/Disk.

To search against the asset_type:

  • Specify the asset_type field in your search request.

string asset_type = 2;

Returns
Type Description
ByteString

The bytes for assetType.

getAttachedResources(int index)

public AttachedResource getAttachedResources(int index)

Attached resources of this resource. For example, an OSConfig Inventory is an attached resource of a Compute Instance. This field is repeated because a resource could have multiple attached resources.

This attached_resources field is not searchable. Some attributes of the attached resources are exposed in additional_attributes field, so as to allow users to search on them.

repeated .google.cloud.asset.v1.AttachedResource attached_resources = 20;

Parameter
Name Description
index int
Returns
Type Description
AttachedResource

getAttachedResourcesCount()

public int getAttachedResourcesCount()

Attached resources of this resource. For example, an OSConfig Inventory is an attached resource of a Compute Instance. This field is repeated because a resource could have multiple attached resources.

This attached_resources field is not searchable. Some attributes of the attached resources are exposed in additional_attributes field, so as to allow users to search on them.

repeated .google.cloud.asset.v1.AttachedResource attached_resources = 20;

Returns
Type Description
int

getAttachedResourcesList()

public List<AttachedResource> getAttachedResourcesList()

Attached resources of this resource. For example, an OSConfig Inventory is an attached resource of a Compute Instance. This field is repeated because a resource could have multiple attached resources.

This attached_resources field is not searchable. Some attributes of the attached resources are exposed in additional_attributes field, so as to allow users to search on them.

repeated .google.cloud.asset.v1.AttachedResource attached_resources = 20;

Returns
Type Description
List<AttachedResource>

getAttachedResourcesOrBuilder(int index)

public AttachedResourceOrBuilder getAttachedResourcesOrBuilder(int index)

Attached resources of this resource. For example, an OSConfig Inventory is an attached resource of a Compute Instance. This field is repeated because a resource could have multiple attached resources.

This attached_resources field is not searchable. Some attributes of the attached resources are exposed in additional_attributes field, so as to allow users to search on them.

repeated .google.cloud.asset.v1.AttachedResource attached_resources = 20;

Parameter
Name Description
index int
Returns
Type Description
AttachedResourceOrBuilder

getAttachedResourcesOrBuilderList()

public List<? extends AttachedResourceOrBuilder> getAttachedResourcesOrBuilderList()

Attached resources of this resource. For example, an OSConfig Inventory is an attached resource of a Compute Instance. This field is repeated because a resource could have multiple attached resources.

This attached_resources field is not searchable. Some attributes of the attached resources are exposed in additional_attributes field, so as to allow users to search on them.

repeated .google.cloud.asset.v1.AttachedResource attached_resources = 20;

Returns
Type Description
List<? extends com.google.cloud.asset.v1.AttachedResourceOrBuilder>

getCreateTime()

public Timestamp getCreateTime()

The create timestamp of this resource, at which the resource was created. The granularity is in seconds. Timestamp.nanos will always be 0. This field is available only when the resource's Protobuf contains it.

To search against create_time:

  • Use a field query.
    • value in seconds since unix epoch. Example: createTime > 1609459200
    • value in date string. Example: createTime > 2021-01-01
    • value in date-time string (must be quoted). Example: createTime > "2021-01-01T00:00:00"

.google.protobuf.Timestamp create_time = 11;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

The create timestamp of this resource, at which the resource was created. The granularity is in seconds. Timestamp.nanos will always be 0. This field is available only when the resource's Protobuf contains it.

To search against create_time:

  • Use a field query.
    • value in seconds since unix epoch. Example: createTime > 1609459200
    • value in date string. Example: createTime > 2021-01-01
    • value in date-time string (must be quoted). Example: createTime > "2021-01-01T00:00:00"

.google.protobuf.Timestamp create_time = 11;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public ResourceSearchResult getDefaultInstanceForType()
Returns
Type Description
ResourceSearchResult

getDescription()

public String getDescription()

One or more paragraphs of text description of this resource. Maximum length could be up to 1M bytes. This field is available only when the resource's Protobuf contains it.

To search against the description:

  • Use a field query. Example: description:"important instance"
  • Use a free text query. Example: "important instance"

string description = 5;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

One or more paragraphs of text description of this resource. Maximum length could be up to 1M bytes. This field is available only when the resource's Protobuf contains it.

To search against the description:

  • Use a field query. Example: description:"important instance"
  • Use a free text query. Example: "important instance"

string description = 5;

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

The display name of this resource. This field is available only when the resource's Protobuf contains it.

To search against the display_name:

  • Use a field query. Example: displayName:"My Instance"
  • Use a free text query. Example: "My Instance"

string display_name = 4;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The display name of this resource. This field is available only when the resource's Protobuf contains it.

To search against the display_name:

  • Use a field query. Example: displayName:"My Instance"
  • Use a free text query. Example: "My Instance"

string display_name = 4;

Returns
Type Description
ByteString

The bytes for displayName.

getEffectiveTags(int index)

public EffectiveTagDetails getEffectiveTags(int index)

The effective tags on this resource. All of the tags that are both attached to and inherited by a resource are collectively called the effective tags. For more information, see tag inheritance.

To search against the effective_tags:

  • Use a field query. Example:
    • effectiveTagKeys:"123456789/env*"
    • effectiveTagKeys="123456789/env"
    • effectiveTagKeys:"env"
    • effectiveTagValues:"env"
    • effectiveTagValues:"env/prod"
    • effectiveTagValues:"123456789/env/prod*"
    • effectiveTagValues="123456789/env/prod"
    • effectiveTagValueIds="tagValues/456"

repeated .google.cloud.asset.v1.EffectiveTagDetails effective_tags = 30;

Parameter
Name Description
index int
Returns
Type Description
EffectiveTagDetails

getEffectiveTagsCount()

public int getEffectiveTagsCount()

The effective tags on this resource. All of the tags that are both attached to and inherited by a resource are collectively called the effective tags. For more information, see tag inheritance.

To search against the effective_tags:

  • Use a field query. Example:
    • effectiveTagKeys:"123456789/env*"
    • effectiveTagKeys="123456789/env"
    • effectiveTagKeys:"env"
    • effectiveTagValues:"env"
    • effectiveTagValues:"env/prod"
    • effectiveTagValues:"123456789/env/prod*"
    • effectiveTagValues="123456789/env/prod"
    • effectiveTagValueIds="tagValues/456"

repeated .google.cloud.asset.v1.EffectiveTagDetails effective_tags = 30;

Returns
Type Description
int

getEffectiveTagsList()

public List<EffectiveTagDetails> getEffectiveTagsList()

The effective tags on this resource. All of the tags that are both attached to and inherited by a resource are collectively called the effective tags. For more information, see tag inheritance.

To search against the effective_tags:

  • Use a field query. Example:
    • effectiveTagKeys:"123456789/env*"
    • effectiveTagKeys="123456789/env"
    • effectiveTagKeys:"env"
    • effectiveTagValues:"env"
    • effectiveTagValues:"env/prod"
    • effectiveTagValues:"123456789/env/prod*"
    • effectiveTagValues="123456789/env/prod"
    • effectiveTagValueIds="tagValues/456"

repeated .google.cloud.asset.v1.EffectiveTagDetails effective_tags = 30;

Returns
Type Description
List<EffectiveTagDetails>

getEffectiveTagsOrBuilder(int index)

public EffectiveTagDetailsOrBuilder getEffectiveTagsOrBuilder(int index)

The effective tags on this resource. All of the tags that are both attached to and inherited by a resource are collectively called the effective tags. For more information, see tag inheritance.

To search against the effective_tags:

  • Use a field query. Example:
    • effectiveTagKeys:"123456789/env*"
    • effectiveTagKeys="123456789/env"
    • effectiveTagKeys:"env"
    • effectiveTagValues:"env"
    • effectiveTagValues:"env/prod"
    • effectiveTagValues:"123456789/env/prod*"
    • effectiveTagValues="123456789/env/prod"
    • effectiveTagValueIds="tagValues/456"

repeated .google.cloud.asset.v1.EffectiveTagDetails effective_tags = 30;

Parameter
Name Description
index int
Returns
Type Description
EffectiveTagDetailsOrBuilder

getEffectiveTagsOrBuilderList()

public List<? extends EffectiveTagDetailsOrBuilder> getEffectiveTagsOrBuilderList()

The effective tags on this resource. All of the tags that are both attached to and inherited by a resource are collectively called the effective tags. For more information, see tag inheritance.

To search against the effective_tags:

  • Use a field query. Example:
    • effectiveTagKeys:"123456789/env*"
    • effectiveTagKeys="123456789/env"
    • effectiveTagKeys:"env"
    • effectiveTagValues:"env"
    • effectiveTagValues:"env/prod"
    • effectiveTagValues:"123456789/env/prod*"
    • effectiveTagValues="123456789/env/prod"
    • effectiveTagValueIds="tagValues/456"

repeated .google.cloud.asset.v1.EffectiveTagDetails effective_tags = 30;

Returns
Type Description
List<? extends com.google.cloud.asset.v1.EffectiveTagDetailsOrBuilder>

getFolders(int index)

public String getFolders(int index)

The folder(s) that this resource belongs to, in the form of folders/{FOLDER_NUMBER}. This field is available when the resource belongs to one or more folders.

To search against folders:

  • Use a field query. Example: folders:(123 OR 456)
  • Use a free text query. Example: 123
  • Specify the scope field as this folder in your search request.

repeated string folders = 17;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The folders at the given index.

getFoldersBytes(int index)

public ByteString getFoldersBytes(int index)

The folder(s) that this resource belongs to, in the form of folders/{FOLDER_NUMBER}. This field is available when the resource belongs to one or more folders.

To search against folders:

  • Use a field query. Example: folders:(123 OR 456)
  • Use a free text query. Example: 123
  • Specify the scope field as this folder in your search request.

repeated string folders = 17;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the folders at the given index.

getFoldersCount()

public int getFoldersCount()

The folder(s) that this resource belongs to, in the form of folders/{FOLDER_NUMBER}. This field is available when the resource belongs to one or more folders.

To search against folders:

  • Use a field query. Example: folders:(123 OR 456)
  • Use a free text query. Example: 123
  • Specify the scope field as this folder in your search request.

repeated string folders = 17;

Returns
Type Description
int

The count of folders.

getFoldersList()

public ProtocolStringList getFoldersList()

The folder(s) that this resource belongs to, in the form of folders/{FOLDER_NUMBER}. This field is available when the resource belongs to one or more folders.

To search against folders:

  • Use a field query. Example: folders:(123 OR 456)
  • Use a free text query. Example: 123
  • Specify the scope field as this folder in your search request.

repeated string folders = 17;

Returns
Type Description
ProtocolStringList

A list containing the folders.

getKmsKey() (deprecated)

public String getKmsKey()

Deprecated. google.cloud.asset.v1.ResourceSearchResult.kms_key is deprecated. See google/cloud/asset/v1/assets.proto;l=471

The Cloud KMS CryptoKey name or CryptoKeyVersion name.

This field only presents for the purpose of backward compatibility. Please use the kms_keys field to retrieve Cloud KMS key information. This field is available only when the resource's Protobuf contains it and will only be populated for these resource types for backward compatible purposes.

To search against the kms_key:

  • Use a field query. Example: kmsKey:key
  • Use a free text query. Example: key

string kms_key = 10 [deprecated = true];

Returns
Type Description
String

The kmsKey.

getKmsKeyBytes() (deprecated)

public ByteString getKmsKeyBytes()

Deprecated. google.cloud.asset.v1.ResourceSearchResult.kms_key is deprecated. See google/cloud/asset/v1/assets.proto;l=471

The Cloud KMS CryptoKey name or CryptoKeyVersion name.

This field only presents for the purpose of backward compatibility. Please use the kms_keys field to retrieve Cloud KMS key information. This field is available only when the resource's Protobuf contains it and will only be populated for these resource types for backward compatible purposes.

To search against the kms_key:

  • Use a field query. Example: kmsKey:key
  • Use a free text query. Example: key

string kms_key = 10 [deprecated = true];

Returns
Type Description
ByteString

The bytes for kmsKey.

getKmsKeys(int index)

public String getKmsKeys(int index)

The Cloud KMS CryptoKey names or CryptoKeyVersion names. This field is available only when the resource's Protobuf contains it.

To search against the kms_keys:

  • Use a field query. Example: kmsKeys:key
  • Use a free text query. Example: key

repeated string kms_keys = 28;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The kmsKeys at the given index.

getKmsKeysBytes(int index)

public ByteString getKmsKeysBytes(int index)

The Cloud KMS CryptoKey names or CryptoKeyVersion names. This field is available only when the resource's Protobuf contains it.

To search against the kms_keys:

  • Use a field query. Example: kmsKeys:key
  • Use a free text query. Example: key

repeated string kms_keys = 28;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the kmsKeys at the given index.

getKmsKeysCount()

public int getKmsKeysCount()

The Cloud KMS CryptoKey names or CryptoKeyVersion names. This field is available only when the resource's Protobuf contains it.

To search against the kms_keys:

  • Use a field query. Example: kmsKeys:key
  • Use a free text query. Example: key

repeated string kms_keys = 28;

Returns
Type Description
int

The count of kmsKeys.

getKmsKeysList()

public ProtocolStringList getKmsKeysList()

The Cloud KMS CryptoKey names or CryptoKeyVersion names. This field is available only when the resource's Protobuf contains it.

To search against the kms_keys:

  • Use a field query. Example: kmsKeys:key
  • Use a free text query. Example: key

repeated string kms_keys = 28;

Returns
Type Description
ProtocolStringList

A list containing the kmsKeys.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels associated with this resource. See Labelling and grouping Google Cloud resources for more information. This field is available only when the resource's Protobuf contains it.

To search against the labels:

  • Use a field query:
    • query on any label's key or value. Example: labels:prod
    • query by a given label. Example: labels.env:prod
    • query by a given label's existence. Example: labels.env:*
  • Use a free text query. Example: prod

map<string, string> labels = 7;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels associated with this resource. See Labelling and grouping Google Cloud resources for more information. This field is available only when the resource's Protobuf contains it.

To search against the labels:

  • Use a field query:
    • query on any label's key or value. Example: labels:prod
    • query by a given label. Example: labels.env:prod
    • query by a given label's existence. Example: labels.env:*
  • Use a free text query. Example: prod

map<string, string> labels = 7;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Labels associated with this resource. See Labelling and grouping Google Cloud resources for more information. This field is available only when the resource's Protobuf contains it.

To search against the labels:

  • Use a field query:
    • query on any label's key or value. Example: labels:prod
    • query by a given label. Example: labels.env:prod
    • query by a given label's existence. Example: labels.env:*
  • Use a free text query. Example: prod

map<string, string> labels = 7;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels associated with this resource. See Labelling and grouping Google Cloud resources for more information. This field is available only when the resource's Protobuf contains it.

To search against the labels:

  • Use a field query:
    • query on any label's key or value. Example: labels:prod
    • query by a given label. Example: labels.env:prod
    • query by a given label's existence. Example: labels.env:*
  • Use a free text query. Example: prod

map<string, string> labels = 7;

Parameter
Name Description
key String
Returns
Type Description
String

getLocation()

public String getLocation()

Location can be global, regional like us-east1, or zonal like us-west1-b. This field is available only when the resource's Protobuf contains it.

To search against the location:

  • Use a field query. Example: location:us-west*
  • Use a free text query. Example: us-west*

string location = 6;

Returns
Type Description
String

The location.

getLocationBytes()

public ByteString getLocationBytes()

Location can be global, regional like us-east1, or zonal like us-west1-b. This field is available only when the resource's Protobuf contains it.

To search against the location:

  • Use a field query. Example: location:us-west*
  • Use a free text query. Example: us-west*

string location = 6;

Returns
Type Description
ByteString

The bytes for location.

getName()

public String getName()

The full resource name of this resource. Example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1. See Cloud Asset Inventory Resource Name Format for more information.

To search against the name:

  • Use a field query. Example: name:instance1
  • Use a free text query. Example: instance1

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The full resource name of this resource. Example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1. See Cloud Asset Inventory Resource Name Format for more information.

To search against the name:

  • Use a field query. Example: name:instance1
  • Use a free text query. Example: instance1

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getNetworkTags(int index)

public String getNetworkTags(int index)

Network tags associated with this resource. Like labels, network tags are a type of annotations used to group Google Cloud resources. See Labelling Google Cloud resources for more information. This field is available only when the resource's Protobuf contains it.

To search against the network_tags:

  • Use a field query. Example: networkTags:internal
  • Use a free text query. Example: internal

repeated string network_tags = 8;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The networkTags at the given index.

getNetworkTagsBytes(int index)

public ByteString getNetworkTagsBytes(int index)

Network tags associated with this resource. Like labels, network tags are a type of annotations used to group Google Cloud resources. See Labelling Google Cloud resources for more information. This field is available only when the resource's Protobuf contains it.

To search against the network_tags:

  • Use a field query. Example: networkTags:internal
  • Use a free text query. Example: internal

repeated string network_tags = 8;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the networkTags at the given index.

getNetworkTagsCount()

public int getNetworkTagsCount()

Network tags associated with this resource. Like labels, network tags are a type of annotations used to group Google Cloud resources. See Labelling Google Cloud resources for more information. This field is available only when the resource's Protobuf contains it.

To search against the network_tags:

  • Use a field query. Example: networkTags:internal
  • Use a free text query. Example: internal

repeated string network_tags = 8;

Returns
Type Description
int

The count of networkTags.

getNetworkTagsList()

public ProtocolStringList getNetworkTagsList()

Network tags associated with this resource. Like labels, network tags are a type of annotations used to group Google Cloud resources. See Labelling Google Cloud resources for more information. This field is available only when the resource's Protobuf contains it.

To search against the network_tags:

  • Use a field query. Example: networkTags:internal
  • Use a free text query. Example: internal

repeated string network_tags = 8;

Returns
Type Description
ProtocolStringList

A list containing the networkTags.

getOrganization()

public String getOrganization()

The organization that this resource belongs to, in the form of organizations/{ORGANIZATION_NUMBER}. This field is available when the resource belongs to an organization.

To search against organization:

  • Use a field query. Example: organization:123
  • Use a free text query. Example: 123
  • Specify the scope field as this organization in your search request.

string organization = 18;

Returns
Type Description
String

The organization.

getOrganizationBytes()

public ByteString getOrganizationBytes()

The organization that this resource belongs to, in the form of organizations/{ORGANIZATION_NUMBER}. This field is available when the resource belongs to an organization.

To search against organization:

  • Use a field query. Example: organization:123
  • Use a free text query. Example: 123
  • Specify the scope field as this organization in your search request.

string organization = 18;

Returns
Type Description
ByteString

The bytes for organization.

getParentAssetType()

public String getParentAssetType()

The type of this resource's immediate parent, if there is one.

To search against the parent_asset_type:

  • Use a field query. Example: parentAssetType:"cloudresourcemanager.googleapis.com/Project"
  • Use a free text query. Example: cloudresourcemanager.googleapis.com/Project

string parent_asset_type = 103;

Returns
Type Description
String

The parentAssetType.

getParentAssetTypeBytes()

public ByteString getParentAssetTypeBytes()

The type of this resource's immediate parent, if there is one.

To search against the parent_asset_type:

  • Use a field query. Example: parentAssetType:"cloudresourcemanager.googleapis.com/Project"
  • Use a free text query. Example: cloudresourcemanager.googleapis.com/Project

string parent_asset_type = 103;

Returns
Type Description
ByteString

The bytes for parentAssetType.

getParentFullResourceName()

public String getParentFullResourceName()

The full resource name of this resource's parent, if it has one. To search against the parent_full_resource_name:

  • Use a field query. Example: parentFullResourceName:"project-name"
  • Use a free text query. Example: project-name

string parent_full_resource_name = 19;

Returns
Type Description
String

The parentFullResourceName.

getParentFullResourceNameBytes()

public ByteString getParentFullResourceNameBytes()

The full resource name of this resource's parent, if it has one. To search against the parent_full_resource_name:

  • Use a field query. Example: parentFullResourceName:"project-name"
  • Use a free text query. Example: project-name

string parent_full_resource_name = 19;

Returns
Type Description
ByteString

The bytes for parentFullResourceName.

getParserForType()

public Parser<ResourceSearchResult> getParserForType()
Returns
Type Description
Parser<ResourceSearchResult>
Overrides

getProject()

public String getProject()

The project that this resource belongs to, in the form of projects/{PROJECT_NUMBER}. This field is available when the resource belongs to a project.

To search against project:

  • Use a field query. Example: project:12345
  • Use a free text query. Example: 12345
  • Specify the scope field as this project in your search request.

string project = 3;

Returns
Type Description
String

The project.

getProjectBytes()

public ByteString getProjectBytes()

The project that this resource belongs to, in the form of projects/{PROJECT_NUMBER}. This field is available when the resource belongs to a project.

To search against project:

  • Use a field query. Example: project:12345
  • Use a free text query. Example: 12345
  • Specify the scope field as this project in your search request.

string project = 3;

Returns
Type Description
ByteString

The bytes for project.

getRelationships()

public Map<String,RelatedResources> getRelationships()

Use #getRelationshipsMap() instead.

Returns
Type Description
Map<String,RelatedResources>

getRelationshipsCount()

public int getRelationshipsCount()

A map of related resources of this resource, keyed by the relationship type. A relationship type is in the format of {SourceType}{ACTION}{DestType}. Example: DISK_TO_INSTANCE, DISK_TO_NETWORK, INSTANCE_TO_INSTANCEGROUP. See supported relationship types.

map<string, .google.cloud.asset.v1.RelatedResources> relationships = 21;

Returns
Type Description
int

getRelationshipsMap()

public Map<String,RelatedResources> getRelationshipsMap()

A map of related resources of this resource, keyed by the relationship type. A relationship type is in the format of {SourceType}{ACTION}{DestType}. Example: DISK_TO_INSTANCE, DISK_TO_NETWORK, INSTANCE_TO_INSTANCEGROUP. See supported relationship types.

map<string, .google.cloud.asset.v1.RelatedResources> relationships = 21;

Returns
Type Description
Map<String,RelatedResources>

getRelationshipsOrDefault(String key, RelatedResources defaultValue)

public RelatedResources getRelationshipsOrDefault(String key, RelatedResources defaultValue)

A map of related resources of this resource, keyed by the relationship type. A relationship type is in the format of {SourceType}{ACTION}{DestType}. Example: DISK_TO_INSTANCE, DISK_TO_NETWORK, INSTANCE_TO_INSTANCEGROUP. See supported relationship types.

map<string, .google.cloud.asset.v1.RelatedResources> relationships = 21;

Parameters
Name Description
key String
defaultValue RelatedResources
Returns
Type Description
RelatedResources

getRelationshipsOrThrow(String key)

public RelatedResources getRelationshipsOrThrow(String key)

A map of related resources of this resource, keyed by the relationship type. A relationship type is in the format of {SourceType}{ACTION}{DestType}. Example: DISK_TO_INSTANCE, DISK_TO_NETWORK, INSTANCE_TO_INSTANCEGROUP. See supported relationship types.

map<string, .google.cloud.asset.v1.RelatedResources> relationships = 21;

Parameter
Name Description
key String
Returns
Type Description
RelatedResources

getSccSecurityMarks()

public Map<String,String> getSccSecurityMarks()

Use #getSccSecurityMarksMap() instead.

Returns
Type Description
Map<String,String>

getSccSecurityMarksCount()

public int getSccSecurityMarksCount()

The actual content of Security Command Center security marks associated with the asset.

Note that both staging & prod SecurityMarks are attached on prod resources. In CAS preprod/prod, both staging & prod SecurityMarks are ingested and returned in the following security_marks map. In that case, the prefix "staging." will be added to the keys of all the staging marks. To search against SCC SecurityMarks field:

  • Use a field query:
    • query by a given key value pair. Example: sccSecurityMarks.foo=bar
    • query by a given key's existence. Example: sccSecurityMarks.foo:*

map<string, string> scc_security_marks = 32;

Returns
Type Description
int

getSccSecurityMarksMap()

public Map<String,String> getSccSecurityMarksMap()

The actual content of Security Command Center security marks associated with the asset.

Note that both staging & prod SecurityMarks are attached on prod resources. In CAS preprod/prod, both staging & prod SecurityMarks are ingested and returned in the following security_marks map. In that case, the prefix "staging." will be added to the keys of all the staging marks. To search against SCC SecurityMarks field:

  • Use a field query:
    • query by a given key value pair. Example: sccSecurityMarks.foo=bar
    • query by a given key's existence. Example: sccSecurityMarks.foo:*

map<string, string> scc_security_marks = 32;

Returns
Type Description
Map<String,String>

getSccSecurityMarksOrDefault(String key, String defaultValue)

public String getSccSecurityMarksOrDefault(String key, String defaultValue)

The actual content of Security Command Center security marks associated with the asset.

Note that both staging & prod SecurityMarks are attached on prod resources. In CAS preprod/prod, both staging & prod SecurityMarks are ingested and returned in the following security_marks map. In that case, the prefix "staging." will be added to the keys of all the staging marks. To search against SCC SecurityMarks field:

  • Use a field query:
    • query by a given key value pair. Example: sccSecurityMarks.foo=bar
    • query by a given key's existence. Example: sccSecurityMarks.foo:*

map<string, string> scc_security_marks = 32;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getSccSecurityMarksOrThrow(String key)

public String getSccSecurityMarksOrThrow(String key)

The actual content of Security Command Center security marks associated with the asset.

Note that both staging & prod SecurityMarks are attached on prod resources. In CAS preprod/prod, both staging & prod SecurityMarks are ingested and returned in the following security_marks map. In that case, the prefix "staging." will be added to the keys of all the staging marks. To search against SCC SecurityMarks field:

  • Use a field query:
    • query by a given key value pair. Example: sccSecurityMarks.foo=bar
    • query by a given key's existence. Example: sccSecurityMarks.foo:*

map<string, string> scc_security_marks = 32;

Parameter
Name Description
key String
Returns
Type Description
String

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public String getState()

The state of this resource. Different resources types have different state definitions that are mapped from various fields of different resource types. This field is available only when the resource's Protobuf contains it.

Example: If the resource is an instance provided by Compute Engine, its state will include PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. See status definition in API Reference. If the resource is a project provided by Resource Manager, its state will include LIFECYCLE_STATE_UNSPECIFIED, ACTIVE, DELETE_REQUESTED and DELETE_IN_PROGRESS. See lifecycleState definition in API Reference.

To search against the state:

  • Use a field query. Example: state:RUNNING
  • Use a free text query. Example: RUNNING

string state = 13;

Returns
Type Description
String

The state.

getStateBytes()

public ByteString getStateBytes()

The state of this resource. Different resources types have different state definitions that are mapped from various fields of different resource types. This field is available only when the resource's Protobuf contains it.

Example: If the resource is an instance provided by Compute Engine, its state will include PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. See status definition in API Reference. If the resource is a project provided by Resource Manager, its state will include LIFECYCLE_STATE_UNSPECIFIED, ACTIVE, DELETE_REQUESTED and DELETE_IN_PROGRESS. See lifecycleState definition in API Reference.

To search against the state:

  • Use a field query. Example: state:RUNNING
  • Use a free text query. Example: RUNNING

string state = 13;

Returns
Type Description
ByteString

The bytes for state.

getTagKeys(int index) (deprecated)

public String getTagKeys(int index)

Deprecated. google.cloud.asset.v1.ResourceSearchResult.tag_keys is deprecated. See google/cloud/asset/v1/assets.proto;l=604

This field is only present for the purpose of backward compatibility. Please use the tags field instead.

TagKey namespaced names, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}. To search against the tagKeys:

  • Use a field query. Example:

    • tagKeys:"123456789/env*"
    • tagKeys="123456789/env"
    • tagKeys:"env"

  • Use a free text query. Example:

    • env

repeated string tag_keys = 23 [deprecated = true];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The tagKeys at the given index.

getTagKeysBytes(int index) (deprecated)

public ByteString getTagKeysBytes(int index)

Deprecated. google.cloud.asset.v1.ResourceSearchResult.tag_keys is deprecated. See google/cloud/asset/v1/assets.proto;l=604

This field is only present for the purpose of backward compatibility. Please use the tags field instead.

TagKey namespaced names, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}. To search against the tagKeys:

  • Use a field query. Example:

    • tagKeys:"123456789/env*"
    • tagKeys="123456789/env"
    • tagKeys:"env"

  • Use a free text query. Example:

    • env

repeated string tag_keys = 23 [deprecated = true];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the tagKeys at the given index.

getTagKeysCount() (deprecated)

public int getTagKeysCount()

Deprecated. google.cloud.asset.v1.ResourceSearchResult.tag_keys is deprecated. See google/cloud/asset/v1/assets.proto;l=604

This field is only present for the purpose of backward compatibility. Please use the tags field instead.

TagKey namespaced names, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}. To search against the tagKeys:

  • Use a field query. Example:

    • tagKeys:"123456789/env*"
    • tagKeys="123456789/env"
    • tagKeys:"env"

  • Use a free text query. Example:

    • env

repeated string tag_keys = 23 [deprecated = true];

Returns
Type Description
int

The count of tagKeys.

getTagKeysList() (deprecated)

public ProtocolStringList getTagKeysList()

Deprecated. google.cloud.asset.v1.ResourceSearchResult.tag_keys is deprecated. See google/cloud/asset/v1/assets.proto;l=604

This field is only present for the purpose of backward compatibility. Please use the tags field instead.

TagKey namespaced names, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}. To search against the tagKeys:

  • Use a field query. Example:

    • tagKeys:"123456789/env*"
    • tagKeys="123456789/env"
    • tagKeys:"env"

  • Use a free text query. Example:

    • env

repeated string tag_keys = 23 [deprecated = true];

Returns
Type Description
ProtocolStringList

A list containing the tagKeys.

getTagValueIds(int index) (deprecated)

public String getTagValueIds(int index)

Deprecated. google.cloud.asset.v1.ResourceSearchResult.tag_value_ids is deprecated. See google/cloud/asset/v1/assets.proto;l=634

This field is only present for the purpose of backward compatibility. Please use the tags field instead.

TagValue IDs, in the format of tagValues/{TAG_VALUE_ID}. To search against the tagValueIds:

  • Use a field query. Example:

    • tagValueIds="tagValues/456"

  • Use a free text query. Example:

    • 456

repeated string tag_value_ids = 26 [deprecated = true];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The tagValueIds at the given index.

getTagValueIdsBytes(int index) (deprecated)

public ByteString getTagValueIdsBytes(int index)

Deprecated. google.cloud.asset.v1.ResourceSearchResult.tag_value_ids is deprecated. See google/cloud/asset/v1/assets.proto;l=634

This field is only present for the purpose of backward compatibility. Please use the tags field instead.

TagValue IDs, in the format of tagValues/{TAG_VALUE_ID}. To search against the tagValueIds:

  • Use a field query. Example:

    • tagValueIds="tagValues/456"

  • Use a free text query. Example:

    • 456

repeated string tag_value_ids = 26 [deprecated = true];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the tagValueIds at the given index.

getTagValueIdsCount() (deprecated)

public int getTagValueIdsCount()

Deprecated. google.cloud.asset.v1.ResourceSearchResult.tag_value_ids is deprecated. See google/cloud/asset/v1/assets.proto;l=634

This field is only present for the purpose of backward compatibility. Please use the tags field instead.

TagValue IDs, in the format of tagValues/{TAG_VALUE_ID}. To search against the tagValueIds:

  • Use a field query. Example:

    • tagValueIds="tagValues/456"

  • Use a free text query. Example:

    • 456

repeated string tag_value_ids = 26 [deprecated = true];

Returns
Type Description
int

The count of tagValueIds.

getTagValueIdsList() (deprecated)

public ProtocolStringList getTagValueIdsList()

Deprecated. google.cloud.asset.v1.ResourceSearchResult.tag_value_ids is deprecated. See google/cloud/asset/v1/assets.proto;l=634

This field is only present for the purpose of backward compatibility. Please use the tags field instead.

TagValue IDs, in the format of tagValues/{TAG_VALUE_ID}. To search against the tagValueIds:

  • Use a field query. Example:

    • tagValueIds="tagValues/456"

  • Use a free text query. Example:

    • 456

repeated string tag_value_ids = 26 [deprecated = true];

Returns
Type Description
ProtocolStringList

A list containing the tagValueIds.

getTagValues(int index) (deprecated)

public String getTagValues(int index)

Deprecated. google.cloud.asset.v1.ResourceSearchResult.tag_values is deprecated. See google/cloud/asset/v1/assets.proto;l=621

This field is only present for the purpose of backward compatibility. Please use the tags field instead.

TagValue namespaced names, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}/{TAG_VALUE_SHORT_NAME}. To search against the tagValues:

  • Use a field query. Example:

    • tagValues:"env"
    • tagValues:"env/prod"
    • tagValues:"123456789/env/prod*"
    • tagValues="123456789/env/prod"

  • Use a free text query. Example:

    • prod

repeated string tag_values = 25 [deprecated = true];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The tagValues at the given index.

getTagValuesBytes(int index) (deprecated)

public ByteString getTagValuesBytes(int index)

Deprecated. google.cloud.asset.v1.ResourceSearchResult.tag_values is deprecated. See google/cloud/asset/v1/assets.proto;l=621

This field is only present for the purpose of backward compatibility. Please use the tags field instead.

TagValue namespaced names, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}/{TAG_VALUE_SHORT_NAME}. To search against the tagValues:

  • Use a field query. Example:

    • tagValues:"env"
    • tagValues:"env/prod"
    • tagValues:"123456789/env/prod*"
    • tagValues="123456789/env/prod"

  • Use a free text query. Example:

    • prod

repeated string tag_values = 25 [deprecated = true];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the tagValues at the given index.

getTagValuesCount() (deprecated)

public int getTagValuesCount()

Deprecated. google.cloud.asset.v1.ResourceSearchResult.tag_values is deprecated. See google/cloud/asset/v1/assets.proto;l=621

This field is only present for the purpose of backward compatibility. Please use the tags field instead.

TagValue namespaced names, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}/{TAG_VALUE_SHORT_NAME}. To search against the tagValues:

  • Use a field query. Example:

    • tagValues:"env"
    • tagValues:"env/prod"
    • tagValues:"123456789/env/prod*"
    • tagValues="123456789/env/prod"

  • Use a free text query. Example:

    • prod

repeated string tag_values = 25 [deprecated = true];

Returns
Type Description
int

The count of tagValues.

getTagValuesList() (deprecated)

public ProtocolStringList getTagValuesList()

Deprecated. google.cloud.asset.v1.ResourceSearchResult.tag_values is deprecated. See google/cloud/asset/v1/assets.proto;l=621

This field is only present for the purpose of backward compatibility. Please use the tags field instead.

TagValue namespaced names, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}/{TAG_VALUE_SHORT_NAME}. To search against the tagValues:

  • Use a field query. Example:

    • tagValues:"env"
    • tagValues:"env/prod"
    • tagValues:"123456789/env/prod*"
    • tagValues="123456789/env/prod"

  • Use a free text query. Example:

    • prod

repeated string tag_values = 25 [deprecated = true];

Returns
Type Description
ProtocolStringList

A list containing the tagValues.

getTags(int index)

public Tag getTags(int index)

The tags directly attached to this resource.

To search against the tags:

  • Use a field query. Example:

    • tagKeys:"123456789/env*"
    • tagKeys="123456789/env"
    • tagKeys:"env"
    • tagValues:"env"
    • tagValues:"env/prod"
    • tagValues:"123456789/env/prod*"
    • tagValues="123456789/env/prod"
    • tagValueIds="tagValues/456"

  • Use a free text query. Example:

    • env/prod

repeated .google.cloud.asset.v1.Tag tags = 29;

Parameter
Name Description
index int
Returns
Type Description
Tag

getTagsCount()

public int getTagsCount()

The tags directly attached to this resource.

To search against the tags:

  • Use a field query. Example:

    • tagKeys:"123456789/env*"
    • tagKeys="123456789/env"
    • tagKeys:"env"
    • tagValues:"env"
    • tagValues:"env/prod"
    • tagValues:"123456789/env/prod*"
    • tagValues="123456789/env/prod"
    • tagValueIds="tagValues/456"

  • Use a free text query. Example:

    • env/prod

repeated .google.cloud.asset.v1.Tag tags = 29;

Returns
Type Description
int

getTagsList()

public List<Tag> getTagsList()

The tags directly attached to this resource.

To search against the tags:

  • Use a field query. Example:

    • tagKeys:"123456789/env*"
    • tagKeys="123456789/env"
    • tagKeys:"env"
    • tagValues:"env"
    • tagValues:"env/prod"
    • tagValues:"123456789/env/prod*"
    • tagValues="123456789/env/prod"
    • tagValueIds="tagValues/456"

  • Use a free text query. Example:

    • env/prod

repeated .google.cloud.asset.v1.Tag tags = 29;

Returns
Type Description
List<Tag>

getTagsOrBuilder(int index)

public TagOrBuilder getTagsOrBuilder(int index)

The tags directly attached to this resource.

To search against the tags:

  • Use a field query. Example:

    • tagKeys:"123456789/env*"
    • tagKeys="123456789/env"
    • tagKeys:"env"
    • tagValues:"env"
    • tagValues:"env/prod"
    • tagValues:"123456789/env/prod*"
    • tagValues="123456789/env/prod"
    • tagValueIds="tagValues/456"

  • Use a free text query. Example:

    • env/prod

repeated .google.cloud.asset.v1.Tag tags = 29;

Parameter
Name Description
index int
Returns
Type Description
TagOrBuilder

getTagsOrBuilderList()

public List<? extends TagOrBuilder> getTagsOrBuilderList()

The tags directly attached to this resource.

To search against the tags:

  • Use a field query. Example:

    • tagKeys:"123456789/env*"
    • tagKeys="123456789/env"
    • tagKeys:"env"
    • tagValues:"env"
    • tagValues:"env/prod"
    • tagValues:"123456789/env/prod*"
    • tagValues="123456789/env/prod"
    • tagValueIds="tagValues/456"

  • Use a free text query. Example:

    • env/prod

repeated .google.cloud.asset.v1.Tag tags = 29;

Returns
Type Description
List<? extends com.google.cloud.asset.v1.TagOrBuilder>

getUpdateTime()

public Timestamp getUpdateTime()

The last update timestamp of this resource, at which the resource was last modified or deleted. The granularity is in seconds. Timestamp.nanos will always be 0. This field is available only when the resource's Protobuf contains it.

To search against update_time:

  • Use a field query.
    • value in seconds since unix epoch. Example: updateTime < 1609459200
    • value in date string. Example: updateTime < 2021-01-01
    • value in date-time string (must be quoted). Example: updateTime < "2021-01-01T00:00:00"

.google.protobuf.Timestamp update_time = 12;

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

The last update timestamp of this resource, at which the resource was last modified or deleted. The granularity is in seconds. Timestamp.nanos will always be 0. This field is available only when the resource's Protobuf contains it.

To search against update_time:

  • Use a field query.
    • value in seconds since unix epoch. Example: updateTime < 1609459200
    • value in date string. Example: updateTime < 2021-01-01
    • value in date-time string (must be quoted). Example: updateTime < "2021-01-01T00:00:00"

.google.protobuf.Timestamp update_time = 12;

Returns
Type Description
TimestampOrBuilder

getVersionedResources(int index)

public VersionedResource getVersionedResources(int index)

Versioned resource representations of this resource. This is repeated because there could be multiple versions of resource representations during version migration.

This versioned_resources field is not searchable. Some attributes of the resource representations are exposed in additional_attributes field, so as to allow users to search on them.

repeated .google.cloud.asset.v1.VersionedResource versioned_resources = 16;

Parameter
Name Description
index int
Returns
Type Description
VersionedResource

getVersionedResourcesCount()

public int getVersionedResourcesCount()

Versioned resource representations of this resource. This is repeated because there could be multiple versions of resource representations during version migration.

This versioned_resources field is not searchable. Some attributes of the resource representations are exposed in additional_attributes field, so as to allow users to search on them.

repeated .google.cloud.asset.v1.VersionedResource versioned_resources = 16;

Returns
Type Description
int

getVersionedResourcesList()

public List<VersionedResource> getVersionedResourcesList()

Versioned resource representations of this resource. This is repeated because there could be multiple versions of resource representations during version migration.

This versioned_resources field is not searchable. Some attributes of the resource representations are exposed in additional_attributes field, so as to allow users to search on them.

repeated .google.cloud.asset.v1.VersionedResource versioned_resources = 16;

Returns
Type Description
List<VersionedResource>

getVersionedResourcesOrBuilder(int index)

public VersionedResourceOrBuilder getVersionedResourcesOrBuilder(int index)

Versioned resource representations of this resource. This is repeated because there could be multiple versions of resource representations during version migration.

This versioned_resources field is not searchable. Some attributes of the resource representations are exposed in additional_attributes field, so as to allow users to search on them.

repeated .google.cloud.asset.v1.VersionedResource versioned_resources = 16;

Parameter
Name Description
index int
Returns
Type Description
VersionedResourceOrBuilder

getVersionedResourcesOrBuilderList()

public List<? extends VersionedResourceOrBuilder> getVersionedResourcesOrBuilderList()

Versioned resource representations of this resource. This is repeated because there could be multiple versions of resource representations during version migration.

This versioned_resources field is not searchable. Some attributes of the resource representations are exposed in additional_attributes field, so as to allow users to search on them.

repeated .google.cloud.asset.v1.VersionedResource versioned_resources = 16;

Returns
Type Description
List<? extends com.google.cloud.asset.v1.VersionedResourceOrBuilder>

hasAdditionalAttributes()

public boolean hasAdditionalAttributes()

The additional searchable attributes of this resource. The attributes may vary from one resource type to another. Examples: projectId for Project, dnsName for DNS ManagedZone. This field contains a subset of the resource metadata fields that are returned by the List or Get APIs provided by the corresponding Google Cloud service (e.g., Compute Engine). see API references and supported searchable attributes to see which fields are included.

You can search values of these fields through free text search. However, you should not consume the field programically as the field names and values may change as the Google Cloud service updates to a new incompatible API version.

To search against the additional_attributes:

  • Use a free text query to match the attributes values. Example: to search additional_attributes = { dnsName: "foobar" }, you can issue a query foobar.

.google.protobuf.Struct additional_attributes = 9;

Returns
Type Description
boolean

Whether the additionalAttributes field is set.

hasCreateTime()

public boolean hasCreateTime()

The create timestamp of this resource, at which the resource was created. The granularity is in seconds. Timestamp.nanos will always be 0. This field is available only when the resource's Protobuf contains it.

To search against create_time:

  • Use a field query.
    • value in seconds since unix epoch. Example: createTime > 1609459200
    • value in date string. Example: createTime > 2021-01-01
    • value in date-time string (must be quoted). Example: createTime > "2021-01-01T00:00:00"

.google.protobuf.Timestamp create_time = 11;

Returns
Type Description
boolean

Whether the createTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

The last update timestamp of this resource, at which the resource was last modified or deleted. The granularity is in seconds. Timestamp.nanos will always be 0. This field is available only when the resource's Protobuf contains it.

To search against update_time:

  • Use a field query.
    • value in seconds since unix epoch. Example: updateTime < 1609459200
    • value in date string. Example: updateTime < 2021-01-01
    • value in date-time string (must be quoted). Example: updateTime < "2021-01-01T00:00:00"

.google.protobuf.Timestamp update_time = 12;

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ResourceSearchResult.Builder newBuilderForType()
Returns
Type Description
ResourceSearchResult.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ResourceSearchResult.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ResourceSearchResult.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ResourceSearchResult.Builder toBuilder()
Returns
Type Description
ResourceSearchResult.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException