public final class SearchAllResourcesRequest extends GeneratedMessageV3 implements SearchAllResourcesRequestOrBuilder
Search all resources request.
Protobuf type google.cloud.asset.v1.SearchAllResourcesRequest
Static Fields
ASSET_TYPES_FIELD_NUMBER
public static final int ASSET_TYPES_FIELD_NUMBER
Field Value
ORDER_BY_FIELD_NUMBER
public static final int ORDER_BY_FIELD_NUMBER
Field Value
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
QUERY_FIELD_NUMBER
public static final int QUERY_FIELD_NUMBER
Field Value
READ_MASK_FIELD_NUMBER
public static final int READ_MASK_FIELD_NUMBER
Field Value
SCOPE_FIELD_NUMBER
public static final int SCOPE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static SearchAllResourcesRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static SearchAllResourcesRequest.Builder newBuilder()
Returns
newBuilder(SearchAllResourcesRequest prototype)
public static SearchAllResourcesRequest.Builder newBuilder(SearchAllResourcesRequest prototype)
Parameter
Returns
public static SearchAllResourcesRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static SearchAllResourcesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static SearchAllResourcesRequest parseFrom(byte[] data)
Parameter
| Name |
Description |
| data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchAllResourcesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static SearchAllResourcesRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchAllResourcesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SearchAllResourcesRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static SearchAllResourcesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SearchAllResourcesRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static SearchAllResourcesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static SearchAllResourcesRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchAllResourcesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<SearchAllResourcesRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
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];
| 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];
| 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];
| 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];
getDefaultInstanceForType()
public SearchAllResourcesRequest getDefaultInstanceForType()
Returns
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];
| 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];
| Type |
Description |
| ByteString |
The bytes for orderBy.
|
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];
| 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];
| 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];
| Type |
Description |
| ByteString |
The bytes for pageToken.
|
getParserForType()
public Parser<SearchAllResourcesRequest> getParserForType()
Returns
Overrides
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 Cloud resources whose name contains
"Important" as a word.name=Important to find the Cloud resource whose name is exactly
"Important".displayName:Impor* to find Cloud resources whose display name
contains "Impor" as a prefix of any word in the field.location:us-west* to find Cloud resources whose location contains both
"us" and "west" as prefixes.labels:prod to find Cloud resources whose labels contain "prod" as
a key or value.labels.env:prod to find Cloud resources that have a label "env"
and its value is "prod".labels.env:* to find Cloud resources that have a label "env".kmsKey:key to find Cloud resources encrypted with a customer-managed
encryption key whose name contains "key" as a word. This field is
deprecated. Please use the kmsKeys field to retrieve KMS key
information.kmsKeys:key to find Cloud resources encrypted with customer-managed
encryption keys whose name contains the word "key".relationships:instance-group-1 to find Cloud resources that have
relationships with "instance-group-1" in the related resource name.relationships:INSTANCE_TO_INSTANCEGROUP to find compute instances that
have relationships of type "INSTANCE_TO_INSTANCEGROUP".relationships.INSTANCE_TO_INSTANCEGROUP:instance-group-1 to find
compute instances that have relationships with "instance-group-1" in the
compute instance group resource name, for relationship type
"INSTANCE_TO_INSTANCEGROUP".state:ACTIVE to find Cloud resources whose state contains "ACTIVE" as a
word.NOT state:ACTIVE to find Cloud resources whose state doesn't contain
"ACTIVE" as a word.createTime<1609459200 to find 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 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 Cloud resources that contain "Important" as a word
in any of the searchable fields.Impor* to find 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 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];
| 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 Cloud resources whose name contains
"Important" as a word.name=Important to find the Cloud resource whose name is exactly
"Important".displayName:Impor* to find Cloud resources whose display name
contains "Impor" as a prefix of any word in the field.location:us-west* to find Cloud resources whose location contains both
"us" and "west" as prefixes.labels:prod to find Cloud resources whose labels contain "prod" as
a key or value.labels.env:prod to find Cloud resources that have a label "env"
and its value is "prod".labels.env:* to find Cloud resources that have a label "env".kmsKey:key to find Cloud resources encrypted with a customer-managed
encryption key whose name contains "key" as a word. This field is
deprecated. Please use the kmsKeys field to retrieve KMS key
information.kmsKeys:key to find Cloud resources encrypted with customer-managed
encryption keys whose name contains the word "key".relationships:instance-group-1 to find Cloud resources that have
relationships with "instance-group-1" in the related resource name.relationships:INSTANCE_TO_INSTANCEGROUP to find compute instances that
have relationships of type "INSTANCE_TO_INSTANCEGROUP".relationships.INSTANCE_TO_INSTANCEGROUP:instance-group-1 to find
compute instances that have relationships with "instance-group-1" in the
compute instance group resource name, for relationship type
"INSTANCE_TO_INSTANCEGROUP".state:ACTIVE to find Cloud resources whose state contains "ACTIVE" as a
word.NOT state:ACTIVE to find Cloud resources whose state doesn't contain
"ACTIVE" as a word.createTime<1609459200 to find 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 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 Cloud resources that contain "Important" as a word
in any of the searchable fields.Impor* to find 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 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];
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 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];
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 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];
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];
| 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];
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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 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];
| Type |
Description |
| boolean |
Whether the readMask field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public SearchAllResourcesRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchAllResourcesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public SearchAllResourcesRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
