Interface ResourceSearchResultOrBuilder (3.2.17)

public interface ResourceSearchResultOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

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

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

map<string, string> labels = 7;

Parameter

Name	Description
key	`String`

Returns

Type	Description
boolean

containsRelationships(String key)

public abstract boolean containsRelationships(String key)

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

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

Parameter

Name	Description
key	`String`

Returns

Type	Description
boolean

getAdditionalAttributes()

public abstract Struct getAdditionalAttributes()

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

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

.google.protobuf.Struct additional_attributes = 9;

Returns

Type	Description
Struct	The additionalAttributes.

getAdditionalAttributesOrBuilder()

public abstract StructOrBuilder getAdditionalAttributesOrBuilder()

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

.google.protobuf.Struct additional_attributes = 9;

Returns

Type	Description
StructOrBuilder

getAssetType()

public abstract String getAssetType()

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

specify the asset_type field in your search request.

string asset_type = 2;

Returns

Type	Description
String	The assetType.

getAssetTypeBytes()

public abstract ByteString getAssetTypeBytes()

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

specify the asset_type field in your search request.

string asset_type = 2;

Returns

Type	Description
ByteString	The bytes for assetType.

getAttachedResources(int index)

public abstract AttachedResource getAttachedResources(int index)

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

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

Parameter

Name	Description
index	`int`

Returns

Type	Description
AttachedResource

getAttachedResourcesCount()

public abstract int getAttachedResourcesCount()

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

Returns

Type	Description
int

getAttachedResourcesList()

public abstract List<AttachedResource> getAttachedResourcesList()

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

Returns

Type	Description
List<AttachedResource>

getAttachedResourcesOrBuilder(int index)

public abstract AttachedResourceOrBuilder getAttachedResourcesOrBuilder(int index)

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

Parameter

Name	Description
index	`int`

Returns

Type	Description
AttachedResourceOrBuilder

getAttachedResourcesOrBuilderList()

public abstract List<? extends AttachedResourceOrBuilder> getAttachedResourcesOrBuilderList()

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

Returns

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

getCreateTime()

public abstract Timestamp getCreateTime()

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

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

.google.protobuf.Timestamp create_time = 11;

Returns

Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

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

.google.protobuf.Timestamp create_time = 11;

Returns

Type	Description
TimestampOrBuilder

getDescription()

public abstract String getDescription()

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

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

string description = 5;

Returns

Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

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

string description = 5;

Returns

Type	Description
ByteString	The bytes for description.

getDisplayName()

public abstract String getDisplayName()

The display name of this resource. This field is available only when the resource's proto contains it. To search against the display_name:

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

string display_name = 4;

Returns

Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

The display name of this resource. This field is available only when the resource's proto contains it. To search against the display_name:

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

string display_name = 4;

Returns

Type	Description
ByteString	The bytes for displayName.

getFolders(int index)

public abstract String getFolders(int index)

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

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

repeated string folders = 17;

Parameter

Name	Description
index	`int` The index of the element to return.

Returns

Type	Description
String	The folders at the given index.

getFoldersBytes(int index)

public abstract ByteString getFoldersBytes(int index)

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

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

repeated string folders = 17;

Parameter

Name	Description
index	`int` The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the folders at the given index.

getFoldersCount()

public abstract int getFoldersCount()

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

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

repeated string folders = 17;

Returns

Type	Description
int	The count of folders.

getFoldersList()

public abstract List<String> getFoldersList()

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

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

repeated string folders = 17;

Returns

Type	Description
List<String>	A list containing the folders.

getKmsKey()

public abstract String getKmsKey()

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

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

string kms_key = 10;

Returns

Type	Description
String	The kmsKey.

getKmsKeyBytes()

public abstract ByteString getKmsKeyBytes()

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

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

string kms_key = 10;

Returns

Type	Description
ByteString	The bytes for kmsKey.

getLabels()

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns

Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

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

map<string, string> labels = 7;

Returns

Type	Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

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

map<string, string> labels = 7;

Returns

Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

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

map<string, string> labels = 7;

Parameters

Name	Description
key	`String`
defaultValue	`String`

Returns

Type	Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

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

map<string, string> labels = 7;

Parameter

Name	Description
key	`String`

Returns

Type	Description
String

getLocation()

public abstract String getLocation()

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

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

string location = 6;

Returns

Type	Description
String	The location.

getLocationBytes()

public abstract ByteString getLocationBytes()

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

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

string location = 6;

Returns

Type	Description
ByteString	The bytes for location.

getName()

public abstract String getName()

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

use a field query. Example: name:instance1
use a free text query. Example: instance1

string name = 1;

Returns

Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

use a field query. Example: name:instance1
use a free text query. Example: instance1

string name = 1;

Returns

Type	Description
ByteString	The bytes for name.

getNetworkTags(int index)

public abstract String getNetworkTags(int index)

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

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

repeated string network_tags = 8;

Parameter

Name	Description
index	`int` The index of the element to return.

Returns

Type	Description
String	The networkTags at the given index.

getNetworkTagsBytes(int index)

public abstract ByteString getNetworkTagsBytes(int index)

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

repeated string network_tags = 8;

Parameter

Name	Description
index	`int` The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the networkTags at the given index.

getNetworkTagsCount()

public abstract int getNetworkTagsCount()

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

repeated string network_tags = 8;

Returns

Type	Description
int	The count of networkTags.

getNetworkTagsList()

public abstract List<String> getNetworkTagsList()

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

repeated string network_tags = 8;

Returns

Type	Description
List<String>	A list containing the networkTags.

getOrganization()

public abstract String getOrganization()

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

use a field query. Example: organization:123
use a free text query. Example: 123
specify the scope field as this organization in your search request.

string organization = 18;

Returns

Type	Description
String	The organization.

getOrganizationBytes()

public abstract ByteString getOrganizationBytes()

use a field query. Example: organization:123
use a free text query. Example: 123
specify the scope field as this organization in your search request.

string organization = 18;

Returns

Type	Description
ByteString	The bytes for organization.

getParentAssetType()

public abstract String getParentAssetType()

The type of this resource's immediate parent, if there is one. To search against the parent_asset_type:

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

string parent_asset_type = 103;

Returns

Type	Description
String	The parentAssetType.

getParentAssetTypeBytes()

public abstract ByteString getParentAssetTypeBytes()

The type of this resource's immediate parent, if there is one. To search against the parent_asset_type:

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

string parent_asset_type = 103;

Returns

Type	Description
ByteString	The bytes for parentAssetType.

getParentFullResourceName()

public abstract String getParentFullResourceName()

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

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

string parent_full_resource_name = 19;

Returns

Type	Description
String	The parentFullResourceName.

getParentFullResourceNameBytes()

public abstract ByteString getParentFullResourceNameBytes()

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

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

string parent_full_resource_name = 19;

Returns

Type	Description
ByteString	The bytes for parentFullResourceName.

getProject()

public abstract String getProject()

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

use a field query. Example: project:12345
use a free text query. Example: 12345
specify the scope field as this project in your search request.

string project = 3;

Returns

Type	Description
String	The project.

getProjectBytes()

public abstract ByteString getProjectBytes()

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

use a field query. Example: project:12345
use a free text query. Example: 12345
specify the scope field as this project in your search request.

string project = 3;

Returns

Type	Description
ByteString	The bytes for project.

getRelationships()

public abstract Map<String,RelatedResources> getRelationships()

Use #getRelationshipsMap() instead.

Returns

Type	Description
Map<String,RelatedResources>

getRelationshipsCount()

public abstract int getRelationshipsCount()

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

Returns

Type	Description
int

getRelationshipsMap()

public abstract Map<String,RelatedResources> getRelationshipsMap()

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

Returns

Type	Description
Map<String,RelatedResources>

getRelationshipsOrDefault(String key, RelatedResources defaultValue)

public abstract RelatedResources getRelationshipsOrDefault(String key, RelatedResources defaultValue)

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

Parameters

Name	Description
key	`String`
defaultValue	`RelatedResources`

Returns

Type	Description
RelatedResources

getRelationshipsOrThrow(String key)

public abstract RelatedResources getRelationshipsOrThrow(String key)

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

Parameter

Name	Description
key	`String`

Returns

Type	Description
RelatedResources

getState()

public abstract String getState()

The state of this resource. Different resources types have different state definitions that are mapped from various fields of different resource types. This field is available only when the resource's proto contains it. Example: If the resource is an instance provided by Compute Engine, its state will include PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. See status definition in API Reference. If the resource is a project provided by Cloud Resource Manager, its state will include LIFECYCLE_STATE_UNSPECIFIED, ACTIVE, DELETE_REQUESTED and DELETE_IN_PROGRESS. See lifecycleState definition in API Reference. To search against the state:

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

string state = 13;

Returns

Type	Description
String	The state.

getStateBytes()

public abstract ByteString getStateBytes()

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

string state = 13;

Returns

Type	Description
ByteString	The bytes for state.

getUpdateTime()

public abstract Timestamp getUpdateTime()

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

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

.google.protobuf.Timestamp update_time = 12;

Returns

Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

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

.google.protobuf.Timestamp update_time = 12;

Returns

Type	Description
TimestampOrBuilder

getVersionedResources(int index)

public abstract VersionedResource getVersionedResources(int index)

Versioned resource representations of this resource. This is repeated because there could be multiple versions of resource representations during version migration. This versioned_resources field is not searchable. Some attributes of the resource representations are exposed in additional_attributes field, so as to allow users to search on them.

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

Parameter

Name	Description
index	`int`

Returns

Type	Description
VersionedResource

getVersionedResourcesCount()

public abstract int getVersionedResourcesCount()

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

Returns

Type	Description
int

getVersionedResourcesList()

public abstract List<VersionedResource> getVersionedResourcesList()

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

Returns

Type	Description
List<VersionedResource>

getVersionedResourcesOrBuilder(int index)

public abstract VersionedResourceOrBuilder getVersionedResourcesOrBuilder(int index)

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

Parameter

Name	Description
index	`int`

Returns

Type	Description
VersionedResourceOrBuilder

getVersionedResourcesOrBuilderList()

public abstract List<? extends VersionedResourceOrBuilder> getVersionedResourcesOrBuilderList()

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

Returns

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

hasAdditionalAttributes()

public abstract boolean hasAdditionalAttributes()

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

.google.protobuf.Struct additional_attributes = 9;

Returns

Type	Description
boolean	Whether the additionalAttributes field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

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

.google.protobuf.Timestamp create_time = 11;

Returns

Type	Description
boolean	Whether the createTime field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

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

.google.protobuf.Timestamp update_time = 12;

Returns

Type	Description
boolean	Whether the updateTime field is set.