Interface ResourceSearchResultOrBuilder (3.4.1)

public interface ResourceSearchResultOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Labels associated with this resource. See Labelling and grouping GCP 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
NameDescription
keyString
Returns
TypeDescription
boolean

containsRelationships(String key)

public abstract 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
NameDescription
keyString
Returns
TypeDescription
boolean

getAdditionalAttributes()

public abstract 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 GCP 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 GCP 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
TypeDescription
Struct

The additionalAttributes.

getAdditionalAttributesOrBuilder()

public abstract 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 GCP 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 GCP 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
TypeDescription
StructOrBuilder

getAssetType()

public abstract 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
TypeDescription
String

The assetType.

getAssetTypeBytes()

public abstract 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
TypeDescription
ByteString

The bytes for assetType.

getAttachedResources(int index)

public abstract 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
NameDescription
indexint
Returns
TypeDescription
AttachedResource

getAttachedResourcesCount()

public abstract 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
TypeDescription
int

getAttachedResourcesList()

public abstract 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
TypeDescription
List<AttachedResource>

getAttachedResourcesOrBuilder(int index)

public abstract 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
NameDescription
indexint
Returns
TypeDescription
AttachedResourceOrBuilder

getAttachedResourcesOrBuilderList()

public abstract 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
TypeDescription
List<? extends com.google.cloud.asset.v1.AttachedResourceOrBuilder>

getCreateTime()

public abstract 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
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract 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
TypeDescription
TimestampOrBuilder

getDescription()

public abstract 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
TypeDescription
String

The description.

getDescriptionBytes()

public abstract 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
TypeDescription
ByteString

The bytes for description.

getDisplayName()

public abstract 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
TypeDescription
String

The displayName.

getDisplayNameBytes()

public abstract 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
TypeDescription
ByteString

The bytes for displayName.

getFolders(int index)

public abstract 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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The folders at the given index.

getFoldersBytes(int index)

public abstract 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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the folders at the given index.

getFoldersCount()

public abstract 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
TypeDescription
int

The count of folders.

getFoldersList()

public abstract List<String> 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
TypeDescription
List<String>

A list containing the folders.

getKmsKey()

public abstract String getKmsKey()

The Cloud KMS CryptoKey name or CryptoKeyVersion name. This field is available only when the resource's Protobuf contains it. To search against the kms_key:

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

string kms_key = 10;

Returns
TypeDescription
String

The kmsKey.

getKmsKeyBytes()

public abstract ByteString getKmsKeyBytes()

The Cloud KMS CryptoKey name or CryptoKeyVersion name. This field is available only when the resource's Protobuf contains it. To search against the kms_key:

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

string kms_key = 10;

Returns
TypeDescription
ByteString

The bytes for kmsKey.

getLabels()

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Labels associated with this resource. See Labelling and grouping GCP 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
TypeDescription
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Labels associated with this resource. See Labelling and grouping GCP 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
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Labels associated with this resource. See Labelling and grouping GCP 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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Labels associated with this resource. See Labelling and grouping GCP 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
NameDescription
keyString
Returns
TypeDescription
String

getLocation()

public abstract 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
TypeDescription
String

The location.

getLocationBytes()

public abstract 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
TypeDescription
ByteString

The bytes for location.

getName()

public abstract 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
TypeDescription
String

The name.

getNameBytes()

public abstract 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
TypeDescription
ByteString

The bytes for name.

getNetworkTags(int index)

public abstract String getNetworkTags(int index)

Network tags associated with this resource. Like labels, network tags are a type of annotations used to group GCP resources. See Labelling GCP 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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The networkTags at the given index.

getNetworkTagsBytes(int index)

public abstract ByteString getNetworkTagsBytes(int index)

Network tags associated with this resource. Like labels, network tags are a type of annotations used to group GCP resources. See Labelling GCP 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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the networkTags at the given index.

getNetworkTagsCount()

public abstract int getNetworkTagsCount()

Network tags associated with this resource. Like labels, network tags are a type of annotations used to group GCP resources. See Labelling GCP 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
TypeDescription
int

The count of networkTags.

getNetworkTagsList()

public abstract List<String> getNetworkTagsList()

Network tags associated with this resource. Like labels, network tags are a type of annotations used to group GCP resources. See Labelling GCP 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
TypeDescription
List<String>

A list containing the networkTags.

getOrganization()

public abstract 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
TypeDescription
String

The organization.

getOrganizationBytes()

public abstract 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
TypeDescription
ByteString

The bytes for organization.

getParentAssetType()

public abstract 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
TypeDescription
String

The parentAssetType.

getParentAssetTypeBytes()

public abstract 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
TypeDescription
ByteString

The bytes for parentAssetType.

getParentFullResourceName()

public abstract 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
TypeDescription
String

The parentFullResourceName.

getParentFullResourceNameBytes()

public abstract 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
TypeDescription
ByteString

The bytes for parentFullResourceName.

getProject()

public abstract 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
TypeDescription
String

The project.

getProjectBytes()

public abstract 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
TypeDescription
ByteString

The bytes for project.

getRelationships()

public abstract Map<String,RelatedResources> getRelationships()
Returns
TypeDescription
Map<String,RelatedResources>

getRelationshipsCount()

public abstract 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
TypeDescription
int

getRelationshipsMap()

public abstract 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
TypeDescription
Map<String,RelatedResources>

getRelationshipsOrDefault(String key, RelatedResources defaultValue)

public abstract 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
NameDescription
keyString
defaultValueRelatedResources
Returns
TypeDescription
RelatedResources

getRelationshipsOrThrow(String key)

public abstract 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
NameDescription
keyString
Returns
TypeDescription
RelatedResources

getState()

public abstract 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 Cloud 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
TypeDescription
String

The state.

getStateBytes()

public abstract 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 Cloud 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
TypeDescription
ByteString

The bytes for state.

getTagKeys(int index)

public abstract String getTagKeys(int index)

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;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The tagKeys at the given index.

getTagKeysBytes(int index)

public abstract ByteString getTagKeysBytes(int index)

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;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the tagKeys at the given index.

getTagKeysCount()

public abstract int getTagKeysCount()

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;

Returns
TypeDescription
int

The count of tagKeys.

getTagKeysList()

public abstract List<String> getTagKeysList()

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;

Returns
TypeDescription
List<String>

A list containing the tagKeys.

getTagValueIds(int index)

public abstract String getTagValueIds(int index)

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

  • use a field query. Example:
    • tagValueIds:"456"
    • tagValueIds="tagValues/456"
  • use a free text query. Example:
    • 456

repeated string tag_value_ids = 26;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The tagValueIds at the given index.

getTagValueIdsBytes(int index)

public abstract ByteString getTagValueIdsBytes(int index)

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

  • use a field query. Example:
    • tagValueIds:"456"
    • tagValueIds="tagValues/456"
  • use a free text query. Example:
    • 456

repeated string tag_value_ids = 26;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the tagValueIds at the given index.

getTagValueIdsCount()

public abstract int getTagValueIdsCount()

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

  • use a field query. Example:
    • tagValueIds:"456"
    • tagValueIds="tagValues/456"
  • use a free text query. Example:
    • 456

repeated string tag_value_ids = 26;

Returns
TypeDescription
int

The count of tagValueIds.

getTagValueIdsList()

public abstract List<String> getTagValueIdsList()

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

  • use a field query. Example:
    • tagValueIds:"456"
    • tagValueIds="tagValues/456"
  • use a free text query. Example:
    • 456

repeated string tag_value_ids = 26;

Returns
TypeDescription
List<String>

A list containing the tagValueIds.

getTagValues(int index)

public abstract String getTagValues(int index)

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;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The tagValues at the given index.

getTagValuesBytes(int index)

public abstract ByteString getTagValuesBytes(int index)

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;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the tagValues at the given index.

getTagValuesCount()

public abstract int getTagValuesCount()

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;

Returns
TypeDescription
int

The count of tagValues.

getTagValuesList()

public abstract List<String> getTagValuesList()

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;

Returns
TypeDescription
List<String>

A list containing the tagValues.

getUpdateTime()

public abstract 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
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract 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
TypeDescription
TimestampOrBuilder

getVersionedResources(int index)

public abstract 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
NameDescription
indexint
Returns
TypeDescription
VersionedResource

getVersionedResourcesCount()

public abstract 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
TypeDescription
int

getVersionedResourcesList()

public abstract 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
TypeDescription
List<VersionedResource>

getVersionedResourcesOrBuilder(int index)

public abstract 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
NameDescription
indexint
Returns
TypeDescription
VersionedResourceOrBuilder

getVersionedResourcesOrBuilderList()

public abstract 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
TypeDescription
List<? extends com.google.cloud.asset.v1.VersionedResourceOrBuilder>

hasAdditionalAttributes()

public abstract 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 GCP 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 GCP 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
TypeDescription
boolean

Whether the additionalAttributes field is set.

hasCreateTime()

public abstract 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
TypeDescription
boolean

Whether the createTime field is set.

hasUpdateTime()

public abstract 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
TypeDescription
boolean

Whether the updateTime field is set.