Class ResourceSearchResult.Builder (3.3.1)

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
TypeDescription
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
NameDescription
valuesIterable<? extends com.google.cloud.asset.v1.AttachedResource>
Returns
TypeDescription
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
NameDescription
valuesIterable<String>

The folders to add.

Returns
TypeDescription
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 GCP resources. See Labelling GCP resources for more information. This field is available only when the resource's Protobuf contains it. To search against the network_tags:

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

repeated string network_tags = 8;

Parameter
NameDescription
valuesIterable<String>

The networkTags to add.

Returns
TypeDescription
ResourceSearchResult.Builder

This builder for chaining.

addAllTagKeys(Iterable<String> values)

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

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

  • use a field query. Example:
    • tagKeys:"123456789/env*"
    • tagKeys="123456789/env"
    • tagKeys:"env"
  • use a free text query. Example:
    • env

repeated string tag_keys = 23;

Parameter
NameDescription
valuesIterable<String>

The tagKeys to add.

Returns
TypeDescription
ResourceSearchResult.Builder

This builder for chaining.

addAllTagValueIds(Iterable<String> values)

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

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

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

repeated string tag_value_ids = 26;

Parameter
NameDescription
valuesIterable<String>

The tagValueIds to add.

Returns
TypeDescription
ResourceSearchResult.Builder

This builder for chaining.

addAllTagValues(Iterable<String> values)

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

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

  • use a field query. Example:
    • tagValues:"env"
    • tagValues:"env/prod"
    • tagValues:"123456789/env/prod*"
    • tagValues="123456789/env/prod"
  • use a free text query. Example:
    • prod

repeated string tag_values = 25;

Parameter
NameDescription
valuesIterable<String>

The tagValues to add.

Returns
TypeDescription
ResourceSearchResult.Builder

This builder for chaining.

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
NameDescription
valuesIterable<? extends com.google.cloud.asset.v1.VersionedResource>
Returns
TypeDescription
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
NameDescription
valueAttachedResource
Returns
TypeDescription
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
NameDescription
builderForValueAttachedResource.Builder
Returns
TypeDescription
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
NameDescription
indexint
valueAttachedResource
Returns
TypeDescription
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
NameDescription
indexint
builderForValueAttachedResource.Builder
Returns
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
AttachedResource.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
NameDescription
valueString

The folders to add.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes of the folders to add.

Returns
TypeDescription
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 GCP resources. See Labelling GCP resources for more information. This field is available only when the resource's Protobuf contains it. To search against the network_tags:

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

repeated string network_tags = 8;

Parameter
NameDescription
valueString

The networkTags to add.

Returns
TypeDescription
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 GCP resources. See Labelling GCP resources for more information. This field is available only when the resource's Protobuf contains it. To search against the network_tags:

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

repeated string network_tags = 8;

Parameter
NameDescription
valueByteString

The bytes of the networkTags to add.

Returns
TypeDescription
ResourceSearchResult.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ResourceSearchResult.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ResourceSearchResult.Builder
Overrides

addTagKeys(String value)

public ResourceSearchResult.Builder addTagKeys(String value)

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

  • use a field query. Example:
    • tagKeys:"123456789/env*"
    • tagKeys="123456789/env"
    • tagKeys:"env"
  • use a free text query. Example:
    • env

repeated string tag_keys = 23;

Parameter
NameDescription
valueString

The tagKeys to add.

Returns
TypeDescription
ResourceSearchResult.Builder

This builder for chaining.

addTagKeysBytes(ByteString value)

public ResourceSearchResult.Builder addTagKeysBytes(ByteString value)

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

  • use a field query. Example:
    • tagKeys:"123456789/env*"
    • tagKeys="123456789/env"
    • tagKeys:"env"
  • use a free text query. Example:
    • env

repeated string tag_keys = 23;

Parameter
NameDescription
valueByteString

The bytes of the tagKeys to add.

Returns
TypeDescription
ResourceSearchResult.Builder

This builder for chaining.

addTagValueIds(String value)

public ResourceSearchResult.Builder addTagValueIds(String value)

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

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

repeated string tag_value_ids = 26;

Parameter
NameDescription
valueString

The tagValueIds to add.

Returns
TypeDescription
ResourceSearchResult.Builder

This builder for chaining.

addTagValueIdsBytes(ByteString value)

public ResourceSearchResult.Builder addTagValueIdsBytes(ByteString value)

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

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

repeated string tag_value_ids = 26;

Parameter
NameDescription
valueByteString

The bytes of the tagValueIds to add.

Returns
TypeDescription
ResourceSearchResult.Builder

This builder for chaining.

addTagValues(String value)

public ResourceSearchResult.Builder addTagValues(String value)

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

  • use a field query. Example:
    • tagValues:"env"
    • tagValues:"env/prod"
    • tagValues:"123456789/env/prod*"
    • tagValues="123456789/env/prod"
  • use a free text query. Example:
    • prod

repeated string tag_values = 25;

Parameter
NameDescription
valueString

The tagValues to add.

Returns
TypeDescription
ResourceSearchResult.Builder

This builder for chaining.

addTagValuesBytes(ByteString value)

public ResourceSearchResult.Builder addTagValuesBytes(ByteString value)

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

  • use a field query. Example:
    • tagValues:"env"
    • tagValues:"env/prod"
    • tagValues:"123456789/env/prod*"
    • tagValues="123456789/env/prod"
  • use a free text query. Example:
    • prod

repeated string tag_values = 25;

Parameter
NameDescription
valueByteString

The bytes of the tagValues to add.

Returns
TypeDescription
ResourceSearchResult.Builder

This builder for chaining.

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
NameDescription
valueVersionedResource
Returns
TypeDescription
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
NameDescription
builderForValueVersionedResource.Builder
Returns
TypeDescription
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
NameDescription
indexint
valueVersionedResource
Returns
TypeDescription
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
NameDescription
indexint
builderForValueVersionedResource.Builder
Returns
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
VersionedResource.Builder

build()

public ResourceSearchResult build()
Returns
TypeDescription
ResourceSearchResult

buildPartial()

public ResourceSearchResult buildPartial()
Returns
TypeDescription
ResourceSearchResult

clear()

public ResourceSearchResult.Builder clear()
Returns
TypeDescription
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 GCP service (e.g., Compute Engine). see API references and supported searchable attributes to see which fields are included. You can search values of these fields through free text search. However, you should not consume the field programically as the field names and values may change as the GCP service updates to a new incompatible API version. To search against the additional_attributes:

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

.google.protobuf.Struct additional_attributes = 9;

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ResourceSearchResult.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
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
TypeDescription
ResourceSearchResult.Builder

This builder for chaining.

clearKmsKey()

public ResourceSearchResult.Builder clearKmsKey()

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

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

string kms_key = 10;

Returns
TypeDescription
ResourceSearchResult.Builder

This builder for chaining.

clearLabels()

public ResourceSearchResult.Builder clearLabels()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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 GCP resources. See Labelling GCP resources for more information. This field is available only when the resource's Protobuf contains it. To search against the network_tags:

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

repeated string network_tags = 8;

Returns
TypeDescription
ResourceSearchResult.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ResourceSearchResult.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ResourceSearchResult.Builder

This builder for chaining.

clearRelationships()

public ResourceSearchResult.Builder clearRelationships()
Returns
TypeDescription
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 Cloud Resource Manager, its state will include LIFECYCLE_STATE_UNSPECIFIED, ACTIVE, DELETE_REQUESTED and DELETE_IN_PROGRESS. See lifecycleState definition in API Reference. To search against the state:

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

string state = 13;

Returns
TypeDescription
ResourceSearchResult.Builder

This builder for chaining.

clearTagKeys()

public ResourceSearchResult.Builder clearTagKeys()

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

  • use a field query. Example:
    • tagKeys:"123456789/env*"
    • tagKeys="123456789/env"
    • tagKeys:"env"
  • use a free text query. Example:
    • env

repeated string tag_keys = 23;

Returns
TypeDescription
ResourceSearchResult.Builder

This builder for chaining.

clearTagValueIds()

public ResourceSearchResult.Builder clearTagValueIds()

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

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

repeated string tag_value_ids = 26;

Returns
TypeDescription
ResourceSearchResult.Builder

This builder for chaining.

clearTagValues()

public ResourceSearchResult.Builder clearTagValues()

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

  • use a field query. Example:
    • tagValues:"env"
    • tagValues:"env/prod"
    • tagValues:"123456789/env/prod*"
    • tagValues="123456789/env/prod"
  • use a free text query. Example:
    • prod

repeated string tag_values = 25;

Returns
TypeDescription
ResourceSearchResult.Builder

This builder for chaining.

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

clone()

public ResourceSearchResult.Builder clone()
Returns
TypeDescription
ResourceSearchResult.Builder
Overrides

containsLabels(String key)

public boolean containsLabels(String key)

Labels associated with this resource. See Labelling and grouping GCP resources for more information. This field is available only when the resource's Protobuf contains it. To search against the labels:

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

map<string, string> labels = 7;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

containsRelationships(String key)

public boolean containsRelationships(String key)

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

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

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getAdditionalAttributes()

public Struct getAdditionalAttributes()

The additional searchable attributes of this resource. The attributes may vary from one resource type to another. Examples: projectId for Project, dnsName for DNS ManagedZone. This field contains a subset of the resource metadata fields that are returned by the List or Get APIs provided by the corresponding GCP service (e.g., Compute Engine). see API references and supported searchable attributes to see which fields are included. You can search values of these fields through free text search. However, you should not consume the field programically as the field names and values may change as the GCP service updates to a new incompatible API version. To search against the additional_attributes:

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

.google.protobuf.Struct additional_attributes = 9;

Returns
TypeDescription
Struct

The additionalAttributes.

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 GCP service (e.g., Compute Engine). see API references and supported searchable attributes to see which fields are included. You can search values of these fields through free text search. However, you should not consume the field programically as the field names and values may change as the GCP service updates to a new incompatible API version. To search against the additional_attributes:

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

.google.protobuf.Struct additional_attributes = 9;

Returns
TypeDescription
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 GCP service (e.g., Compute Engine). see API references and supported searchable attributes to see which fields are included. You can search values of these fields through free text search. However, you should not consume the field programically as the field names and values may change as the GCP service updates to a new incompatible API version. To search against the additional_attributes:

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

.google.protobuf.Struct additional_attributes = 9;

Returns
TypeDescription
StructOrBuilder

getAssetType()

public String getAssetType()

The type of this resource. Example: compute.googleapis.com/Disk. To search against the asset_type:

  • specify the asset_type field in your search request.

string asset_type = 2;

Returns
TypeDescription
String

The assetType.

getAssetTypeBytes()

public ByteString getAssetTypeBytes()

The type of this resource. Example: compute.googleapis.com/Disk. To search against the asset_type:

  • specify the asset_type field in your search request.

string asset_type = 2;

Returns
TypeDescription
ByteString

The bytes for assetType.

getAttachedResources(int index)

public AttachedResource getAttachedResources(int index)

Attached resources of this resource. For example, an OSConfig Inventory is an attached resource of a Compute Instance. This field is repeated because a resource could have multiple attached resources. This attached_resources field is not searchable. Some attributes of the attached resources are exposed in additional_attributes field, so as to allow users to search on them.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
AttachedResource

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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public ResourceSearchResult getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for displayName.

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

The index of the element to return.

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

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ProtocolStringList

A list containing the folders.

getKmsKey()

public String getKmsKey()

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

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

string kms_key = 10;

Returns
TypeDescription
String

The kmsKey.

getKmsKeyBytes()

public ByteString getKmsKeyBytes()

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

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

string kms_key = 10;

Returns
TypeDescription
ByteString

The bytes for kmsKey.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels associated with this resource. See Labelling and grouping GCP resources for more information. This field is available only when the resource's Protobuf contains it. To search against the labels:

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

map<string, string> labels = 7;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels associated with this resource. See Labelling and grouping GCP resources for more information. This field is available only when the resource's Protobuf contains it. To search against the labels:

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

map<string, string> labels = 7;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Labels associated with this resource. See Labelling and grouping GCP resources for more information. This field is available only when the resource's Protobuf contains it. To search against the labels:

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

map<string, string> labels = 7;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels associated with this resource. See Labelling and grouping GCP resources for more information. This field is available only when the resource's Protobuf contains it. To search against the labels:

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

map<string, string> labels = 7;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getLocation()

public String getLocation()

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

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

string location = 6;

Returns
TypeDescription
String

The location.

getLocationBytes()

public ByteString getLocationBytes()

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

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

string location = 6;

Returns
TypeDescription
ByteString

The bytes for location.

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getMutableRelationships()

public Map<String,RelatedResources> getMutableRelationships()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,RelatedResources>

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
TypeDescription
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
TypeDescription
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 GCP resources. See Labelling GCP resources for more information. This field is available only when the resource's Protobuf contains it. To search against the network_tags:

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

repeated string network_tags = 8;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The networkTags at the given index.

getNetworkTagsBytes(int index)

public ByteString getNetworkTagsBytes(int index)

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

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

repeated string network_tags = 8;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the networkTags at the given index.

getNetworkTagsCount()

public int getNetworkTagsCount()

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

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

repeated string network_tags = 8;

Returns
TypeDescription
int

The count of networkTags.

getNetworkTagsList()

public ProtocolStringList getNetworkTagsList()

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

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

repeated string network_tags = 8;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for project.

getRelationships()

public Map<String,RelatedResources> getRelationships()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueRelatedResources
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
RelatedResources

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 Cloud Resource Manager, its state will include LIFECYCLE_STATE_UNSPECIFIED, ACTIVE, DELETE_REQUESTED and DELETE_IN_PROGRESS. See lifecycleState definition in API Reference<