public final class ResourceSearchResult extends GeneratedMessageV3 implements ResourceSearchResultOrBuilderA result of Resource Search, containing information of a cloud resource.
Protobuf type google.cloud.asset.v1.ResourceSearchResult
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ResourceSearchResultImplements
ResourceSearchResultOrBuilderStatic Fields
ADDITIONAL_ATTRIBUTES_FIELD_NUMBER
public static final int ADDITIONAL_ATTRIBUTES_FIELD_NUMBER| Type | Description |
| int |
ASSET_TYPE_FIELD_NUMBER
public static final int ASSET_TYPE_FIELD_NUMBER| Type | Description |
| int |
ATTACHED_RESOURCES_FIELD_NUMBER
public static final int ATTACHED_RESOURCES_FIELD_NUMBER| Type | Description |
| int |
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER| Type | Description |
| int |
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER| Type | Description |
| int |
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER| Type | Description |
| int |
FOLDERS_FIELD_NUMBER
public static final int FOLDERS_FIELD_NUMBER| Type | Description |
| int |
KMS_KEY_FIELD_NUMBER
public static final int KMS_KEY_FIELD_NUMBER| Type | Description |
| int |
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER| Type | Description |
| int |
LOCATION_FIELD_NUMBER
public static final int LOCATION_FIELD_NUMBER| Type | Description |
| int |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER| Type | Description |
| int |
NETWORK_TAGS_FIELD_NUMBER
public static final int NETWORK_TAGS_FIELD_NUMBER| Type | Description |
| int |
ORGANIZATION_FIELD_NUMBER
public static final int ORGANIZATION_FIELD_NUMBER| Type | Description |
| int |
PARENT_ASSET_TYPE_FIELD_NUMBER
public static final int PARENT_ASSET_TYPE_FIELD_NUMBER| Type | Description |
| int |
PARENT_FULL_RESOURCE_NAME_FIELD_NUMBER
public static final int PARENT_FULL_RESOURCE_NAME_FIELD_NUMBER| Type | Description |
| int |
PROJECT_FIELD_NUMBER
public static final int PROJECT_FIELD_NUMBER| Type | Description |
| int |
RELATIONSHIPS_FIELD_NUMBER
public static final int RELATIONSHIPS_FIELD_NUMBER| Type | Description |
| int |
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER| Type | Description |
| int |
TAG_KEYS_FIELD_NUMBER
public static final int TAG_KEYS_FIELD_NUMBER| Type | Description |
| int |
TAG_VALUES_FIELD_NUMBER
public static final int TAG_VALUES_FIELD_NUMBER| Type | Description |
| int |
TAG_VALUE_IDS_FIELD_NUMBER
public static final int TAG_VALUE_IDS_FIELD_NUMBER| Type | Description |
| int |
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER| Type | Description |
| int |
VERSIONED_RESOURCES_FIELD_NUMBER
public static final int VERSIONED_RESOURCES_FIELD_NUMBER| Type | Description |
| int |
Static Methods
getDefaultInstance()
public static ResourceSearchResult getDefaultInstance()| Type | Description |
| ResourceSearchResult |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
newBuilder()
public static ResourceSearchResult.Builder newBuilder()| Type | Description |
| ResourceSearchResult.Builder |
newBuilder(ResourceSearchResult prototype)
public static ResourceSearchResult.Builder newBuilder(ResourceSearchResult prototype)| Name | Description |
| prototype | ResourceSearchResult |
| Type | Description |
| ResourceSearchResult.Builder |
parseDelimitedFrom(InputStream input)
public static ResourceSearchResult parseDelimitedFrom(InputStream input)| Name | Description |
| input | InputStream |
| Type | Description |
| ResourceSearchResult |
| Type | Description |
| IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ResourceSearchResult parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | InputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ResourceSearchResult |
| Type | Description |
| IOException |
parseFrom(byte[] data)
public static ResourceSearchResult parseFrom(byte[] data)| Name | Description |
| data | byte[] |
| Type | Description |
| ResourceSearchResult |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ResourceSearchResult parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | byte[] |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ResourceSearchResult |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteString data)
public static ResourceSearchResult parseFrom(ByteString data)| Name | Description |
| data | ByteString |
| Type | Description |
| ResourceSearchResult |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ResourceSearchResult parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | ByteString |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ResourceSearchResult |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static ResourceSearchResult parseFrom(CodedInputStream input)| Name | Description |
| input | CodedInputStream |
| Type | Description |
| ResourceSearchResult |
| Type | Description |
| IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ResourceSearchResult parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ResourceSearchResult |
| Type | Description |
| IOException |
parseFrom(InputStream input)
public static ResourceSearchResult parseFrom(InputStream input)| Name | Description |
| input | InputStream |
| Type | Description |
| ResourceSearchResult |
| Type | Description |
| IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ResourceSearchResult parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | InputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ResourceSearchResult |
| Type | Description |
| IOException |
parseFrom(ByteBuffer data)
public static ResourceSearchResult parseFrom(ByteBuffer data)| Name | Description |
| data | ByteBuffer |
| Type | Description |
| ResourceSearchResult |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ResourceSearchResult parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | ByteBuffer |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ResourceSearchResult |
| Type | Description |
| InvalidProtocolBufferException |
parser()
public static Parser<ResourceSearchResult> parser()| Type | Description |
| Parser<ResourceSearchResult> |
Methods
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 |
equals(Object obj)
public boolean equals(Object obj)| Name | Description |
| obj | Object |
| 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. |
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 |
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. |
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. |
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. |
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. |
getParserForType()
public Parser<ResourceSearchResult> getParserForType()| Type | Description |
| Parser<ResourceSearchResult> |
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 |
getSerializedSize()
public int getSerializedSize()| Type | Description |
| int |
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. |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()| Type | Description |
| UnknownFieldSet |
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. |
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 |
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. |
hashCode()
public int hashCode()| Type | Description |
| int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)| Name | Description |
| number | int |
| Type | Description |
| MapField |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
newBuilderForType()
public ResourceSearchResult.Builder newBuilderForType()| Type | Description |
| ResourceSearchResult.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ResourceSearchResult.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Name | Description |
| parent | BuilderParent |
| Type | Description |
| ResourceSearchResult.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Name | Description |
| unused | UnusedPrivateParameter |
| Type | Description |
| Object |
toBuilder()
public ResourceSearchResult.Builder toBuilder()| Type | Description |
| ResourceSearchResult.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Name | Description |
| output | CodedOutputStream |
| Type | Description |
| IOException |