Class ResourceSearchResult.Builder (3.55.0)

public static final class ResourceSearchResult.Builder extends GeneratedMessageV3.Builder<ResourceSearchResult.Builder> implements ResourceSearchResultOrBuilder

A result of Resource Search, containing information of a cloud resource.

Protobuf type google.cloud.asset.v1.ResourceSearchResult

Static Methods

getDescriptor()

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

Methods

addAllAttachedResources(Iterable<? extends AttachedResource> values)

public ResourceSearchResult.Builder addAllAttachedResources(Iterable<? extends AttachedResource> values)

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
values Iterable<? extends com.google.cloud.asset.v1.AttachedResource>
Returns
Type Description
ResourceSearchResult.Builder

addAllEffectiveTags(Iterable<? extends EffectiveTagDetails> values)

public ResourceSearchResult.Builder addAllEffectiveTags(Iterable<? extends EffectiveTagDetails> values)

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"
    • effectiveTagKeyIds="tagKeys/123"
    • 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
values Iterable<? extends com.google.cloud.asset.v1.EffectiveTagDetails>
Returns
Type Description
ResourceSearchResult.Builder

addAllFolders(Iterable<String> values)

public ResourceSearchResult.Builder addAllFolders(Iterable<String> values)

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
values Iterable<String>

The folders to add.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

addAllKmsKeys(Iterable<String> values)

public ResourceSearchResult.Builder addAllKmsKeys(Iterable<String> values)

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
values Iterable<String>

The kmsKeys to add.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

addAllNetworkTags(Iterable<String> values)

public ResourceSearchResult.Builder addAllNetworkTags(Iterable<String> values)

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
values Iterable<String>

The networkTags to add.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

addAllTagKeys(Iterable<String> values) (deprecated)

public ResourceSearchResult.Builder addAllTagKeys(Iterable<String> values)

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

This field is only present for the purpose of backward compatibility. 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
values Iterable<String>

The tagKeys to add.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

addAllTagValueIds(Iterable<String> values) (deprecated)

public ResourceSearchResult.Builder addAllTagValueIds(Iterable<String> values)

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

This field is only present for the purpose of backward compatibility. 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
values Iterable<String>

The tagValueIds to add.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

addAllTagValues(Iterable<String> values) (deprecated)

public ResourceSearchResult.Builder addAllTagValues(Iterable<String> values)

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

This field is only present for the purpose of backward compatibility. 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
values Iterable<String>

The tagValues to add.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

addAllTags(Iterable<? extends Tag> values)

public ResourceSearchResult.Builder addAllTags(Iterable<? extends Tag> values)

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"
    • tagKeyIds="tagKeys/123"
    • 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
values Iterable<? extends com.google.cloud.asset.v1.Tag>
Returns
Type Description
ResourceSearchResult.Builder

addAllVersionedResources(Iterable<? extends VersionedResource> values)

public ResourceSearchResult.Builder addAllVersionedResources(Iterable<? extends VersionedResource> values)

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
values Iterable<? extends com.google.cloud.asset.v1.VersionedResource>
Returns
Type Description
ResourceSearchResult.Builder

addAttachedResources(AttachedResource value)

public ResourceSearchResult.Builder addAttachedResources(AttachedResource value)

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
value AttachedResource
Returns
Type Description
ResourceSearchResult.Builder

addAttachedResources(AttachedResource.Builder builderForValue)

public ResourceSearchResult.Builder addAttachedResources(AttachedResource.Builder builderForValue)

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
builderForValue AttachedResource.Builder
Returns
Type Description
ResourceSearchResult.Builder

addAttachedResources(int index, AttachedResource value)

public ResourceSearchResult.Builder addAttachedResources(int index, AttachedResource value)

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;

Parameters
Name Description
index int
value AttachedResource
Returns
Type Description
ResourceSearchResult.Builder

addAttachedResources(int index, AttachedResource.Builder builderForValue)

public ResourceSearchResult.Builder addAttachedResources(int index, AttachedResource.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue AttachedResource.Builder
Returns
Type Description
ResourceSearchResult.Builder

addAttachedResourcesBuilder()

public AttachedResource.Builder addAttachedResourcesBuilder()

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
AttachedResource.Builder

addAttachedResourcesBuilder(int index)

public AttachedResource.Builder addAttachedResourcesBuilder(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.Builder

addEffectiveTags(EffectiveTagDetails value)

public ResourceSearchResult.Builder addEffectiveTags(EffectiveTagDetails value)

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"
    • effectiveTagKeyIds="tagKeys/123"
    • 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
value EffectiveTagDetails
Returns
Type Description
ResourceSearchResult.Builder

addEffectiveTags(EffectiveTagDetails.Builder builderForValue)

public ResourceSearchResult.Builder addEffectiveTags(EffectiveTagDetails.Builder builderForValue)

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"
    • effectiveTagKeyIds="tagKeys/123"
    • 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
builderForValue EffectiveTagDetails.Builder
Returns
Type Description
ResourceSearchResult.Builder

addEffectiveTags(int index, EffectiveTagDetails value)

public ResourceSearchResult.Builder addEffectiveTags(int index, EffectiveTagDetails value)

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"
    • effectiveTagKeyIds="tagKeys/123"
    • 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;

Parameters
Name Description
index int
value EffectiveTagDetails
Returns
Type Description
ResourceSearchResult.Builder

addEffectiveTags(int index, EffectiveTagDetails.Builder builderForValue)

public ResourceSearchResult.Builder addEffectiveTags(int index, EffectiveTagDetails.Builder builderForValue)

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"
    • effectiveTagKeyIds="tagKeys/123"
    • 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;

Parameters
Name Description
index int
builderForValue EffectiveTagDetails.Builder
Returns
Type Description
ResourceSearchResult.Builder

addEffectiveTagsBuilder()

public EffectiveTagDetails.Builder addEffectiveTagsBuilder()

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"
    • effectiveTagKeyIds="tagKeys/123"
    • 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
EffectiveTagDetails.Builder

addEffectiveTagsBuilder(int index)

public EffectiveTagDetails.Builder addEffectiveTagsBuilder(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"
    • effectiveTagKeyIds="tagKeys/123"
    • 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.Builder

addFolders(String value)

public ResourceSearchResult.Builder addFolders(String value)

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
value String

The folders to add.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

addFoldersBytes(ByteString value)

public ResourceSearchResult.Builder addFoldersBytes(ByteString value)

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
value ByteString

The bytes of the folders to add.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

addKmsKeys(String value)

public ResourceSearchResult.Builder addKmsKeys(String value)

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
value String

The kmsKeys to add.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

addKmsKeysBytes(ByteString value)

public ResourceSearchResult.Builder addKmsKeysBytes(ByteString value)

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
value ByteString

The bytes of the kmsKeys to add.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

addNetworkTags(String value)

public ResourceSearchResult.Builder addNetworkTags(String value)

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
value String

The networkTags to add.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

addNetworkTagsBytes(ByteString value)

public ResourceSearchResult.Builder addNetworkTagsBytes(ByteString value)

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
value ByteString

The bytes of the networkTags to add.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ResourceSearchResult.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ResourceSearchResult.Builder
Overrides

addTagKeys(String value) (deprecated)

public ResourceSearchResult.Builder addTagKeys(String value)

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

This field is only present for the purpose of backward compatibility. 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
value String

The tagKeys to add.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

addTagKeysBytes(ByteString value) (deprecated)

public ResourceSearchResult.Builder addTagKeysBytes(ByteString value)

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

This field is only present for the purpose of backward compatibility. 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
value ByteString

The bytes of the tagKeys to add.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

addTagValueIds(String value) (deprecated)

public ResourceSearchResult.Builder addTagValueIds(String value)

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

This field is only present for the purpose of backward compatibility. 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
value String

The tagValueIds to add.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

addTagValueIdsBytes(ByteString value) (deprecated)

public ResourceSearchResult.Builder addTagValueIdsBytes(ByteString value)

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

This field is only present for the purpose of backward compatibility. 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
value ByteString

The bytes of the tagValueIds to add.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

addTagValues(String value) (deprecated)

public ResourceSearchResult.Builder addTagValues(String value)

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

This field is only present for the purpose of backward compatibility. 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
value String

The tagValues to add.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

addTagValuesBytes(ByteString value) (deprecated)

public ResourceSearchResult.Builder addTagValuesBytes(ByteString value)

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

This field is only present for the purpose of backward compatibility. 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
value ByteString

The bytes of the tagValues to add.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

addTags(Tag value)

public ResourceSearchResult.Builder addTags(Tag value)

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"
    • tagKeyIds="tagKeys/123"
    • 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
value Tag
Returns
Type Description
ResourceSearchResult.Builder

addTags(Tag.Builder builderForValue)

public ResourceSearchResult.Builder addTags(Tag.Builder builderForValue)

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"
    • tagKeyIds="tagKeys/123"
    • 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
builderForValue Tag.Builder
Returns
Type Description
ResourceSearchResult.Builder

addTags(int index, Tag value)

public ResourceSearchResult.Builder addTags(int index, Tag value)

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"
    • tagKeyIds="tagKeys/123"
    • 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;

Parameters
Name Description
index int
value Tag
Returns
Type Description
ResourceSearchResult.Builder

addTags(int index, Tag.Builder builderForValue)

public ResourceSearchResult.Builder addTags(int index, Tag.Builder builderForValue)

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"
    • tagKeyIds="tagKeys/123"
    • 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;

Parameters
Name Description
index int
builderForValue Tag.Builder
Returns
Type Description
ResourceSearchResult.Builder

addTagsBuilder()

public Tag.Builder addTagsBuilder()

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"
    • tagKeyIds="tagKeys/123"
    • 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
Tag.Builder

addTagsBuilder(int index)

public Tag.Builder addTagsBuilder(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"
    • tagKeyIds="tagKeys/123"
    • 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.Builder

addVersionedResources(VersionedResource value)

public ResourceSearchResult.Builder addVersionedResources(VersionedResource value)

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
value VersionedResource
Returns
Type Description
ResourceSearchResult.Builder

addVersionedResources(VersionedResource.Builder builderForValue)

public ResourceSearchResult.Builder addVersionedResources(VersionedResource.Builder builderForValue)

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
builderForValue VersionedResource.Builder
Returns
Type Description
ResourceSearchResult.Builder

addVersionedResources(int index, VersionedResource value)

public ResourceSearchResult.Builder addVersionedResources(int index, VersionedResource value)

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;

Parameters
Name Description
index int
value VersionedResource
Returns
Type Description
ResourceSearchResult.Builder

addVersionedResources(int index, VersionedResource.Builder builderForValue)

public ResourceSearchResult.Builder addVersionedResources(int index, VersionedResource.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue VersionedResource.Builder
Returns
Type Description
ResourceSearchResult.Builder

addVersionedResourcesBuilder()

public VersionedResource.Builder addVersionedResourcesBuilder()

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
VersionedResource.Builder

addVersionedResourcesBuilder(int index)

public VersionedResource.Builder addVersionedResourcesBuilder(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.Builder

build()

public ResourceSearchResult build()
Returns
Type Description
ResourceSearchResult

buildPartial()

public ResourceSearchResult buildPartial()
Returns
Type Description
ResourceSearchResult

clear()

public ResourceSearchResult.Builder clear()
Returns
Type Description
ResourceSearchResult.Builder
Overrides

clearAdditionalAttributes()

public ResourceSearchResult.Builder clearAdditionalAttributes()

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

clearAssetType()

public ResourceSearchResult.Builder clearAssetType()

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

This builder for chaining.

clearAttachedResources()

public ResourceSearchResult.Builder clearAttachedResources()

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

clearCreateTime()

public ResourceSearchResult.Builder clearCreateTime()

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

clearDescription()

public ResourceSearchResult.Builder clearDescription()

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

This builder for chaining.

clearDisplayName()

public ResourceSearchResult.Builder clearDisplayName()

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

This builder for chaining.

clearEffectiveTags()

public ResourceSearchResult.Builder clearEffectiveTags()

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"
    • effectiveTagKeyIds="tagKeys/123"
    • 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
ResourceSearchResult.Builder

clearField(Descriptors.FieldDescriptor field)

public ResourceSearchResult.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ResourceSearchResult.Builder
Overrides

clearFolders()

public ResourceSearchResult.Builder clearFolders()

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

This builder for chaining.

clearKmsKey() (deprecated)

public ResourceSearchResult.Builder clearKmsKey()

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

The Cloud KMS CryptoKey name or CryptoKeyVersion name.

This field only presents for the purpose of backward compatibility. 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
ResourceSearchResult.Builder

This builder for chaining.

clearKmsKeys()

public ResourceSearchResult.Builder clearKmsKeys()

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

This builder for chaining.

clearLabels()

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

clearLocation()

public ResourceSearchResult.Builder clearLocation()

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

This builder for chaining.

clearName()

public ResourceSearchResult.Builder clearName()

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

This builder for chaining.

clearNetworkTags()

public ResourceSearchResult.Builder clearNetworkTags()

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ResourceSearchResult.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ResourceSearchResult.Builder
Overrides

clearOrganization()

public ResourceSearchResult.Builder clearOrganization()

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

This builder for chaining.

clearParentAssetType()

public ResourceSearchResult.Builder clearParentAssetType()

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

This builder for chaining.

clearParentFullResourceName()

public ResourceSearchResult.Builder clearParentFullResourceName()

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

This builder for chaining.

clearProject()

public ResourceSearchResult.Builder clearProject()

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

This builder for chaining.

clearRelationships()

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

clearSccSecurityMarks()

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

clearState()

public ResourceSearchResult.Builder clearState()

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

This builder for chaining.

clearTagKeys() (deprecated)

public ResourceSearchResult.Builder clearTagKeys()

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

This field is only present for the purpose of backward compatibility. 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
ResourceSearchResult.Builder

This builder for chaining.

clearTagValueIds() (deprecated)

public ResourceSearchResult.Builder clearTagValueIds()

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

This field is only present for the purpose of backward compatibility. 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
ResourceSearchResult.Builder

This builder for chaining.

clearTagValues() (deprecated)

public ResourceSearchResult.Builder clearTagValues()

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

This field is only present for the purpose of backward compatibility. 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
ResourceSearchResult.Builder

This builder for chaining.

clearTags()

public ResourceSearchResult.Builder clearTags()

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"
    • tagKeyIds="tagKeys/123"
    • 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
ResourceSearchResult.Builder

clearUpdateTime()

public ResourceSearchResult.Builder clearUpdateTime()

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

clearVersionedResources()

public ResourceSearchResult.Builder clearVersionedResources()

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

clone()

public ResourceSearchResult.Builder clone()
Returns
Type Description
ResourceSearchResult.Builder
Overrides

containsLabels(String key)

public boolean containsLabels(String key)

User 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.

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

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.

getAdditionalAttributesBuilder()

public Struct.Builder getAdditionalAttributesBuilder()

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
Builder

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

getAttachedResourcesBuilder(int index)

public AttachedResource.Builder getAttachedResourcesBuilder(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.Builder

getAttachedResourcesBuilderList()

public List<AttachedResource.Builder> getAttachedResourcesBuilderList()

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<Builder>

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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

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
Builder

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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"
    • effectiveTagKeyIds="tagKeys/123"
    • 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

getEffectiveTagsBuilder(int index)

public EffectiveTagDetails.Builder getEffectiveTagsBuilder(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"
    • effectiveTagKeyIds="tagKeys/123"
    • 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.Builder

getEffectiveTagsBuilderList()

public List<EffectiveTagDetails.Builder> getEffectiveTagsBuilderList()

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"
    • effectiveTagKeyIds="tagKeys/123"
    • 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<Builder>

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"
    • effectiveTagKeyIds="tagKeys/123"
    • 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"
    • effectiveTagKeyIds="tagKeys/123"
    • 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"
    • effectiveTagKeyIds="tagKeys/123"
    • 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"
    • effectiveTagKeyIds="tagKeys/123"
    • 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=470

The Cloud KMS CryptoKey name or CryptoKeyVersion name.

This field only presents for the purpose of backward compatibility. 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=470

The Cloud KMS CryptoKey name or CryptoKeyVersion name.

This field only presents for the purpose of backward compatibility. 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() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

User 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()

User 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)

User 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)

User 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.

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getMutableRelationships() (deprecated)

public Map<String,RelatedResources> getMutableRelationships()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,RelatedResources>

getMutableSccSecurityMarks() (deprecated)

public Map<String,String> getMutableSccSecurityMarks()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

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.

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() (deprecated)

public Map<String,RelatedResources> getRelationships()
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() (deprecated)

public Map<String,String> getSccSecurityMarks()
Returns
Type Description
Map<String,String>

getSccSecurityMarksCount()

public int getSccSecurityMarksCount()

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

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.

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.

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.

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

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=603

This field is only present for the purpose of backward compatibility. 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=603

This field is only present for the purpose of backward compatibility. 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=603

This field is only present for the purpose of backward compatibility. 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=603

This field is only present for the purpose of backward compatibility. 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=633

This field is only present for the purpose of backward compatibility. 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=633

This field is only present for the purpose of backward compatibility. 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=633

This field is only present for the purpose of backward compatibility. 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=633

This field is only present for the purpose of backward compatibility. 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=620

This field is only present for the purpose of backward compatibility. 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=620

This field is only present for the purpose of backward compatibility. 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=620

This field is only present for the purpose of backward compatibility. 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=620

This field is only present for the purpose of backward compatibility. 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"
    • tagKeyIds="tagKeys/123"
    • 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

getTagsBuilder(int index)

public Tag.Builder getTagsBuilder(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"
    • tagKeyIds="tagKeys/123"
    • 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.Builder

getTagsBuilderList()

public List<Tag.Builder> getTagsBuilderList()

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"
    • tagKeyIds="tagKeys/123"
    • 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<Builder>

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"
    • tagKeyIds="tagKeys/123"
    • 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"
    • tagKeyIds="tagKeys/123"
    • 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"
    • tagKeyIds="tagKeys/123"
    • 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"
    • tagKeyIds="tagKeys/123"
    • 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.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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
Builder

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

getVersionedResourcesBuilder(int index)

public VersionedResource.Builder getVersionedResourcesBuilder(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.Builder

getVersionedResourcesBuilderList()

public List<VersionedResource.Builder> getVersionedResourcesBuilderList()

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<Builder>

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.

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAdditionalAttributes(Struct value)

public ResourceSearchResult.Builder mergeAdditionalAttributes(Struct value)

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;

Parameter
Name Description
value Struct
Returns
Type Description
ResourceSearchResult.Builder

mergeCreateTime(Timestamp value)

public ResourceSearchResult.Builder mergeCreateTime(Timestamp value)

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;

Parameter
Name Description
value Timestamp
Returns
Type Description
ResourceSearchResult.Builder

mergeFrom(ResourceSearchResult other)

public ResourceSearchResult.Builder mergeFrom(ResourceSearchResult other)
Parameter
Name Description
other ResourceSearchResult
Returns
Type Description
ResourceSearchResult.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ResourceSearchResult.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResourceSearchResult.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ResourceSearchResult.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ResourceSearchResult.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ResourceSearchResult.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ResourceSearchResult.Builder
Overrides

mergeUpdateTime(Timestamp value)

public ResourceSearchResult.Builder mergeUpdateTime(Timestamp value)

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;

Parameter
Name Description
value Timestamp
Returns
Type Description
ResourceSearchResult.Builder

putAllLabels(Map<String,String> values)

public ResourceSearchResult.Builder putAllLabels(Map<String,String> values)

User 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
values Map<String,String>
Returns
Type Description
ResourceSearchResult.Builder

putAllRelationships(Map<String,RelatedResources> values)

public ResourceSearchResult.Builder putAllRelationships(Map<String,RelatedResources> values)

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
values Map<String,RelatedResources>
Returns
Type Description
ResourceSearchResult.Builder

putAllSccSecurityMarks(Map<String,String> values)

public ResourceSearchResult.Builder putAllSccSecurityMarks(Map<String,String> values)

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

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
values Map<String,String>
Returns
Type Description
ResourceSearchResult.Builder

putLabels(String key, String value)

public ResourceSearchResult.Builder putLabels(String key, String value)

User 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
value String
Returns
Type Description
ResourceSearchResult.Builder

putRelationships(String key, RelatedResources value)

public ResourceSearchResult.Builder putRelationships(String key, RelatedResources value)

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
value RelatedResources
Returns
Type Description
ResourceSearchResult.Builder

putRelationshipsBuilderIfAbsent(String key)

public RelatedResources.Builder putRelationshipsBuilderIfAbsent(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.Builder

putSccSecurityMarks(String key, String value)

public ResourceSearchResult.Builder putSccSecurityMarks(String key, String value)

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

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
value String
Returns
Type Description
ResourceSearchResult.Builder

removeAttachedResources(int index)

public ResourceSearchResult.Builder removeAttachedResources(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
ResourceSearchResult.Builder

removeEffectiveTags(int index)

public ResourceSearchResult.Builder removeEffectiveTags(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"
    • effectiveTagKeyIds="tagKeys/123"
    • 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
ResourceSearchResult.Builder

removeLabels(String key)

public ResourceSearchResult.Builder removeLabels(String key)

User 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
ResourceSearchResult.Builder

removeRelationships(String key)

public ResourceSearchResult.Builder removeRelationships(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
ResourceSearchResult.Builder

removeSccSecurityMarks(String key)

public ResourceSearchResult.Builder removeSccSecurityMarks(String key)

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

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

removeTags(int index)

public ResourceSearchResult.Builder removeTags(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"
    • tagKeyIds="tagKeys/123"
    • 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
ResourceSearchResult.Builder

removeVersionedResources(int index)

public ResourceSearchResult.Builder removeVersionedResources(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
ResourceSearchResult.Builder

setAdditionalAttributes(Struct value)

public ResourceSearchResult.Builder setAdditionalAttributes(Struct value)

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;

Parameter
Name Description
value Struct
Returns
Type Description
ResourceSearchResult.Builder

setAdditionalAttributes(Struct.Builder builderForValue)

public ResourceSearchResult.Builder setAdditionalAttributes(Struct.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ResourceSearchResult.Builder

setAssetType(String value)

public ResourceSearchResult.Builder setAssetType(String value)

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;

Parameter
Name Description
value String

The assetType to set.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

setAssetTypeBytes(ByteString value)

public ResourceSearchResult.Builder setAssetTypeBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for assetType to set.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

setAttachedResources(int index, AttachedResource value)

public ResourceSearchResult.Builder setAttachedResources(int index, AttachedResource value)

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;

Parameters
Name Description
index int
value AttachedResource
Returns
Type Description
ResourceSearchResult.Builder

setAttachedResources(int index, AttachedResource.Builder builderForValue)

public ResourceSearchResult.Builder setAttachedResources(int index, AttachedResource.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue AttachedResource.Builder
Returns
Type Description
ResourceSearchResult.Builder

setCreateTime(Timestamp value)

public ResourceSearchResult.Builder setCreateTime(Timestamp value)

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;

Parameter
Name Description
value Timestamp
Returns
Type Description
ResourceSearchResult.Builder

setCreateTime(Timestamp.Builder builderForValue)

public ResourceSearchResult.Builder setCreateTime(Timestamp.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ResourceSearchResult.Builder

setDescription(String value)

public ResourceSearchResult.Builder setDescription(String value)

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;

Parameter
Name Description
value String

The description to set.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public ResourceSearchResult.Builder setDescriptionBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

setDisplayName(String value)

public ResourceSearchResult.Builder setDisplayName(String value)

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;

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public ResourceSearchResult.Builder setDisplayNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

setEffectiveTags(int index, EffectiveTagDetails value)

public ResourceSearchResult.Builder setEffectiveTags(int index, EffectiveTagDetails value)

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"
    • effectiveTagKeyIds="tagKeys/123"
    • 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;

Parameters
Name Description
index int
value EffectiveTagDetails
Returns
Type Description
ResourceSearchResult.Builder

setEffectiveTags(int index, EffectiveTagDetails.Builder builderForValue)

public ResourceSearchResult.Builder setEffectiveTags(int index, EffectiveTagDetails.Builder builderForValue)

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"
    • effectiveTagKeyIds="tagKeys/123"
    • 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;

Parameters
Name Description
index int
builderForValue EffectiveTagDetails.Builder
Returns
Type Description
ResourceSearchResult.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ResourceSearchResult.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ResourceSearchResult.Builder
Overrides

setFolders(int index, String value)

public ResourceSearchResult.Builder setFolders(int index, String value)

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;

Parameters
Name Description
index int

The index to set the value at.

value String

The folders to set.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

setKmsKey(String value) (deprecated)

public ResourceSearchResult.Builder setKmsKey(String value)

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

The Cloud KMS CryptoKey name or CryptoKeyVersion name.

This field only presents for the purpose of backward compatibility. 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];

Parameter
Name Description
value String

The kmsKey to set.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

setKmsKeyBytes(ByteString value) (deprecated)

public ResourceSearchResult.Builder setKmsKeyBytes(ByteString value)

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

The Cloud KMS CryptoKey name or CryptoKeyVersion name.

This field only presents for the purpose of backward compatibility. 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];

Parameter
Name Description
value ByteString

The bytes for kmsKey to set.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

setKmsKeys(int index, String value)

public ResourceSearchResult.Builder setKmsKeys(int index, String value)

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;

Parameters
Name Description
index int

The index to set the value at.

value String

The kmsKeys to set.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

setLocation(String value)

public ResourceSearchResult.Builder setLocation(String value)

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;

Parameter
Name Description
value String

The location to set.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

setLocationBytes(ByteString value)

public ResourceSearchResult.Builder setLocationBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for location to set.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

setName(String value)

public ResourceSearchResult.Builder setName(String value)

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;

Parameter
Name Description
value String

The name to set.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

setNameBytes(ByteString value)

public ResourceSearchResult.Builder setNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

setNetworkTags(int index, String value)

public ResourceSearchResult.Builder setNetworkTags(int index, String value)

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;

Parameters
Name Description
index int

The index to set the value at.

value String

The networkTags to set.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

setOrganization(String value)

public ResourceSearchResult.Builder setOrganization(String value)

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;

Parameter
Name Description
value String

The organization to set.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

setOrganizationBytes(ByteString value)

public ResourceSearchResult.Builder setOrganizationBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for organization to set.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

setParentAssetType(String value)

public ResourceSearchResult.Builder setParentAssetType(String value)

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;

Parameter
Name Description
value String

The parentAssetType to set.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

setParentAssetTypeBytes(ByteString value)

public ResourceSearchResult.Builder setParentAssetTypeBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for parentAssetType to set.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

setParentFullResourceName(String value)

public ResourceSearchResult.Builder setParentFullResourceName(String value)

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;

Parameter
Name Description
value String

The parentFullResourceName to set.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

setParentFullResourceNameBytes(ByteString value)

public ResourceSearchResult.Builder setParentFullResourceNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for parentFullResourceName to set.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

setProject(String value)

public ResourceSearchResult.Builder setProject(String value)

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;

Parameter
Name Description
value String

The project to set.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

setProjectBytes(ByteString value)

public ResourceSearchResult.Builder setProjectBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for project to set.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ResourceSearchResult.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ResourceSearchResult.Builder
Overrides

setState(String value)

public ResourceSearchResult.Builder setState(String value)

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;

Parameter
Name Description
value String

The state to set.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

setStateBytes(ByteString value)

public ResourceSearchResult.Builder setStateBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for state to set.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

setTagKeys(int index, String value) (deprecated)

public ResourceSearchResult.Builder setTagKeys(int index, String value)

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

This field is only present for the purpose of backward compatibility. 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];

Parameters
Name Description
index int

The index to set the value at.

value String

The tagKeys to set.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

setTagValueIds(int index, String value) (deprecated)

public ResourceSearchResult.Builder setTagValueIds(int index, String value)

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

This field is only present for the purpose of backward compatibility. 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];

Parameters
Name Description
index int

The index to set the value at.

value String

The tagValueIds to set.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

setTagValues(int index, String value) (deprecated)

public ResourceSearchResult.Builder setTagValues(int index, String value)

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

This field is only present for the purpose of backward compatibility. 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];

Parameters
Name Description
index int

The index to set the value at.

value String

The tagValues to set.

Returns
Type Description
ResourceSearchResult.Builder

This builder for chaining.

setTags(int index, Tag value)

public ResourceSearchResult.Builder setTags(int index, Tag value)

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"
    • tagKeyIds="tagKeys/123"
    • 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;

Parameters
Name Description
index int
value Tag
Returns
Type Description
ResourceSearchResult.Builder

setTags(int index, Tag.Builder builderForValue)

public ResourceSearchResult.Builder setTags(int index, Tag.Builder builderForValue)

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"
    • tagKeyIds="tagKeys/123"
    • 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;

Parameters
Name Description
index int
builderForValue Tag.Builder
Returns
Type Description
ResourceSearchResult.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final ResourceSearchResult.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ResourceSearchResult.Builder
Overrides

setUpdateTime(Timestamp value)

public ResourceSearchResult.Builder setUpdateTime(Timestamp value)

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;

Parameter
Name Description
value Timestamp
Returns
Type Description
ResourceSearchResult.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public ResourceSearchResult.Builder setUpdateTime(Timestamp.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ResourceSearchResult.Builder

setVersionedResources(int index, VersionedResource value)

public ResourceSearchResult.Builder setVersionedResources(int index, VersionedResource value)

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;

Parameters
Name Description
index int
value VersionedResource
Returns
Type Description
ResourceSearchResult.Builder

setVersionedResources(int index, VersionedResource.Builder builderForValue)

public ResourceSearchResult.Builder setVersionedResources(int index, VersionedResource.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue VersionedResource.Builder
Returns
Type Description
ResourceSearchResult.Builder