public static final class ResourceSearchResult.Builder extends GeneratedMessageV3.Builder<ResourceSearchResult.Builder> implements ResourceSearchResultOrBuilderA result of Resource Search, containing information of a cloud resource.
Protobuf type google.cloud.asset.v1.ResourceSearchResult
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ResourceSearchResult.BuilderImplements
ResourceSearchResultOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| 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;
| Name | Description |
| values | Iterable<? extends com.google.cloud.asset.v1.AttachedResource> |
| 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
scopefield as this folder in your search request.
repeated string folders = 17;
| Name | Description |
| values | Iterable<String>The folders to add. |
| 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 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;
| Name | Description |
| values | Iterable<String>The networkTags to add. |
| Type | Description |
| 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;
| Name | Description |
| values | Iterable<String>The tagKeys to add. |
| Type | Description |
| 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;
| Name | Description |
| values | Iterable<String>The tagValueIds to add. |
| Type | Description |
| 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;
| Name | Description |
| values | Iterable<String>The tagValues to add. |
| Type | Description |
| 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;
| Name | Description |
| values | Iterable<? extends com.google.cloud.asset.v1.VersionedResource> |
| 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;
| Name | Description |
| value | AttachedResource |
| 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;
| Name | Description |
| builderForValue | AttachedResource.Builder |
| 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;
| Name | Description |
| index | int |
| value | AttachedResource |
| 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;
| Name | Description |
| index | int |
| builderForValue | AttachedResource.Builder |
| 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;
| 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;
| Name | Description |
| index | int |
| Type | Description |
| 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
scopefield as this folder in your search request.
repeated string folders = 17;
| Name | Description |
| value | StringThe folders to add. |
| 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
scopefield as this folder in your search request.
repeated string folders = 17;
| Name | Description |
| value | ByteStringThe bytes of the folders to add. |
| 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 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;
| Name | Description |
| value | StringThe networkTags to add. |
| 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 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;
| Name | Description |
| value | ByteStringThe bytes of the networkTags to add. |
| Type | Description |
| ResourceSearchResult.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ResourceSearchResult.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| ResourceSearchResult.Builder |
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;
| Name | Description |
| value | StringThe tagKeys to add. |
| Type | Description |
| 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;
| Name | Description |
| value | ByteStringThe bytes of the tagKeys to add. |
| Type | Description |
| 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;
| Name | Description |
| value | StringThe tagValueIds to add. |
| Type | Description |
| 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;
| Name | Description |
| value | ByteStringThe bytes of the tagValueIds to add. |
| Type | Description |
| 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;
| Name | Description |
| value | StringThe tagValues to add. |
| Type | Description |
| 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;
| Name | Description |
| value | ByteStringThe bytes of the tagValues to add. |
| Type | Description |
| 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;
| Name | Description |
| value | VersionedResource |
| 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;
| Name | Description |
| builderForValue | VersionedResource.Builder |
| 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;
| Name | Description |
| index | int |
| value | VersionedResource |
| 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;
| Name | Description |
| index | int |
| builderForValue | VersionedResource.Builder |
| 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;
| 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;
| Name | Description |
| index | int |
| Type | Description |
| VersionedResource.Builder |
build()
public ResourceSearchResult build()| Type | Description |
| ResourceSearchResult |
buildPartial()
public ResourceSearchResult buildPartial()| Type | Description |
| ResourceSearchResult |
clear()
public ResourceSearchResult.Builder clear()| Type | Description |
| ResourceSearchResult.Builder |
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 queryfoobar.
.google.protobuf.Struct additional_attributes = 9;
| 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_typefield in your search request.
string asset_type = 2;
| 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;
| 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"
- value in seconds since unix epoch. Example:
.google.protobuf.Timestamp create_time = 11;
| 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;
| 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;
| Type | Description |
| ResourceSearchResult.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public ResourceSearchResult.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| ResourceSearchResult.Builder |
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
scopefield as this folder in your search request.
repeated string folders = 17;
| Type | Description |
| 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;
| Type | Description |
| ResourceSearchResult.Builder | This builder for chaining. |
clearLabels()
public ResourceSearchResult.Builder clearLabels()| 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;
| 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;
| 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 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;
| Type | Description |
| ResourceSearchResult.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ResourceSearchResult.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| ResourceSearchResult.Builder |
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
scopefield as this organization in your search request.
string organization = 18;
| 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;
| 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;
| 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
scopefield as this project in your search request.
string project = 3;
| Type | Description |
| ResourceSearchResult.Builder | This builder for chaining. |
clearRelationships()
public ResourceSearchResult.Builder clearRelationships()| 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 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;
| Type | Description |
| 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;
| Type | Description |
| 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;
| Type | Description |
| 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;
| Type | Description |
| 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"
- value in seconds since unix epoch. Example:
.google.protobuf.Timestamp update_time = 12;
| 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;
| Type | Description |
| ResourceSearchResult.Builder |
clone()
public ResourceSearchResult.Builder clone()| Type | Description |
| ResourceSearchResult.Builder |
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:*
- query on any label's key or value. Example:
- use a free text query. Example:
prod
map<string, string> labels = 7;
| Name | Description |
| key | String |
| 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;
| Name | Description |
| key | String |
| 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 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 queryfoobar.
.google.protobuf.Struct additional_attributes = 9;
| 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 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 queryfoobar.
.google.protobuf.Struct additional_attributes = 9;
| 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 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 queryfoobar.
.google.protobuf.Struct additional_attributes = 9;
| 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_typefield in your search request.
string asset_type = 2;
| 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_typefield in your search request.
string asset_type = 2;
| 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;
| Name | Description |
| index | int |
| 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;
| Name | Description |
| index | int |
| 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;
| 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;
| 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;
| 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;
| Name | Description |
| index | int |
| 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;
| 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"
- value in seconds since unix epoch. Example:
.google.protobuf.Timestamp create_time = 11;
| 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"
- value in seconds since unix epoch. Example:
.google.protobuf.Timestamp create_time = 11;
| 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"
- value in seconds since unix epoch. Example:
.google.protobuf.Timestamp create_time = 11;
| Type | Description |
| TimestampOrBuilder |
getDefaultInstanceForType()
public ResourceSearchResult getDefaultInstanceForType()| 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;
| 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;
| Type | Description |
| ByteString | The bytes for description. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
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;
| 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;
| Type | Description |
| 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
scopefield as this folder in your search request.
repeated string folders = 17;
| Name | Description |
| index | intThe index of the element to return. |
| 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
scopefield as this folder in your search request.
repeated string folders = 17;
| Name | Description |
| index | intThe index of the value to return. |
| 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
scopefield as this folder in your search request.
repeated string folders = 17;
| 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
scopefield as this folder in your search request.
repeated string folders = 17;
| Type | Description |
| 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;
| Type | Description |
| 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;
| Type | Description |
| ByteString | The bytes for kmsKey. |
getLabels()
public Map<String,String> getLabels()Use #getLabelsMap() instead.
| Type | Description |
| 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:*
- query on any label's key or value. Example:
- use a free text query. Example:
prod
map<string, string> labels = 7;
| Type | Description |
| 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:*
- query on any label's key or value. Example:
- use a free text query. Example:
prod
map<string, string> labels = 7;
| Type | Description |
| Map<String,String> |
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue) Labels associated with this resource. See Labelling and grouping 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:*
- query on any label's key or value. Example:
- use a free text query. Example:
prod
map<string, string> labels = 7;
| Name | Description |
| key | String |
| defaultValue | String |
| Type | Description |
| 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:*
- query on any label's key or value. Example:
- use a free text query. Example:
prod
map<string, string> labels = 7;
| Name | Description |
| key | String |
| 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;
| 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;
| Type | Description |
| ByteString | The bytes for location. |
getMutableLabels()
public Map<String,String> getMutableLabels()Use alternate mutation accessors instead.
| Type | Description |
| Map<String,String> |
getMutableRelationships()
public Map<String,RelatedResources> getMutableRelationships()Use alternate mutation accessors instead.
| Type | Description |
| 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;
| 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;
| 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 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;
| Name | Description |
| index | intThe index of the element to return. |
| 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 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;
| Name | Description |
| index | intThe index of the value to return. |
| 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 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;
| 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 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;
| 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
scopefield as this organization in your search request.
string organization = 18;
| 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
scopefield as this organization in your search request.
string organization = 18;
| 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;
| 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;
| 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;
| 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;
| 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
scopefield as this project in your search request.
string project = 3;
| 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
scopefield as this project in your search request.
string project = 3;
| Type | Description |
| ByteString | The bytes for project. |
getRelationships()
public Map<String,RelatedResources> getRelationships()Use #getRelationshipsMap() instead.
| 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;
| 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;
| 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;
| Name | Description |
| key | String |
| defaultValue | RelatedResources |
| 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;
| Name | Description |
| key | String |
| Type | Description |
| 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.
To search against the state:
- use a field query. Example:
state:RUNNING - use a free text query. Example:
RUNNING
string state = 13;
| 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 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;
| Type | Description |
| ByteString | The bytes for state. |
getTagKeys(int index)
public String getTagKeys(int index) TagKey namespaced names, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}.
To search against the tagKeys:
- use a field query. Example:
tagKeys:"123456789/env*"tagKeys="123456789/env"tagKeys:"env"
- use a free text query. Example:
env
repeated string tag_keys = 23;
| Name | Description |
| index | intThe index of the element to return. |
| Type | Description |
| String | The tagKeys at the given index. |
getTagKeysBytes(int index)
public ByteString getTagKeysBytes(int index) TagKey namespaced names, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}.
To search against the tagKeys:
- use a field query. Example:
tagKeys:"123456789/env*"tagKeys="123456789/env"tagKeys:"env"
- use a free text query. Example:
env
repeated string tag_keys = 23;
| Name | Description |
| index | intThe index of the value to return. |
| Type | Description |
| ByteString | The bytes of the tagKeys at the given index. |
getTagKeysCount()
public int getTagKeysCount() TagKey namespaced names, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}.
To search against the tagKeys:
- use a field query. Example:
tagKeys:"123456789/env*"tagKeys="123456789/env"tagKeys:"env"
- use a free text query. Example:
env
repeated string tag_keys = 23;
| Type | Description |
| int | The count of tagKeys. |
getTagKeysList()
public ProtocolStringList getTagKeysList() TagKey namespaced names, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}.
To search against the tagKeys:
- use a field query. Example:
tagKeys:"123456789/env*"tagKeys="123456789/env"tagKeys:"env"
- use a free text query. Example:
env
repeated string tag_keys = 23;
| Type | Description |
| ProtocolStringList | A list containing the tagKeys. |
getTagValueIds(int index)
public String getTagValueIds(int index) TagValue IDs, in the format of tagValues/{TAG_VALUE_ID}.
To search against the tagValueIds:
- use a field query. Example:
tagValueIds:"456"tagValueIds="tagValues/456"
- use a free text query. Example:
456
repeated string tag_value_ids = 26;
| Name | Description |
| index | intThe index of the element to return. |
| Type | Description |
| String | The tagValueIds at the given index. |
getTagValueIdsBytes(int index)
public ByteString getTagValueIdsBytes(int index) TagValue IDs, in the format of tagValues/{TAG_VALUE_ID}.
To search against the tagValueIds:
- use a field query. Example:
tagValueIds:"456"tagValueIds="tagValues/456"
- use a free text query. Example:
456
repeated string tag_value_ids = 26;
| Name | Description |
| index | intThe index of the value to return. |
| Type | Description |
| ByteString | The bytes of the tagValueIds at the given index. |
getTagValueIdsCount()
public int getTagValueIdsCount() TagValue IDs, in the format of tagValues/{TAG_VALUE_ID}.
To search against the tagValueIds:
- use a field query. Example:
tagValueIds:"456"tagValueIds="tagValues/456"
- use a free text query. Example:
456
repeated string tag_value_ids = 26;
| Type | Description |
| int | The count of tagValueIds. |
getTagValueIdsList()
public ProtocolStringList getTagValueIdsList() TagValue IDs, in the format of tagValues/{TAG_VALUE_ID}.
To search against the tagValueIds:
- use a field query. Example:
tagValueIds:"456"tagValueIds="tagValues/456"
- use a free text query. Example:
456
repeated string tag_value_ids = 26;
| Type | Description |
| ProtocolStringList | A list containing the tagValueIds. |
getTagValues(int index)
public String getTagValues(int index) TagValue namespaced names, in the format of
{ORG_ID}/{TAG_KEY_SHORT_NAME}/{TAG_VALUE_SHORT_NAME}.
To search against the tagValues:
- use a field query. Example:
tagValues:"env"tagValues:"env/prod"tagValues:"123456789/env/prod*"tagValues="123456789/env/prod"
- use a free text query. Example:
prod
repeated string tag_values = 25;
| Name | Description |
| index | intThe index of the element to return. |
| Type | Description |
| String | The tagValues at the given index. |
getTagValuesBytes(int index)
public ByteString getTagValuesBytes(int index) TagValue namespaced names, in the format of
{ORG_ID}/{TAG_KEY_SHORT_NAME}/{TAG_VALUE_SHORT_NAME}.
To search against the tagValues:
- use a field query. Example:
tagValues:"env"tagValues:"env/prod"tagValues:"123456789/env/prod*"tagValues="123456789/env/prod"
- use a free text query. Example:
prod
repeated string tag_values = 25;
| Name | Description |
| index | intThe index of the value to return. |
| Type | Description |
| ByteString | The bytes of the tagValues at the given index. |
getTagValuesCount()
public int getTagValuesCount() TagValue namespaced names, in the format of
{ORG_ID}/{TAG_KEY_SHORT_NAME}/{TAG_VALUE_SHORT_NAME}.
To search against the tagValues:
- use a field query. Example:
tagValues:"env"tagValues:"env/prod"tagValues:"123456789/env/prod*"tagValues="123456789/env/prod"
- use a free text query. Example:
prod
repeated string tag_values = 25;
| Type | Description |
| int | The count of tagValues. |
getTagValuesList()
public ProtocolStringList getTagValuesList() TagValue namespaced names, in the format of
{ORG_ID}/{TAG_KEY_SHORT_NAME}/{TAG_VALUE_SHORT_NAME}.
To search against the tagValues:
- use a field query. Example:
tagValues:"env"tagValues:"env/prod"tagValues:"123456789/env/prod*"tagValues="123456789/env/prod"
- use a free text query. Example:
prod
repeated string tag_values = 25;
| Type | Description |
| ProtocolStringList | A list containing the tagValues. |
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"
- value in seconds since unix epoch. Example:
.google.protobuf.Timestamp update_time = 12;
| 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"
- value in seconds since unix epoch. Example:
.google.protobuf.Timestamp update_time = 12;
| 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"
- value in seconds since unix epoch. Example:
.google.protobuf.Timestamp update_time = 12;
| 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;
| Name | Description |
| index | int |
| 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;
| Name | Description |
| index | int |
| 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;
| 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;
| 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;
| 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;
| Name | Description |
| index | int |
| 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;
| 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 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 queryfoobar.
.google.protobuf.Struct additional_attributes = 9;
| 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"
- value in seconds since unix epoch. Example:
.google.protobuf.Timestamp create_time = 11;
| 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"
- value in seconds since unix epoch. Example:
.google.protobuf.Timestamp update_time = 12;
| Type | Description |
| boolean | Whether the updateTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)| Name | Description |
| number | int |
| Type | Description |
| MapField |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)| Name | Description |
| number | int |
| Type | Description |
| MapField |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
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 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 queryfoobar.
.google.protobuf.Struct additional_attributes = 9;
| Name | Description |
| value | Struct |
| 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"
- value in seconds since unix epoch. Example:
.google.protobuf.Timestamp create_time = 11;
| Name | Description |
| value | Timestamp |
| Type | Description |
| ResourceSearchResult.Builder |
mergeFrom(ResourceSearchResult other)
public ResourceSearchResult.Builder mergeFrom(ResourceSearchResult other)| Name | Description |
| other | ResourceSearchResult |
| Type | Description |
| ResourceSearchResult.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ResourceSearchResult.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ResourceSearchResult.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public ResourceSearchResult.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| ResourceSearchResult.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ResourceSearchResult.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| ResourceSearchResult.Builder |
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"
- value in seconds since unix epoch. Example:
.google.protobuf.Timestamp update_time = 12;
| Name | Description |
| value | Timestamp |
| Type | Description |
| ResourceSearchResult.Builder |
putAllLabels(Map<String,String> values)
public ResourceSearchResult.Builder putAllLabels(Map<String,String> values) 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:*
- query on any label's key or value. Example:
- use a free text query. Example:
prod
map<string, string> labels = 7;
| Name | Description |
| values | Map<String,String> |
| 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;
| Name | Description |
| values | Map<String,RelatedResources> |
| Type | Description |
| ResourceSearchResult.Builder |
putLabels(String key, String value)
public ResourceSearchResult.Builder putLabels(String key, String value) 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:*
- query on any label's key or value. Example:
- use a free text query. Example:
prod
map<string, string> labels = 7;
| Name | Description |
| key | String |
| value | String |
| 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;
| Name | Description |
| key | String |
| value | RelatedResources |
| 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;
| Name | Description |
| index | int |
| Type | Description |
| ResourceSearchResult.Builder |
removeLabels(String key)
public ResourceSearchResult.Builder removeLabels(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:*
- query on any label's key or value. Example:
- use a free text query. Example:
prod
map<string, string> labels = 7;
| Name | Description |
| key | String |
| 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;
| Name | Description |
| key | String |
| 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;
| Name | Description |
| index | int |
| 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 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 queryfoobar.
.google.protobuf.Struct additional_attributes = 9;
| Name | Description |
| value | Struct |
| 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 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 queryfoobar.
.google.protobuf.Struct additional_attributes = 9;
| Name | Description |
| builderForValue | Builder |
| 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_typefield in your search request.
string asset_type = 2;
| Name | Description |
| value | StringThe assetType to set. |
| 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_typefield in your search request.
string asset_type = 2;
| Name | Description |
| value | ByteStringThe bytes for assetType to set. |
| 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;
| Name | Description |
| index | int |
| value | AttachedResource |
| 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;
| Name | Description |
| index | int |
| builderForValue | AttachedResource.Builder |
| 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"
- value in seconds since unix epoch. Example:
.google.protobuf.Timestamp create_time = 11;
| Name | Description |
| value | Timestamp |
| 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"
- value in seconds since unix epoch. Example:
.google.protobuf.Timestamp create_time = 11;
| Name | Description |
| builderForValue | Builder |
| 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;
| Name | Description |
| value | StringThe description to set. |
| 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;
| Name | Description |
| value | ByteStringThe bytes for description to set. |
| 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;
| Name | Description |
| value | StringThe displayName to set. |
| 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;
| Name | Description |
| value | ByteStringThe bytes for displayName to set. |
| Type | Description |
| ResourceSearchResult.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public ResourceSearchResult.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| ResourceSearchResult.Builder |
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
scopefield as this folder in your search request.
repeated string folders = 17;
| Name | Description |
| index | intThe index to set the value at. |
| value | StringThe folders to set. |
| Type | Description |
| ResourceSearchResult.Builder | This builder for chaining. |
setKmsKey(String value)
public ResourceSearchResult.Builder setKmsKey(String value) 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;
| Name | Description |
| value | StringThe kmsKey to set. |
| Type | Description |
| ResourceSearchResult.Builder | This builder for chaining. |
setKmsKeyBytes(ByteString value)
public ResourceSearchResult.Builder setKmsKeyBytes(ByteString value) 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;
| Name | Description |
| value | ByteStringThe bytes for kmsKey to set. |
| 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;
| Name | Description |
| value | StringThe location to set. |
| 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;
| Name | Description |
| value | ByteStringThe bytes for location to set. |
| 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;
| Name | Description |
| value | StringThe name to set. |
| 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;
| Name | Description |
| value | ByteStringThe bytes for name to set. |
| 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 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;
| Name | Description |
| index | intThe index to set the value at. |
| value | StringThe networkTags to set. |
| 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
scopefield as this organization in your search request.
string organization = 18;
| Name | Description |
| value | StringThe organization to set. |
| 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
scopefield as this organization in your search request.
string organization = 18;
| Name | Description |
| value | ByteStringThe bytes for organization to set. |
| 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;
| Name | Description |
| value | StringThe parentAssetType to set. |
| 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;
| Name | Description |
| value | ByteStringThe bytes for parentAssetType to set. |
| 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;
| Name | Description |
| value | StringThe parentFullResourceName to set. |
| 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;
| Name | Description |
| value | ByteStringThe bytes for parentFullResourceName to set. |
| 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
scopefield as this project in your search request.
string project = 3;
| Name | Description |
| value | StringThe project to set. |
| 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
scopefield as this project in your search request.
string project = 3;
| Name | Description |
| value | ByteStringThe bytes for project to set. |
| 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)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| ResourceSearchResult.Builder |
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 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;
| Name | Description |
| value | StringThe state to set. |
| 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 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;
| Name | Description |
| value | ByteStringThe bytes for state to set. |
| Type | Description |
| ResourceSearchResult.Builder | This builder for chaining. |
setTagKeys(int index, String value)
public ResourceSearchResult.Builder setTagKeys(int index, 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;
| Name | Description |
| index | intThe index to set the value at. |
| value | StringThe tagKeys to set. |
| Type | Description |
| ResourceSearchResult.Builder | This builder for chaining. |
setTagValueIds(int index, String value)
public ResourceSearchResult.Builder setTagValueIds(int index, 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;
| Name | Description |
| index | intThe index to set the value at. |
| value | StringThe tagValueIds to set. |
| Type | Description |
| ResourceSearchResult.Builder | This builder for chaining. |
setTagValues(int index, String value)
public ResourceSearchResult.Builder setTagValues(int index, 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;
| Name | Description |
| index | intThe index to set the value at. |
| value | StringThe tagValues to set. |
| Type | Description |
| ResourceSearchResult.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final ResourceSearchResult.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| ResourceSearchResult.Builder |
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"
- value in seconds since unix epoch. Example:
.google.protobuf.Timestamp update_time = 12;
| Name | Description |
| value | Timestamp |
| 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"
- value in seconds since unix epoch. Example:
.google.protobuf.Timestamp update_time = 12;
| Name | Description |
| builderForValue | Builder |
| 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;
| Name | Description |
| index | int |
| value | VersionedResource |
| 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;
| Name | Description |
| index | int |
| builderForValue | VersionedResource.Builder |
| Type | Description |
| ResourceSearchResult.Builder |