Interface SearchAllResourcesRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    SearchAllResourcesRequest, SearchAllResourcesRequest.Builder

    public interface SearchAllResourcesRequestOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Detail

      • getScope

        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`](https://cloud.google.com/asset-inventory/docs/access-control#required_permissions)
         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:
        The scope.
      • getScopeBytes

        com.google.protobuf.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`](https://cloud.google.com/asset-inventory/docs/access-control#required_permissions)
         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:
        The bytes for scope.
      • getQuery

        String getQuery()
         Optional. The query statement. See [how to construct a
         query](https://cloud.google.com/asset-inventory/docs/searching-resources#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 the `kmsKeys` 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:
        The query.
      • getQueryBytes

        com.google.protobuf.ByteString getQueryBytes()
         Optional. The query statement. See [how to construct a
         query](https://cloud.google.com/asset-inventory/docs/searching-resources#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 the `kmsKeys` 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:
        The bytes for query.
      • getAssetTypesList

        List<String> getAssetTypesList()
         Optional. A list of asset types that this request searches for. If empty,
         it will search all the [searchable asset
         types](https://cloud.google.com/asset-inventory/docs/supported-asset-types#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](https://github.com/google/re2/wiki/Syntax) 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:
        A list containing the assetTypes.
      • getAssetTypesCount

        int getAssetTypesCount()
         Optional. A list of asset types that this request searches for. If empty,
         it will search all the [searchable asset
         types](https://cloud.google.com/asset-inventory/docs/supported-asset-types#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](https://github.com/google/re2/wiki/Syntax) 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:
        The count of assetTypes.
      • getAssetTypes

        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](https://cloud.google.com/asset-inventory/docs/supported-asset-types#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](https://github.com/google/re2/wiki/Syntax) 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:
        index - The index of the element to return.
        Returns:
        The assetTypes at the given index.
      • getAssetTypesBytes

        com.google.protobuf.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](https://cloud.google.com/asset-inventory/docs/supported-asset-types#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](https://github.com/google/re2/wiki/Syntax) 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:
        index - The index of the value to return.
        Returns:
        The bytes of the assetTypes at the given index.
      • getPageSize

        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:
        The pageSize.
      • getPageToken

        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:
        The pageToken.
      • getPageTokenBytes

        com.google.protobuf.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:
        The bytes for pageToken.
      • getOrderBy

        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:
        The orderBy.
      • getOrderByBytes

        com.google.protobuf.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:
        The bytes for orderBy.
      • hasReadMask

        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:
        Whether the readMask field is set.
      • getReadMask

        com.google.protobuf.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:
        The readMask.
      • getReadMaskOrBuilder

        com.google.protobuf.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];