Package com.google.cloud.asset.v1
Interface ResourceSearchResultOrBuilder
-
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
ResourceSearchResult
,ResourceSearchResult.Builder
public interface ResourceSearchResultOrBuilder extends com.google.protobuf.MessageOrBuilder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description boolean
containsLabels(String key)
Labels associated with this resource.boolean
containsRelationships(String key)
A map of related resources of this resource, keyed by the relationship type.com.google.protobuf.Struct
getAdditionalAttributes()
The additional searchable attributes of this resource.com.google.protobuf.StructOrBuilder
getAdditionalAttributesOrBuilder()
The additional searchable attributes of this resource.String
getAssetType()
The type of this resource.com.google.protobuf.ByteString
getAssetTypeBytes()
The type of this resource.AttachedResource
getAttachedResources(int index)
Attached resources of this resource.int
getAttachedResourcesCount()
Attached resources of this resource.List<AttachedResource>
getAttachedResourcesList()
Attached resources of this resource.AttachedResourceOrBuilder
getAttachedResourcesOrBuilder(int index)
Attached resources of this resource.List<? extends AttachedResourceOrBuilder>
getAttachedResourcesOrBuilderList()
Attached resources of this resource.com.google.protobuf.Timestamp
getCreateTime()
The create timestamp of this resource, at which the resource was created.com.google.protobuf.TimestampOrBuilder
getCreateTimeOrBuilder()
The create timestamp of this resource, at which the resource was created.String
getDescription()
One or more paragraphs of text description of this resource.com.google.protobuf.ByteString
getDescriptionBytes()
One or more paragraphs of text description of this resource.String
getDisplayName()
The display name of this resource.com.google.protobuf.ByteString
getDisplayNameBytes()
The display name of this resource.String
getFolders(int index)
The folder(s) that this resource belongs to, in the form of folders/{FOLDER_NUMBER}.com.google.protobuf.ByteString
getFoldersBytes(int index)
The folder(s) that this resource belongs to, in the form of folders/{FOLDER_NUMBER}.int
getFoldersCount()
The folder(s) that this resource belongs to, in the form of folders/{FOLDER_NUMBER}.List<String>
getFoldersList()
The folder(s) that this resource belongs to, in the form of folders/{FOLDER_NUMBER}.String
getKmsKey()
Deprecated.google.cloud.asset.v1.ResourceSearchResult.kms_key is deprecated.com.google.protobuf.ByteString
getKmsKeyBytes()
Deprecated.google.cloud.asset.v1.ResourceSearchResult.kms_key is deprecated.String
getKmsKeys(int index)
The Cloud KMS [CryptoKey](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys) names or [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions) names.com.google.protobuf.ByteString
getKmsKeysBytes(int index)
The Cloud KMS [CryptoKey](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys) names or [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions) names.int
getKmsKeysCount()
The Cloud KMS [CryptoKey](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys) names or [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions) names.List<String>
getKmsKeysList()
The Cloud KMS [CryptoKey](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys) names or [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions) names.Map<String,String>
getLabels()
Deprecated.int
getLabelsCount()
Labels associated with this resource.Map<String,String>
getLabelsMap()
Labels associated with this resource.String
getLabelsOrDefault(String key, String defaultValue)
Labels associated with this resource.String
getLabelsOrThrow(String key)
Labels associated with this resource.String
getLocation()
Location can be `global`, regional like `us-east1`, or zonal like `us-west1-b`.com.google.protobuf.ByteString
getLocationBytes()
Location can be `global`, regional like `us-east1`, or zonal like `us-west1-b`.String
getName()
The full resource name of this resource.com.google.protobuf.ByteString
getNameBytes()
The full resource name of this resource.String
getNetworkTags(int index)
Network tags associated with this resource.com.google.protobuf.ByteString
getNetworkTagsBytes(int index)
Network tags associated with this resource.int
getNetworkTagsCount()
Network tags associated with this resource.List<String>
getNetworkTagsList()
Network tags associated with this resource.String
getOrganization()
The organization that this resource belongs to, in the form of organizations/{ORGANIZATION_NUMBER}.com.google.protobuf.ByteString
getOrganizationBytes()
The organization that this resource belongs to, in the form of organizations/{ORGANIZATION_NUMBER}.String
getParentAssetType()
The type of this resource's immediate parent, if there is one.com.google.protobuf.ByteString
getParentAssetTypeBytes()
The type of this resource's immediate parent, if there is one.String
getParentFullResourceName()
The full resource name of this resource's parent, if it has one.com.google.protobuf.ByteString
getParentFullResourceNameBytes()
The full resource name of this resource's parent, if it has one.String
getProject()
The project that this resource belongs to, in the form of projects/{PROJECT_NUMBER}.com.google.protobuf.ByteString
getProjectBytes()
The project that this resource belongs to, in the form of projects/{PROJECT_NUMBER}.Map<String,RelatedResources>
getRelationships()
Deprecated.int
getRelationshipsCount()
A map of related resources of this resource, keyed by the relationship type.Map<String,RelatedResources>
getRelationshipsMap()
A map of related resources of this resource, keyed by the relationship type.RelatedResources
getRelationshipsOrDefault(String key, RelatedResources defaultValue)
A map of related resources of this resource, keyed by the relationship type.RelatedResources
getRelationshipsOrThrow(String key)
A map of related resources of this resource, keyed by the relationship type.String
getState()
The state of this resource.com.google.protobuf.ByteString
getStateBytes()
The state of this resource.String
getTagKeys(int index)
TagKey namespaced names, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}.com.google.protobuf.ByteString
getTagKeysBytes(int index)
TagKey namespaced names, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}.int
getTagKeysCount()
TagKey namespaced names, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}.List<String>
getTagKeysList()
TagKey namespaced names, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}.String
getTagValueIds(int index)
TagValue IDs, in the format of tagValues/{TAG_VALUE_ID}.com.google.protobuf.ByteString
getTagValueIdsBytes(int index)
TagValue IDs, in the format of tagValues/{TAG_VALUE_ID}.int
getTagValueIdsCount()
TagValue IDs, in the format of tagValues/{TAG_VALUE_ID}.List<String>
getTagValueIdsList()
TagValue IDs, in the format of tagValues/{TAG_VALUE_ID}.String
getTagValues(int index)
TagValue namespaced names, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}/{TAG_VALUE_SHORT_NAME}.com.google.protobuf.ByteString
getTagValuesBytes(int index)
TagValue namespaced names, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}/{TAG_VALUE_SHORT_NAME}.int
getTagValuesCount()
TagValue namespaced names, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}/{TAG_VALUE_SHORT_NAME}.List<String>
getTagValuesList()
TagValue namespaced names, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}/{TAG_VALUE_SHORT_NAME}.com.google.protobuf.Timestamp
getUpdateTime()
The last update timestamp of this resource, at which the resource was last modified or deleted.com.google.protobuf.TimestampOrBuilder
getUpdateTimeOrBuilder()
The last update timestamp of this resource, at which the resource was last modified or deleted.VersionedResource
getVersionedResources(int index)
Versioned resource representations of this resource.int
getVersionedResourcesCount()
Versioned resource representations of this resource.List<VersionedResource>
getVersionedResourcesList()
Versioned resource representations of this resource.VersionedResourceOrBuilder
getVersionedResourcesOrBuilder(int index)
Versioned resource representations of this resource.List<? extends VersionedResourceOrBuilder>
getVersionedResourcesOrBuilderList()
Versioned resource representations of this resource.boolean
hasAdditionalAttributes()
The additional searchable attributes of this resource.boolean
hasCreateTime()
The create timestamp of this resource, at which the resource was created.boolean
hasUpdateTime()
The last update timestamp of this resource, at which the resource was last modified or deleted.-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
getName
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](https://cloud.google.com/asset-inventory/docs/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:
- The name.
-
getNameBytes
com.google.protobuf.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](https://cloud.google.com/asset-inventory/docs/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:
- The bytes for name.
-
getAssetType
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:
- The assetType.
-
getAssetTypeBytes
com.google.protobuf.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:
- The bytes for assetType.
-
getProject
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:
- The project.
-
getProjectBytes
com.google.protobuf.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:
- The bytes for project.
-
getFoldersList
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:
- A list containing the folders.
-
getFoldersCount
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:
- The count of folders.
-
getFolders
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;
- Parameters:
index
- The index of the element to return.- Returns:
- The folders at the given index.
-
getFoldersBytes
com.google.protobuf.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;
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the folders at the given index.
-
getOrganization
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:
- The organization.
-
getOrganizationBytes
com.google.protobuf.ByteString getOrganizationBytes()
The organization that this resource belongs to, in the form of organizations/{ORGANIZATION_NUMBER}. This field is available when the resource belongs to an organization. To search against `organization`: * Use a field query. Example: `organization:123` * Use a free text query. Example: `123` * Specify the `scope` field as this organization in your search request.
string organization = 18;
- Returns:
- The bytes for organization.
-
getDisplayName
String getDisplayName()
The display name of this resource. This field is available only when the resource's Protobuf contains it. To search against the `display_name`: * Use a field query. Example: `displayName:"My Instance"` * Use a free text query. Example: `"My Instance"`
string display_name = 4;
- Returns:
- The displayName.
-
getDisplayNameBytes
com.google.protobuf.ByteString getDisplayNameBytes()
The display name of this resource. This field is available only when the resource's Protobuf contains it. To search against the `display_name`: * Use a field query. Example: `displayName:"My Instance"` * Use a free text query. Example: `"My Instance"`
string display_name = 4;
- Returns:
- The bytes for displayName.
-
getDescription
String getDescription()
One or more paragraphs of text description of this resource. Maximum length could be up to 1M bytes. This field is available only when the resource's Protobuf contains it. To search against the `description`: * Use a field query. Example: `description:"important instance"` * Use a free text query. Example: `"important instance"`
string description = 5;
- Returns:
- The description.
-
getDescriptionBytes
com.google.protobuf.ByteString getDescriptionBytes()
One or more paragraphs of text description of this resource. Maximum length could be up to 1M bytes. This field is available only when the resource's Protobuf contains it. To search against the `description`: * Use a field query. Example: `description:"important instance"` * Use a free text query. Example: `"important instance"`
string description = 5;
- Returns:
- The bytes for description.
-
getLocation
String getLocation()
Location can be `global`, regional like `us-east1`, or zonal like `us-west1-b`. This field is available only when the resource's Protobuf contains it. To search against the `location`: * Use a field query. Example: `location:us-west*` * Use a free text query. Example: `us-west*`
string location = 6;
- Returns:
- The location.
-
getLocationBytes
com.google.protobuf.ByteString getLocationBytes()
Location can be `global`, regional like `us-east1`, or zonal like `us-west1-b`. This field is available only when the resource's Protobuf contains it. To search against the `location`: * Use a field query. Example: `location:us-west*` * Use a free text query. Example: `us-west*`
string location = 6;
- Returns:
- The bytes for location.
-
getLabelsCount
int getLabelsCount()
Labels associated with this resource. See [Labelling and grouping Google Cloud resources](https://cloud.google.com/blog/products/gcp/labelling-and-grouping-your-google-cloud-platform-resources) for more information. This field is available only when the resource's Protobuf contains it. To search against the `labels`: * Use a field query: - query on any label's key or value. Example: `labels:prod` - query by a given label. Example: `labels.env:prod` - query by a given label's existence. Example: `labels.env:*` * Use a free text query. Example: `prod`
map<string, string> labels = 7;
-
containsLabels
boolean containsLabels(String key)
Labels associated with this resource. See [Labelling and grouping Google Cloud resources](https://cloud.google.com/blog/products/gcp/labelling-and-grouping-your-google-cloud-platform-resources) for more information. This field is available only when the resource's Protobuf contains it. To search against the `labels`: * Use a field query: - query on any label's key or value. Example: `labels:prod` - query by a given label. Example: `labels.env:prod` - query by a given label's existence. Example: `labels.env:*` * Use a free text query. Example: `prod`
map<string, string> labels = 7;
-
getLabels
@Deprecated Map<String,String> getLabels()
Deprecated.UsegetLabelsMap()
instead.
-
getLabelsMap
Map<String,String> getLabelsMap()
Labels associated with this resource. See [Labelling and grouping Google Cloud resources](https://cloud.google.com/blog/products/gcp/labelling-and-grouping-your-google-cloud-platform-resources) for more information. This field is available only when the resource's Protobuf contains it. To search against the `labels`: * Use a field query: - query on any label's key or value. Example: `labels:prod` - query by a given label. Example: `labels.env:prod` - query by a given label's existence. Example: `labels.env:*` * Use a free text query. Example: `prod`
map<string, string> labels = 7;
-
getLabelsOrDefault
String getLabelsOrDefault(String key, String defaultValue)
Labels associated with this resource. See [Labelling and grouping Google Cloud resources](https://cloud.google.com/blog/products/gcp/labelling-and-grouping-your-google-cloud-platform-resources) for more information. This field is available only when the resource's Protobuf contains it. To search against the `labels`: * Use a field query: - query on any label's key or value. Example: `labels:prod` - query by a given label. Example: `labels.env:prod` - query by a given label's existence. Example: `labels.env:*` * Use a free text query. Example: `prod`
map<string, string> labels = 7;
-
getLabelsOrThrow
String getLabelsOrThrow(String key)
Labels associated with this resource. See [Labelling and grouping Google Cloud resources](https://cloud.google.com/blog/products/gcp/labelling-and-grouping-your-google-cloud-platform-resources) for more information. This field is available only when the resource's Protobuf contains it. To search against the `labels`: * Use a field query: - query on any label's key or value. Example: `labels:prod` - query by a given label. Example: `labels.env:prod` - query by a given label's existence. Example: `labels.env:*` * Use a free text query. Example: `prod`
map<string, string> labels = 7;
-
getNetworkTagsList
List<String> getNetworkTagsList()
Network tags associated with this resource. Like labels, network tags are a type of annotations used to group Google Cloud resources. See [Labelling Google Cloud resources](https://cloud.google.com/blog/products/gcp/labelling-and-grouping-your-google-cloud-platform-resources) for more information. This field is available only when the resource's Protobuf contains it. To search against the `network_tags`: * Use a field query. Example: `networkTags:internal` * Use a free text query. Example: `internal`
repeated string network_tags = 8;
- Returns:
- A list containing the networkTags.
-
getNetworkTagsCount
int getNetworkTagsCount()
Network tags associated with this resource. Like labels, network tags are a type of annotations used to group Google Cloud resources. See [Labelling Google Cloud resources](https://cloud.google.com/blog/products/gcp/labelling-and-grouping-your-google-cloud-platform-resources) for more information. This field is available only when the resource's Protobuf contains it. To search against the `network_tags`: * Use a field query. Example: `networkTags:internal` * Use a free text query. Example: `internal`
repeated string network_tags = 8;
- Returns:
- The count of networkTags.
-
getNetworkTags
String getNetworkTags(int index)
Network tags associated with this resource. Like labels, network tags are a type of annotations used to group Google Cloud resources. See [Labelling Google Cloud resources](https://cloud.google.com/blog/products/gcp/labelling-and-grouping-your-google-cloud-platform-resources) for more information. This field is available only when the resource's Protobuf contains it. To search against the `network_tags`: * Use a field query. Example: `networkTags:internal` * Use a free text query. Example: `internal`
repeated string network_tags = 8;
- Parameters:
index
- The index of the element to return.- Returns:
- The networkTags at the given index.
-
getNetworkTagsBytes
com.google.protobuf.ByteString getNetworkTagsBytes(int index)
Network tags associated with this resource. Like labels, network tags are a type of annotations used to group Google Cloud resources. See [Labelling Google Cloud resources](https://cloud.google.com/blog/products/gcp/labelling-and-grouping-your-google-cloud-platform-resources) for more information. This field is available only when the resource's Protobuf contains it. To search against the `network_tags`: * Use a field query. Example: `networkTags:internal` * Use a free text query. Example: `internal`
repeated string network_tags = 8;
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the networkTags at the given index.
-
getKmsKey
@Deprecated String getKmsKey()
Deprecated.google.cloud.asset.v1.ResourceSearchResult.kms_key is deprecated. See google/cloud/asset/v1/assets.proto;l=437The Cloud KMS [CryptoKey](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys) name or [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions) name. This field only presents for the purpose of backward compatibility. Please use the `kms_keys` field to retrieve Cloud KMS key information. This field is available only when the resource's Protobuf contains it and will only be populated for [these resource types](https://cloud.google.com/asset-inventory/docs/legacy-field-names#resource_types_with_the_to_be_deprecated_kmskey_field) for backward compatible purposes. To search against the `kms_key`: * Use a field query. Example: `kmsKey:key` * Use a free text query. Example: `key`
string kms_key = 10 [deprecated = true];
- Returns:
- The kmsKey.
-
getKmsKeyBytes
@Deprecated com.google.protobuf.ByteString getKmsKeyBytes()
Deprecated.google.cloud.asset.v1.ResourceSearchResult.kms_key is deprecated. See google/cloud/asset/v1/assets.proto;l=437The Cloud KMS [CryptoKey](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys) name or [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions) name. This field only presents for the purpose of backward compatibility. Please use the `kms_keys` field to retrieve Cloud KMS key information. This field is available only when the resource's Protobuf contains it and will only be populated for [these resource types](https://cloud.google.com/asset-inventory/docs/legacy-field-names#resource_types_with_the_to_be_deprecated_kmskey_field) for backward compatible purposes. To search against the `kms_key`: * Use a field query. Example: `kmsKey:key` * Use a free text query. Example: `key`
string kms_key = 10 [deprecated = true];
- Returns:
- The bytes for kmsKey.
-
getKmsKeysList
List<String> getKmsKeysList()
The Cloud KMS [CryptoKey](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys) names or [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions) names. This field is available only when the resource's Protobuf contains it. To search against the `kms_keys`: * Use a field query. Example: `kmsKeys:key` * Use a free text query. Example: `key`
repeated string kms_keys = 28;
- Returns:
- A list containing the kmsKeys.
-
getKmsKeysCount
int getKmsKeysCount()
The Cloud KMS [CryptoKey](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys) names or [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions) names. This field is available only when the resource's Protobuf contains it. To search against the `kms_keys`: * Use a field query. Example: `kmsKeys:key` * Use a free text query. Example: `key`
repeated string kms_keys = 28;
- Returns:
- The count of kmsKeys.
-
getKmsKeys
String getKmsKeys(int index)
The Cloud KMS [CryptoKey](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys) names or [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions) names. This field is available only when the resource's Protobuf contains it. To search against the `kms_keys`: * Use a field query. Example: `kmsKeys:key` * Use a free text query. Example: `key`
repeated string kms_keys = 28;
- Parameters:
index
- The index of the element to return.- Returns:
- The kmsKeys at the given index.
-
getKmsKeysBytes
com.google.protobuf.ByteString getKmsKeysBytes(int index)
The Cloud KMS [CryptoKey](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys) names or [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions) names. This field is available only when the resource's Protobuf contains it. To search against the `kms_keys`: * Use a field query. Example: `kmsKeys:key` * Use a free text query. Example: `key`
repeated string kms_keys = 28;
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the kmsKeys at the given index.
-
hasCreateTime
boolean hasCreateTime()
The create timestamp of this resource, at which the resource was created. The granularity is in seconds. Timestamp.nanos will always be 0. This field is available only when the resource's Protobuf contains it. To search against `create_time`: * Use a field query. - value in seconds since unix epoch. Example: `createTime > 1609459200` - value in date string. Example: `createTime > 2021-01-01` - value in date-time string (must be quoted). Example: `createTime > "2021-01-01T00:00:00"`
.google.protobuf.Timestamp create_time = 11;
- Returns:
- Whether the createTime field is set.
-
getCreateTime
com.google.protobuf.Timestamp getCreateTime()
The create timestamp of this resource, at which the resource was created. The granularity is in seconds. Timestamp.nanos will always be 0. This field is available only when the resource's Protobuf contains it. To search against `create_time`: * Use a field query. - value in seconds since unix epoch. Example: `createTime > 1609459200` - value in date string. Example: `createTime > 2021-01-01` - value in date-time string (must be quoted). Example: `createTime > "2021-01-01T00:00:00"`
.google.protobuf.Timestamp create_time = 11;
- Returns:
- The createTime.
-
getCreateTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
The create timestamp of this resource, at which the resource was created. The granularity is in seconds. Timestamp.nanos will always be 0. This field is available only when the resource's Protobuf contains it. To search against `create_time`: * Use a field query. - value in seconds since unix epoch. Example: `createTime > 1609459200` - value in date string. Example: `createTime > 2021-01-01` - value in date-time string (must be quoted). Example: `createTime > "2021-01-01T00:00:00"`
.google.protobuf.Timestamp create_time = 11;
-
hasUpdateTime
boolean hasUpdateTime()
The last update timestamp of this resource, at which the resource was last modified or deleted. The granularity is in seconds. Timestamp.nanos will always be 0. This field is available only when the resource's Protobuf contains it. To search against `update_time`: * Use a field query. - value in seconds since unix epoch. Example: `updateTime < 1609459200` - value in date string. Example: `updateTime < 2021-01-01` - value in date-time string (must be quoted). Example: `updateTime < "2021-01-01T00:00:00"`
.google.protobuf.Timestamp update_time = 12;
- Returns:
- Whether the updateTime field is set.
-
getUpdateTime
com.google.protobuf.Timestamp getUpdateTime()
The last update timestamp of this resource, at which the resource was last modified or deleted. The granularity is in seconds. Timestamp.nanos will always be 0. This field is available only when the resource's Protobuf contains it. To search against `update_time`: * Use a field query. - value in seconds since unix epoch. Example: `updateTime < 1609459200` - value in date string. Example: `updateTime < 2021-01-01` - value in date-time string (must be quoted). Example: `updateTime < "2021-01-01T00:00:00"`
.google.protobuf.Timestamp update_time = 12;
- Returns:
- The updateTime.
-
getUpdateTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
The last update timestamp of this resource, at which the resource was last modified or deleted. The granularity is in seconds. Timestamp.nanos will always be 0. This field is available only when the resource's Protobuf contains it. To search against `update_time`: * Use a field query. - value in seconds since unix epoch. Example: `updateTime < 1609459200` - value in date string. Example: `updateTime < 2021-01-01` - value in date-time string (must be quoted). Example: `updateTime < "2021-01-01T00:00:00"`
.google.protobuf.Timestamp update_time = 12;
-
getState
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](https://cloud.google.com/compute/docs/reference/rest/v1/instances). If the resource is a project provided by Resource Manager, its state will include LIFECYCLE_STATE_UNSPECIFIED, ACTIVE, DELETE_REQUESTED and DELETE_IN_PROGRESS. See `lifecycleState` definition in [API Reference](https://cloud.google.com/resource-manager/reference/rest/v1/projects). To search against the `state`: * Use a field query. Example: `state:RUNNING` * Use a free text query. Example: `RUNNING`
string state = 13;
- Returns:
- The state.
-
getStateBytes
com.google.protobuf.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](https://cloud.google.com/compute/docs/reference/rest/v1/instances). If the resource is a project provided by Resource Manager, its state will include LIFECYCLE_STATE_UNSPECIFIED, ACTIVE, DELETE_REQUESTED and DELETE_IN_PROGRESS. See `lifecycleState` definition in [API Reference](https://cloud.google.com/resource-manager/reference/rest/v1/projects). To search against the `state`: * Use a field query. Example: `state:RUNNING` * Use a free text query. Example: `RUNNING`
string state = 13;
- Returns:
- The bytes for state.
-
hasAdditionalAttributes
boolean hasAdditionalAttributes()
The additional searchable attributes of this resource. The attributes may vary from one resource type to another. Examples: `projectId` for Project, `dnsName` for DNS ManagedZone. This field contains a subset of the resource metadata fields that are returned by the List or Get APIs provided by the corresponding Google Cloud service (e.g., Compute Engine). see [API references and supported searchable attributes](https://cloud.google.com/asset-inventory/docs/supported-asset-types#searchable_asset_types) to see which fields are included. You can search values of these fields through free text search. However, you should not consume the field programically as the field names and values may change as the Google Cloud service updates to a new incompatible API version. To search against the `additional_attributes`: * Use a free text query to match the attributes values. Example: to search `additional_attributes = { dnsName: "foobar" }`, you can issue a query `foobar`.
.google.protobuf.Struct additional_attributes = 9;
- Returns:
- Whether the additionalAttributes field is set.
-
getAdditionalAttributes
com.google.protobuf.Struct getAdditionalAttributes()
The additional searchable attributes of this resource. The attributes may vary from one resource type to another. Examples: `projectId` for Project, `dnsName` for DNS ManagedZone. This field contains a subset of the resource metadata fields that are returned by the List or Get APIs provided by the corresponding Google Cloud service (e.g., Compute Engine). see [API references and supported searchable attributes](https://cloud.google.com/asset-inventory/docs/supported-asset-types#searchable_asset_types) to see which fields are included. You can search values of these fields through free text search. However, you should not consume the field programically as the field names and values may change as the Google Cloud service updates to a new incompatible API version. To search against the `additional_attributes`: * Use a free text query to match the attributes values. Example: to search `additional_attributes = { dnsName: "foobar" }`, you can issue a query `foobar`.
.google.protobuf.Struct additional_attributes = 9;
- Returns:
- The additionalAttributes.
-
getAdditionalAttributesOrBuilder
com.google.protobuf.StructOrBuilder getAdditionalAttributesOrBuilder()
The additional searchable attributes of this resource. The attributes may vary from one resource type to another. Examples: `projectId` for Project, `dnsName` for DNS ManagedZone. This field contains a subset of the resource metadata fields that are returned by the List or Get APIs provided by the corresponding Google Cloud service (e.g., Compute Engine). see [API references and supported searchable attributes](https://cloud.google.com/asset-inventory/docs/supported-asset-types#searchable_asset_types) to see which fields are included. You can search values of these fields through free text search. However, you should not consume the field programically as the field names and values may change as the Google Cloud service updates to a new incompatible API version. To search against the `additional_attributes`: * Use a free text query to match the attributes values. Example: to search `additional_attributes = { dnsName: "foobar" }`, you can issue a query `foobar`.
.google.protobuf.Struct additional_attributes = 9;
-
getParentFullResourceName
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:
- The parentFullResourceName.
-
getParentFullResourceNameBytes
com.google.protobuf.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:
- The bytes for parentFullResourceName.
-
getVersionedResourcesList
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;
-
getVersionedResources
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;
-
getVersionedResourcesCount
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;
-
getVersionedResourcesOrBuilderList
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;
-
getVersionedResourcesOrBuilder
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;
-
getAttachedResourcesList
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;
-
getAttachedResources
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;
-
getAttachedResourcesCount
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;
-
getAttachedResourcesOrBuilderList
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;
-
getAttachedResourcesOrBuilder
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;
-
getRelationshipsCount
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](https://cloud.google.com/asset-inventory/docs/supported-asset-types#supported_relationship_types).
map<string, .google.cloud.asset.v1.RelatedResources> relationships = 21;
-
containsRelationships
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](https://cloud.google.com/asset-inventory/docs/supported-asset-types#supported_relationship_types).
map<string, .google.cloud.asset.v1.RelatedResources> relationships = 21;
-
getRelationships
@Deprecated Map<String,RelatedResources> getRelationships()
Deprecated.UsegetRelationshipsMap()
instead.
-
getRelationshipsMap
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](https://cloud.google.com/asset-inventory/docs/supported-asset-types#supported_relationship_types).
map<string, .google.cloud.asset.v1.RelatedResources> relationships = 21;
-
getRelationshipsOrDefault
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](https://cloud.google.com/asset-inventory/docs/supported-asset-types#supported_relationship_types).
map<string, .google.cloud.asset.v1.RelatedResources> relationships = 21;
-
getRelationshipsOrThrow
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](https://cloud.google.com/asset-inventory/docs/supported-asset-types#supported_relationship_types).
map<string, .google.cloud.asset.v1.RelatedResources> relationships = 21;
-
getTagKeysList
List<String> 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;
- Returns:
- A list containing the tagKeys.
-
getTagKeysCount
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;
- Returns:
- The count of tagKeys.
-
getTagKeys
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;
- Parameters:
index
- The index of the element to return.- Returns:
- The tagKeys at the given index.
-
getTagKeysBytes
com.google.protobuf.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;
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the tagKeys at the given index.
-
getTagValuesList
List<String> 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;
- Returns:
- A list containing the tagValues.
-
getTagValuesCount
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;
- Returns:
- The count of tagValues.
-
getTagValues
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;
- Parameters:
index
- The index of the element to return.- Returns:
- The tagValues at the given index.
-
getTagValuesBytes
com.google.protobuf.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;
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the tagValues at the given index.
-
getTagValueIdsList
List<String> 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;
- Returns:
- A list containing the tagValueIds.
-
getTagValueIdsCount
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;
- Returns:
- The count of tagValueIds.
-
getTagValueIds
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;
- Parameters:
index
- The index of the element to return.- Returns:
- The tagValueIds at the given index.
-
getTagValueIdsBytes
com.google.protobuf.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;
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the tagValueIds at the given index.
-
getParentAssetType
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:
- The parentAssetType.
-
getParentAssetTypeBytes
com.google.protobuf.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:
- The bytes for parentAssetType.
-
-