- 3.55.0 (latest)
- 3.53.0
- 3.52.0
- 3.51.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.41.0
- 3.40.0
- 3.39.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.28.0
- 3.27.0
- 3.26.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.2-SNAPSHOT
- 3.6.0
- 3.4.1
- 3.3.1
- 3.2.17
public static final class SearchAllResourcesRequest.Builder extends GeneratedMessageV3.Builder<SearchAllResourcesRequest.Builder> implements SearchAllResourcesRequestOrBuilder
Search all resources request.
Protobuf type google.cloud.asset.v1.SearchAllResourcesRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchAllResourcesRequest.BuilderImplements
SearchAllResourcesRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addAllAssetTypes(Iterable<String> values)
public SearchAllResourcesRequest.Builder addAllAssetTypes(Iterable<String> values)
Optional. A list of asset types that this request searches for. If empty, it will search all the searchable asset types. Regular expressions are also supported. For example:
- "compute.googleapis.com.*" snapshots resources whose asset type starts with "compute.googleapis.com".
- ".*Instance" snapshots resources whose asset type ends with "Instance".
- ".Instance." snapshots resources whose asset type contains "Instance". See RE2 for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned.
repeated string asset_types = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
values |
Iterable<String> The assetTypes to add. |
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |
This builder for chaining. |
addAssetTypes(String value)
public SearchAllResourcesRequest.Builder addAssetTypes(String value)
Optional. A list of asset types that this request searches for. If empty, it will search all the searchable asset types. Regular expressions are also supported. For example:
- "compute.googleapis.com.*" snapshots resources whose asset type starts with "compute.googleapis.com".
- ".*Instance" snapshots resources whose asset type ends with "Instance".
- ".Instance." snapshots resources whose asset type contains "Instance". See RE2 for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned.
repeated string asset_types = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
String The assetTypes to add. |
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |
This builder for chaining. |
addAssetTypesBytes(ByteString value)
public SearchAllResourcesRequest.Builder addAssetTypesBytes(ByteString value)
Optional. A list of asset types that this request searches for. If empty, it will search all the searchable asset types. Regular expressions are also supported. For example:
- "compute.googleapis.com.*" snapshots resources whose asset type starts with "compute.googleapis.com".
- ".*Instance" snapshots resources whose asset type ends with "Instance".
- ".Instance." snapshots resources whose asset type contains "Instance". See RE2 for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned.
repeated string asset_types = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes of the assetTypes to add. |
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SearchAllResourcesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |
build()
public SearchAllResourcesRequest build()
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest |
buildPartial()
public SearchAllResourcesRequest buildPartial()
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest |
clear()
public SearchAllResourcesRequest.Builder clear()
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |
clearAssetTypes()
public SearchAllResourcesRequest.Builder clearAssetTypes()
Optional. A list of asset types that this request searches for. If empty, it will search all the searchable asset types. Regular expressions are also supported. For example:
- "compute.googleapis.com.*" snapshots resources whose asset type starts with "compute.googleapis.com".
- ".*Instance" snapshots resources whose asset type ends with "Instance".
- ".Instance." snapshots resources whose asset type contains "Instance". See RE2 for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned.
repeated string asset_types = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public SearchAllResourcesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public SearchAllResourcesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |
clearOrderBy()
public SearchAllResourcesRequest.Builder clearOrderBy()
Optional. A comma-separated list of fields specifying the sorting order of the results. The default order is ascending. Add " DESC" after the field name to indicate descending order. Redundant space characters are ignored. Example: "location DESC, name". Only singular primitive fields in the response are sortable:
- name
- assetType
- project
- displayName
- description
- location
- createTime
- updateTime
- state
- parentFullResourceName
- parentAssetType
All the other fields such as repeated fields (e.g.,
networkTags
,kmsKeys
), map fields (e.g.,labels
) and struct fields (e.g.,additionalAttributes
) are not supported.
string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |
This builder for chaining. |
clearPageSize()
public SearchAllResourcesRequest.Builder clearPageSize()
Optional. The page size for search result pagination. Page size is capped
at 500 even if a larger value is given. If set to zero, server will pick an
appropriate default. Returned results may be fewer than requested. When
this happens, there could be more results as long as next_page_token
is
returned.
int32 page_size = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |
This builder for chaining. |
clearPageToken()
public SearchAllResourcesRequest.Builder clearPageToken()
Optional. If present, then retrieve the next batch of results from the
preceding call to this method. page_token
must be the value of
next_page_token
from the previous response. The values of all other
method parameters, must be identical to those in the previous call.
string page_token = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |
This builder for chaining. |
clearQuery()
public SearchAllResourcesRequest.Builder clearQuery()
Optional. The query statement. See how to construct a
query
for more information. If not specified or empty, it will search all the
resources within the specified scope
.
Examples:
name:Important
to find Google Cloud resources whose name contains "Important" as a word.name=Important
to find the Google Cloud resource whose name is exactly "Important".displayName:Impor*
to find Google Cloud resources whose display name contains "Impor" as a prefix of any word in the field.location:us-west*
to find Google Cloud resources whose location contains both "us" and "west" as prefixes.labels:prod
to find Google Cloud resources whose labels contain "prod" as a key or value.labels.env:prod
to find Google Cloud resources that have a label "env" and its value is "prod".labels.env:*
to find Google Cloud resources that have a label "env".kmsKey:key
to find Google Cloud resources encrypted with a customer-managed encryption key whose name contains "key" as a word. This field is deprecated. Please use thekmsKeys
field to retrieve Cloud KMS key information.kmsKeys:key
to find Google Cloud resources encrypted with customer-managed encryption keys whose name contains the word "key".relationships:instance-group-1
to find Google Cloud resources that have relationships with "instance-group-1" in the related resource name.relationships:INSTANCE_TO_INSTANCEGROUP
to find Compute Engine instances that have relationships of type "INSTANCE_TO_INSTANCEGROUP".relationships.INSTANCE_TO_INSTANCEGROUP:instance-group-1
to find Compute Engine instances that have relationships with "instance-group-1" in the Compute Engine instance group resource name, for relationship type "INSTANCE_TO_INSTANCEGROUP".state:ACTIVE
to find Google Cloud resources whose state contains "ACTIVE" as a word.NOT state:ACTIVE
to find Google Cloud resources whose state doesn't contain "ACTIVE" as a word.createTime<1609459200
to find Google Cloud resources that were created before "2021-01-01 00:00:00 UTC". 1609459200 is the epoch timestamp of "2021-01-01 00:00:00 UTC" in seconds.updateTime>1609459200
to find Google Cloud resources that were updated after "2021-01-01 00:00:00 UTC". 1609459200 is the epoch timestamp of "2021-01-01 00:00:00 UTC" in seconds.Important
to find Google Cloud resources that contain "Important" as a word in any of the searchable fields.Impor*
to find Google Cloud resources that contain "Impor" as a prefix of any word in any of the searchable fields.Important location:(us-west1 OR global)
to find Google Cloud resources that contain "Important" as a word in any of the searchable fields and are also located in the "us-west1" region or the "global" location.
string query = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |
This builder for chaining. |
clearReadMask()
public SearchAllResourcesRequest.Builder clearReadMask()
Optional. A comma-separated list of fields specifying which fields to be
returned in ResourceSearchResult. Only '' or combination of top level
fields can be specified. Field names of both snake_case and camelCase are
supported. Examples: "
", "name,location"
, "name,versionedResources"
.
The read_mask paths must be valid field paths listed but not limited to
(both snake_case and camelCase are supported):
- name
- assetType
- project
- displayName
- description
- location
- tagKeys
- tagValues
- tagValueIds
- labels
- networkTags
- kmsKey (This field is deprecated. Please use the
kmsKeys
field to retrieve Cloud KMS key information.) - kmsKeys
- createTime
- updateTime
- state
- additionalAttributes
- versionedResources If read_mask is not specified, all fields except versionedResources will be returned. If only '*' is specified, all fields including versionedResources will be returned. Any invalid field path will trigger INVALID_ARGUMENT error.
.google.protobuf.FieldMask read_mask = 8 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |
clearScope()
public SearchAllResourcesRequest.Builder clearScope()
Required. A scope can be a project, a folder, or an organization. The
search is limited to the resources within the scope
. The caller must be
granted the
cloudasset.assets.searchAllResources
permission on the desired scope.
The allowed values are:
- projects/{PROJECT_ID} (e.g., "projects/foo-bar")
- projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
- folders/{FOLDER_NUMBER} (e.g., "folders/1234567")
- organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")
string scope = 1 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |
This builder for chaining. |
clone()
public SearchAllResourcesRequest.Builder clone()
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |
getAssetTypes(int index)
public String getAssetTypes(int index)
Optional. A list of asset types that this request searches for. If empty, it will search all the searchable asset types. Regular expressions are also supported. For example:
- "compute.googleapis.com.*" snapshots resources whose asset type starts with "compute.googleapis.com".
- ".*Instance" snapshots resources whose asset type ends with "Instance".
- ".Instance." snapshots resources whose asset type contains "Instance". See RE2 for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned.
repeated string asset_types = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int The index of the element to return. |
Returns | |
---|---|
Type | Description |
String |
The assetTypes at the given index. |
getAssetTypesBytes(int index)
public ByteString getAssetTypesBytes(int index)
Optional. A list of asset types that this request searches for. If empty, it will search all the searchable asset types. Regular expressions are also supported. For example:
- "compute.googleapis.com.*" snapshots resources whose asset type starts with "compute.googleapis.com".
- ".*Instance" snapshots resources whose asset type ends with "Instance".
- ".Instance." snapshots resources whose asset type contains "Instance". See RE2 for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned.
repeated string asset_types = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int The index of the value to return. |
Returns | |
---|---|
Type | Description |
ByteString |
The bytes of the assetTypes at the given index. |
getAssetTypesCount()
public int getAssetTypesCount()
Optional. A list of asset types that this request searches for. If empty, it will search all the searchable asset types. Regular expressions are also supported. For example:
- "compute.googleapis.com.*" snapshots resources whose asset type starts with "compute.googleapis.com".
- ".*Instance" snapshots resources whose asset type ends with "Instance".
- ".Instance." snapshots resources whose asset type contains "Instance". See RE2 for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned.
repeated string asset_types = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
The count of assetTypes. |
getAssetTypesList()
public ProtocolStringList getAssetTypesList()
Optional. A list of asset types that this request searches for. If empty, it will search all the searchable asset types. Regular expressions are also supported. For example:
- "compute.googleapis.com.*" snapshots resources whose asset type starts with "compute.googleapis.com".
- ".*Instance" snapshots resources whose asset type ends with "Instance".
- ".Instance." snapshots resources whose asset type contains "Instance". See RE2 for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned.
repeated string asset_types = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ProtocolStringList |
A list containing the assetTypes. |
getDefaultInstanceForType()
public SearchAllResourcesRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getOrderBy()
public String getOrderBy()
Optional. A comma-separated list of fields specifying the sorting order of the results. The default order is ascending. Add " DESC" after the field name to indicate descending order. Redundant space characters are ignored. Example: "location DESC, name". Only singular primitive fields in the response are sortable:
- name
- assetType
- project
- displayName
- description
- location
- createTime
- updateTime
- state
- parentFullResourceName
- parentAssetType
All the other fields such as repeated fields (e.g.,
networkTags
,kmsKeys
), map fields (e.g.,labels
) and struct fields (e.g.,additionalAttributes
) are not supported.
string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String |
The orderBy. |
getOrderByBytes()
public ByteString getOrderByBytes()
Optional. A comma-separated list of fields specifying the sorting order of the results. The default order is ascending. Add " DESC" after the field name to indicate descending order. Redundant space characters are ignored. Example: "location DESC, name". Only singular primitive fields in the response are sortable:
- name
- assetType
- project
- displayName
- description
- location
- createTime
- updateTime
- state
- parentFullResourceName
- parentAssetType
All the other fields such as repeated fields (e.g.,
networkTags
,kmsKeys
), map fields (e.g.,labels
) and struct fields (e.g.,additionalAttributes
) are not supported.
string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for orderBy. |
getPageSize()
public int getPageSize()
Optional. The page size for search result pagination. Page size is capped
at 500 even if a larger value is given. If set to zero, server will pick an
appropriate default. Returned results may be fewer than requested. When
this happens, there could be more results as long as next_page_token
is
returned.
int32 page_size = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
The pageSize. |
getPageToken()
public String getPageToken()
Optional. If present, then retrieve the next batch of results from the
preceding call to this method. page_token
must be the value of
next_page_token
from the previous response. The values of all other
method parameters, must be identical to those in the previous call.
string page_token = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String |
The pageToken. |
getPageTokenBytes()
public ByteString getPageTokenBytes()
Optional. If present, then retrieve the next batch of results from the
preceding call to this method. page_token
must be the value of
next_page_token
from the previous response. The values of all other
method parameters, must be identical to those in the previous call.
string page_token = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for pageToken. |
getQuery()
public String getQuery()
Optional. The query statement. See how to construct a
query
for more information. If not specified or empty, it will search all the
resources within the specified scope
.
Examples:
name:Important
to find Google Cloud resources whose name contains "Important" as a word.name=Important
to find the Google Cloud resource whose name is exactly "Important".displayName:Impor*
to find Google Cloud resources whose display name contains "Impor" as a prefix of any word in the field.location:us-west*
to find Google Cloud resources whose location contains both "us" and "west" as prefixes.labels:prod
to find Google Cloud resources whose labels contain "prod" as a key or value.labels.env:prod
to find Google Cloud resources that have a label "env" and its value is "prod".labels.env:*
to find Google Cloud resources that have a label "env".kmsKey:key
to find Google Cloud resources encrypted with a customer-managed encryption key whose name contains "key" as a word. This field is deprecated. Please use thekmsKeys
field to retrieve Cloud KMS key information.kmsKeys:key
to find Google Cloud resources encrypted with customer-managed encryption keys whose name contains the word "key".relationships:instance-group-1
to find Google Cloud resources that have relationships with "instance-group-1" in the related resource name.relationships:INSTANCE_TO_INSTANCEGROUP
to find Compute Engine instances that have relationships of type "INSTANCE_TO_INSTANCEGROUP".relationships.INSTANCE_TO_INSTANCEGROUP:instance-group-1
to find Compute Engine instances that have relationships with "instance-group-1" in the Compute Engine instance group resource name, for relationship type "INSTANCE_TO_INSTANCEGROUP".state:ACTIVE
to find Google Cloud resources whose state contains "ACTIVE" as a word.NOT state:ACTIVE
to find Google Cloud resources whose state doesn't contain "ACTIVE" as a word.createTime<1609459200
to find Google Cloud resources that were created before "2021-01-01 00:00:00 UTC". 1609459200 is the epoch timestamp of "2021-01-01 00:00:00 UTC" in seconds.updateTime>1609459200
to find Google Cloud resources that were updated after "2021-01-01 00:00:00 UTC". 1609459200 is the epoch timestamp of "2021-01-01 00:00:00 UTC" in seconds.Important
to find Google Cloud resources that contain "Important" as a word in any of the searchable fields.Impor*
to find Google Cloud resources that contain "Impor" as a prefix of any word in any of the searchable fields.Important location:(us-west1 OR global)
to find Google Cloud resources that contain "Important" as a word in any of the searchable fields and are also located in the "us-west1" region or the "global" location.
string query = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String |
The query. |
getQueryBytes()
public ByteString getQueryBytes()
Optional. The query statement. See how to construct a
query
for more information. If not specified or empty, it will search all the
resources within the specified scope
.
Examples:
name:Important
to find Google Cloud resources whose name contains "Important" as a word.name=Important
to find the Google Cloud resource whose name is exactly "Important".displayName:Impor*
to find Google Cloud resources whose display name contains "Impor" as a prefix of any word in the field.location:us-west*
to find Google Cloud resources whose location contains both "us" and "west" as prefixes.labels:prod
to find Google Cloud resources whose labels contain "prod" as a key or value.labels.env:prod
to find Google Cloud resources that have a label "env" and its value is "prod".labels.env:*
to find Google Cloud resources that have a label "env".kmsKey:key
to find Google Cloud resources encrypted with a customer-managed encryption key whose name contains "key" as a word. This field is deprecated. Please use thekmsKeys
field to retrieve Cloud KMS key information.kmsKeys:key
to find Google Cloud resources encrypted with customer-managed encryption keys whose name contains the word "key".relationships:instance-group-1
to find Google Cloud resources that have relationships with "instance-group-1" in the related resource name.relationships:INSTANCE_TO_INSTANCEGROUP
to find Compute Engine instances that have relationships of type "INSTANCE_TO_INSTANCEGROUP".relationships.INSTANCE_TO_INSTANCEGROUP:instance-group-1
to find Compute Engine instances that have relationships with "instance-group-1" in the Compute Engine instance group resource name, for relationship type "INSTANCE_TO_INSTANCEGROUP".state:ACTIVE
to find Google Cloud resources whose state contains "ACTIVE" as a word.NOT state:ACTIVE
to find Google Cloud resources whose state doesn't contain "ACTIVE" as a word.createTime<1609459200
to find Google Cloud resources that were created before "2021-01-01 00:00:00 UTC". 1609459200 is the epoch timestamp of "2021-01-01 00:00:00 UTC" in seconds.updateTime>1609459200
to find Google Cloud resources that were updated after "2021-01-01 00:00:00 UTC". 1609459200 is the epoch timestamp of "2021-01-01 00:00:00 UTC" in seconds.Important
to find Google Cloud resources that contain "Important" as a word in any of the searchable fields.Impor*
to find Google Cloud resources that contain "Impor" as a prefix of any word in any of the searchable fields.Important location:(us-west1 OR global)
to find Google Cloud resources that contain "Important" as a word in any of the searchable fields and are also located in the "us-west1" region or the "global" location.
string query = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for query. |
getReadMask()
public FieldMask getReadMask()
Optional. A comma-separated list of fields specifying which fields to be
returned in ResourceSearchResult. Only '' or combination of top level
fields can be specified. Field names of both snake_case and camelCase are
supported. Examples: "
", "name,location"
, "name,versionedResources"
.
The read_mask paths must be valid field paths listed but not limited to
(both snake_case and camelCase are supported):
- name
- assetType
- project
- displayName
- description
- location
- tagKeys
- tagValues
- tagValueIds
- labels
- networkTags
- kmsKey (This field is deprecated. Please use the
kmsKeys
field to retrieve Cloud KMS key information.) - kmsKeys
- createTime
- updateTime
- state
- additionalAttributes
- versionedResources If read_mask is not specified, all fields except versionedResources will be returned. If only '*' is specified, all fields including versionedResources will be returned. Any invalid field path will trigger INVALID_ARGUMENT error.
.google.protobuf.FieldMask read_mask = 8 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
FieldMask |
The readMask. |
getReadMaskBuilder()
public FieldMask.Builder getReadMaskBuilder()
Optional. A comma-separated list of fields specifying which fields to be
returned in ResourceSearchResult. Only '' or combination of top level
fields can be specified. Field names of both snake_case and camelCase are
supported. Examples: "
", "name,location"
, "name,versionedResources"
.
The read_mask paths must be valid field paths listed but not limited to
(both snake_case and camelCase are supported):
- name
- assetType
- project
- displayName
- description
- location
- tagKeys
- tagValues
- tagValueIds
- labels
- networkTags
- kmsKey (This field is deprecated. Please use the
kmsKeys
field to retrieve Cloud KMS key information.) - kmsKeys
- createTime
- updateTime
- state
- additionalAttributes
- versionedResources If read_mask is not specified, all fields except versionedResources will be returned. If only '*' is specified, all fields including versionedResources will be returned. Any invalid field path will trigger INVALID_ARGUMENT error.
.google.protobuf.FieldMask read_mask = 8 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Builder |
getReadMaskOrBuilder()
public FieldMaskOrBuilder getReadMaskOrBuilder()
Optional. A comma-separated list of fields specifying which fields to be
returned in ResourceSearchResult. Only '' or combination of top level
fields can be specified. Field names of both snake_case and camelCase are
supported. Examples: "
", "name,location"
, "name,versionedResources"
.
The read_mask paths must be valid field paths listed but not limited to
(both snake_case and camelCase are supported):
- name
- assetType
- project
- displayName
- description
- location
- tagKeys
- tagValues
- tagValueIds
- labels
- networkTags
- kmsKey (This field is deprecated. Please use the
kmsKeys
field to retrieve Cloud KMS key information.) - kmsKeys
- createTime
- updateTime
- state
- additionalAttributes
- versionedResources If read_mask is not specified, all fields except versionedResources will be returned. If only '*' is specified, all fields including versionedResources will be returned. Any invalid field path will trigger INVALID_ARGUMENT error.
.google.protobuf.FieldMask read_mask = 8 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
FieldMaskOrBuilder |
getScope()
public String getScope()
Required. A scope can be a project, a folder, or an organization. The
search is limited to the resources within the scope
. The caller must be
granted the
cloudasset.assets.searchAllResources
permission on the desired scope.
The allowed values are:
- projects/{PROJECT_ID} (e.g., "projects/foo-bar")
- projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
- folders/{FOLDER_NUMBER} (e.g., "folders/1234567")
- organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")
string scope = 1 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
String |
The scope. |
getScopeBytes()
public ByteString getScopeBytes()
Required. A scope can be a project, a folder, or an organization. The
search is limited to the resources within the scope
. The caller must be
granted the
cloudasset.assets.searchAllResources
permission on the desired scope.
The allowed values are:
- projects/{PROJECT_ID} (e.g., "projects/foo-bar")
- projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
- folders/{FOLDER_NUMBER} (e.g., "folders/1234567")
- organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")
string scope = 1 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for scope. |
hasReadMask()
public boolean hasReadMask()
Optional. A comma-separated list of fields specifying which fields to be
returned in ResourceSearchResult. Only '' or combination of top level
fields can be specified. Field names of both snake_case and camelCase are
supported. Examples: "
", "name,location"
, "name,versionedResources"
.
The read_mask paths must be valid field paths listed but not limited to
(both snake_case and camelCase are supported):
- name
- assetType
- project
- displayName
- description
- location
- tagKeys
- tagValues
- tagValueIds
- labels
- networkTags
- kmsKey (This field is deprecated. Please use the
kmsKeys
field to retrieve Cloud KMS key information.) - kmsKeys
- createTime
- updateTime
- state
- additionalAttributes
- versionedResources If read_mask is not specified, all fields except versionedResources will be returned. If only '*' is specified, all fields including versionedResources will be returned. Any invalid field path will trigger INVALID_ARGUMENT error.
.google.protobuf.FieldMask read_mask = 8 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean |
Whether the readMask field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(SearchAllResourcesRequest other)
public SearchAllResourcesRequest.Builder mergeFrom(SearchAllResourcesRequest other)
Parameter | |
---|---|
Name | Description |
other |
SearchAllResourcesRequest |
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SearchAllResourcesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public SearchAllResourcesRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |
mergeReadMask(FieldMask value)
public SearchAllResourcesRequest.Builder mergeReadMask(FieldMask value)
Optional. A comma-separated list of fields specifying which fields to be
returned in ResourceSearchResult. Only '' or combination of top level
fields can be specified. Field names of both snake_case and camelCase are
supported. Examples: "
", "name,location"
, "name,versionedResources"
.
The read_mask paths must be valid field paths listed but not limited to
(both snake_case and camelCase are supported):
- name
- assetType
- project
- displayName
- description
- location
- tagKeys
- tagValues
- tagValueIds
- labels
- networkTags
- kmsKey (This field is deprecated. Please use the
kmsKeys
field to retrieve Cloud KMS key information.) - kmsKeys
- createTime
- updateTime
- state
- additionalAttributes
- versionedResources If read_mask is not specified, all fields except versionedResources will be returned. If only '*' is specified, all fields including versionedResources will be returned. Any invalid field path will trigger INVALID_ARGUMENT error.
.google.protobuf.FieldMask read_mask = 8 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
FieldMask |
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SearchAllResourcesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |
setAssetTypes(int index, String value)
public SearchAllResourcesRequest.Builder setAssetTypes(int index, String value)
Optional. A list of asset types that this request searches for. If empty, it will search all the searchable asset types. Regular expressions are also supported. For example:
- "compute.googleapis.com.*" snapshots resources whose asset type starts with "compute.googleapis.com".
- ".*Instance" snapshots resources whose asset type ends with "Instance".
- ".Instance." snapshots resources whose asset type contains "Instance". See RE2 for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned.
repeated string asset_types = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index |
int The index to set the value at. |
value |
String The assetTypes to set. |
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public SearchAllResourcesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |
setOrderBy(String value)
public SearchAllResourcesRequest.Builder setOrderBy(String value)
Optional. A comma-separated list of fields specifying the sorting order of the results. The default order is ascending. Add " DESC" after the field name to indicate descending order. Redundant space characters are ignored. Example: "location DESC, name". Only singular primitive fields in the response are sortable:
- name
- assetType
- project
- displayName
- description
- location
- createTime
- updateTime
- state
- parentFullResourceName
- parentAssetType
All the other fields such as repeated fields (e.g.,
networkTags
,kmsKeys
), map fields (e.g.,labels
) and struct fields (e.g.,additionalAttributes
) are not supported.
string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
String The orderBy to set. |
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |
This builder for chaining. |
setOrderByBytes(ByteString value)
public SearchAllResourcesRequest.Builder setOrderByBytes(ByteString value)
Optional. A comma-separated list of fields specifying the sorting order of the results. The default order is ascending. Add " DESC" after the field name to indicate descending order. Redundant space characters are ignored. Example: "location DESC, name". Only singular primitive fields in the response are sortable:
- name
- assetType
- project
- displayName
- description
- location
- createTime
- updateTime
- state
- parentFullResourceName
- parentAssetType
All the other fields such as repeated fields (e.g.,
networkTags
,kmsKeys
), map fields (e.g.,labels
) and struct fields (e.g.,additionalAttributes
) are not supported.
string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for orderBy to set. |
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |
This builder for chaining. |
setPageSize(int value)
public SearchAllResourcesRequest.Builder setPageSize(int value)
Optional. The page size for search result pagination. Page size is capped
at 500 even if a larger value is given. If set to zero, server will pick an
appropriate default. Returned results may be fewer than requested. When
this happens, there could be more results as long as next_page_token
is
returned.
int32 page_size = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
int The pageSize to set. |
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public SearchAllResourcesRequest.Builder setPageToken(String value)
Optional. If present, then retrieve the next batch of results from the
preceding call to this method. page_token
must be the value of
next_page_token
from the previous response. The values of all other
method parameters, must be identical to those in the previous call.
string page_token = 5 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
String The pageToken to set. |
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public SearchAllResourcesRequest.Builder setPageTokenBytes(ByteString value)
Optional. If present, then retrieve the next batch of results from the
preceding call to this method. page_token
must be the value of
next_page_token
from the previous response. The values of all other
method parameters, must be identical to those in the previous call.
string page_token = 5 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for pageToken to set. |
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |
This builder for chaining. |
setQuery(String value)
public SearchAllResourcesRequest.Builder setQuery(String value)
Optional. The query statement. See how to construct a
query
for more information. If not specified or empty, it will search all the
resources within the specified scope
.
Examples:
name:Important
to find Google Cloud resources whose name contains "Important" as a word.name=Important
to find the Google Cloud resource whose name is exactly "Important".displayName:Impor*
to find Google Cloud resources whose display name contains "Impor" as a prefix of any word in the field.location:us-west*
to find Google Cloud resources whose location contains both "us" and "west" as prefixes.labels:prod
to find Google Cloud resources whose labels contain "prod" as a key or value.labels.env:prod
to find Google Cloud resources that have a label "env" and its value is "prod".labels.env:*
to find Google Cloud resources that have a label "env".kmsKey:key
to find Google Cloud resources encrypted with a customer-managed encryption key whose name contains "key" as a word. This field is deprecated. Please use thekmsKeys
field to retrieve Cloud KMS key information.kmsKeys:key
to find Google Cloud resources encrypted with customer-managed encryption keys whose name contains the word "key".relationships:instance-group-1
to find Google Cloud resources that have relationships with "instance-group-1" in the related resource name.relationships:INSTANCE_TO_INSTANCEGROUP
to find Compute Engine instances that have relationships of type "INSTANCE_TO_INSTANCEGROUP".relationships.INSTANCE_TO_INSTANCEGROUP:instance-group-1
to find Compute Engine instances that have relationships with "instance-group-1" in the Compute Engine instance group resource name, for relationship type "INSTANCE_TO_INSTANCEGROUP".state:ACTIVE
to find Google Cloud resources whose state contains "ACTIVE" as a word.NOT state:ACTIVE
to find Google Cloud resources whose state doesn't contain "ACTIVE" as a word.createTime<1609459200
to find Google Cloud resources that were created before "2021-01-01 00:00:00 UTC". 1609459200 is the epoch timestamp of "2021-01-01 00:00:00 UTC" in seconds.updateTime>1609459200
to find Google Cloud resources that were updated after "2021-01-01 00:00:00 UTC". 1609459200 is the epoch timestamp of "2021-01-01 00:00:00 UTC" in seconds.Important
to find Google Cloud resources that contain "Important" as a word in any of the searchable fields.Impor*
to find Google Cloud resources that contain "Impor" as a prefix of any word in any of the searchable fields.Important location:(us-west1 OR global)
to find Google Cloud resources that contain "Important" as a word in any of the searchable fields and are also located in the "us-west1" region or the "global" location.
string query = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
String The query to set. |
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |
This builder for chaining. |
setQueryBytes(ByteString value)
public SearchAllResourcesRequest.Builder setQueryBytes(ByteString value)
Optional. The query statement. See how to construct a
query
for more information. If not specified or empty, it will search all the
resources within the specified scope
.
Examples:
name:Important
to find Google Cloud resources whose name contains "Important" as a word.name=Important
to find the Google Cloud resource whose name is exactly "Important".displayName:Impor*
to find Google Cloud resources whose display name contains "Impor" as a prefix of any word in the field.location:us-west*
to find Google Cloud resources whose location contains both "us" and "west" as prefixes.labels:prod
to find Google Cloud resources whose labels contain "prod" as a key or value.labels.env:prod
to find Google Cloud resources that have a label "env" and its value is "prod".labels.env:*
to find Google Cloud resources that have a label "env".kmsKey:key
to find Google Cloud resources encrypted with a customer-managed encryption key whose name contains "key" as a word. This field is deprecated. Please use thekmsKeys
field to retrieve Cloud KMS key information.kmsKeys:key
to find Google Cloud resources encrypted with customer-managed encryption keys whose name contains the word "key".relationships:instance-group-1
to find Google Cloud resources that have relationships with "instance-group-1" in the related resource name.relationships:INSTANCE_TO_INSTANCEGROUP
to find Compute Engine instances that have relationships of type "INSTANCE_TO_INSTANCEGROUP".relationships.INSTANCE_TO_INSTANCEGROUP:instance-group-1
to find Compute Engine instances that have relationships with "instance-group-1" in the Compute Engine instance group resource name, for relationship type "INSTANCE_TO_INSTANCEGROUP".state:ACTIVE
to find Google Cloud resources whose state contains "ACTIVE" as a word.NOT state:ACTIVE
to find Google Cloud resources whose state doesn't contain "ACTIVE" as a word.createTime<1609459200
to find Google Cloud resources that were created before "2021-01-01 00:00:00 UTC". 1609459200 is the epoch timestamp of "2021-01-01 00:00:00 UTC" in seconds.updateTime>1609459200
to find Google Cloud resources that were updated after "2021-01-01 00:00:00 UTC". 1609459200 is the epoch timestamp of "2021-01-01 00:00:00 UTC" in seconds.Important
to find Google Cloud resources that contain "Important" as a word in any of the searchable fields.Impor*
to find Google Cloud resources that contain "Impor" as a prefix of any word in any of the searchable fields.Important location:(us-west1 OR global)
to find Google Cloud resources that contain "Important" as a word in any of the searchable fields and are also located in the "us-west1" region or the "global" location.
string query = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for query to set. |
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |
This builder for chaining. |
setReadMask(FieldMask value)
public SearchAllResourcesRequest.Builder setReadMask(FieldMask value)
Optional. A comma-separated list of fields specifying which fields to be
returned in ResourceSearchResult. Only '' or combination of top level
fields can be specified. Field names of both snake_case and camelCase are
supported. Examples: "
", "name,location"
, "name,versionedResources"
.
The read_mask paths must be valid field paths listed but not limited to
(both snake_case and camelCase are supported):
- name
- assetType
- project
- displayName
- description
- location
- tagKeys
- tagValues
- tagValueIds
- labels
- networkTags
- kmsKey (This field is deprecated. Please use the
kmsKeys
field to retrieve Cloud KMS key information.) - kmsKeys
- createTime
- updateTime
- state
- additionalAttributes
- versionedResources If read_mask is not specified, all fields except versionedResources will be returned. If only '*' is specified, all fields including versionedResources will be returned. Any invalid field path will trigger INVALID_ARGUMENT error.
.google.protobuf.FieldMask read_mask = 8 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
FieldMask |
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |
setReadMask(FieldMask.Builder builderForValue)
public SearchAllResourcesRequest.Builder setReadMask(FieldMask.Builder builderForValue)
Optional. A comma-separated list of fields specifying which fields to be
returned in ResourceSearchResult. Only '' or combination of top level
fields can be specified. Field names of both snake_case and camelCase are
supported. Examples: "
", "name,location"
, "name,versionedResources"
.
The read_mask paths must be valid field paths listed but not limited to
(both snake_case and camelCase are supported):
- name
- assetType
- project
- displayName
- description
- location
- tagKeys
- tagValues
- tagValueIds
- labels
- networkTags
- kmsKey (This field is deprecated. Please use the
kmsKeys
field to retrieve Cloud KMS key information.) - kmsKeys
- createTime
- updateTime
- state
- additionalAttributes
- versionedResources If read_mask is not specified, all fields except versionedResources will be returned. If only '*' is specified, all fields including versionedResources will be returned. Any invalid field path will trigger INVALID_ARGUMENT error.
.google.protobuf.FieldMask read_mask = 8 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SearchAllResourcesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |
setScope(String value)
public SearchAllResourcesRequest.Builder setScope(String value)
Required. A scope can be a project, a folder, or an organization. The
search is limited to the resources within the scope
. The caller must be
granted the
cloudasset.assets.searchAllResources
permission on the desired scope.
The allowed values are:
- projects/{PROJECT_ID} (e.g., "projects/foo-bar")
- projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
- folders/{FOLDER_NUMBER} (e.g., "folders/1234567")
- organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")
string scope = 1 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
String The scope to set. |
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |
This builder for chaining. |
setScopeBytes(ByteString value)
public SearchAllResourcesRequest.Builder setScopeBytes(ByteString value)
Required. A scope can be a project, a folder, or an organization. The
search is limited to the resources within the scope
. The caller must be
granted the
cloudasset.assets.searchAllResources
permission on the desired scope.
The allowed values are:
- projects/{PROJECT_ID} (e.g., "projects/foo-bar")
- projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
- folders/{FOLDER_NUMBER} (e.g., "folders/1234567")
- organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")
string scope = 1 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for scope to set. |
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final SearchAllResourcesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
SearchAllResourcesRequest.Builder |