All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • target.apidocs.com.google.api.services.cloudasset.v1.CloudAsset.V1.SearchAllResources.html Maven / Gradle / Ivy

    The newest version!
    





CloudAsset.V1.SearchAllResources (Cloud Asset API v1-rev20241211-2.0.0)









    



    Skip navigation links
    





    

    




    


    

    



    



    



    

    com.google.api.services.cloudasset.v1
    

    Class CloudAsset.V1.SearchAllResources
    

    

    


    


    

    


    

    

      

    • 


        

      • 



        Constructor Detail
        




          

        • 

          SearchAllResources
          

          protected SearchAllResources(String scope)
          

          Searches all Google Cloud resources within the specified scope, such as a project, folder, or
 organization. The caller must be granted the `cloudasset.assets.searchAllResources` permission
 on the desired scope, otherwise the request will be rejected.

 Create a request for the method "v1.searchAllResources".

 This request holds the parameters needed by the the cloudasset server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation. 
           SearchAllResources#initialize(com.google.api.client.googleapis.services.A
 bstractGoogleClientRequest) must be called to initialize this instance immediately after
 invoking the constructor. 
          

          

          Parameters:
          

          scope - 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")
          

          Since:
          

          1.13
          

          

          • 

        

        • 

      


        

      • 



        Method Detail
        




          

        • 

          executeUsingHead
          

          public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException
          

          

          Overrides:
          

          executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<SearchAllResourcesResponse>
          

          Throws:
          

          IOException
          

          

          • 

        




          

        • 

          buildHttpRequestUsingHead
          

          public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
          

          

          Overrides:
          

          buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<SearchAllResourcesResponse>
          

          Throws:
          

          IOException
          

          

          • 

        
















































          

        • 

          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`](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")
          

          • 

        




          

        • 

          setScope
          

          public CloudAsset.V1.SearchAllResources setScope(String scope)
          

          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")
          

          • 

        




          

        • 

          getAssetTypes
          

          public List<String> getAssetTypes()
          

          Optional. A list of asset types that this request searches for. If empty, it will search all the
     asset types [supported by search APIs](https://cloud.google.com/asset-inventory/docs/supported-
     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.
          

          • 

        




          

        • 

          setAssetTypes
          

          public CloudAsset.V1.SearchAllResources setAssetTypes(List<String> assetTypes)
          

          Optional. A list of asset types that this request searches for. If empty, it will search
 all the asset types [supported by search APIs](https://cloud.google.com/asset-
 inventory/docs/supported-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.
          

          • 

        




          

        • 

          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 the following fields in the response
     are sortable: * name * assetType * project * displayName * description * location * createTime *
     updateTime * state * parentFullResourceName * parentAssetType
          

          • 

        




          

        • 

          setOrderBy
          

          public CloudAsset.V1.SearchAllResources setOrderBy(String orderBy)
          

          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 the following
 fields in the response are sortable: * name * assetType * project * displayName *
 description * location * createTime * updateTime * state * parentFullResourceName *
 parentAssetType
          

          • 

        




          

        • 

          getPageSize
          

          public Integer 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 or a negative value, 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.
          

          • 

        




          

        • 

          setPageSize
          

          public CloudAsset.V1.SearchAllResources setPageSize(Integer pageSize)
          

          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 or a negative value, 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.
          

          • 

        




          

        • 

          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.
          

          • 

        




          

        • 

          setPageToken
          

          public CloudAsset.V1.SearchAllResources setPageToken(String pageToken)
          

          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.
          

          • 

        




          

        • 

          getQuery
          

          public 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`. * `tagKeys:env` to find Google Cloud resources that have directly attached tags
     where the [`TagKey.namespacedName`](https://cloud.google.com/resource-
     manager/reference/rest/v3/tagKeys#resource:-tagkey) contains `env`. * `tagValues:prod*` to find
     Google Cloud resources that have directly attached tags where the
     [`TagValue.namespacedName`](https://cloud.google.com/resource-
     manager/reference/rest/v3/tagValues#resource:-tagvalue) contains a word prefixed by `prod`. *
     `tagValueIds=tagValues/123` to find Google Cloud resources that have directly attached tags where
     the [`TagValue.name`](https://cloud.google.com/resource-
     manager/reference/rest/v3/tagValues#resource:-tagvalue) is exactly `tagValues/123`. *
     `effectiveTagKeys:env` to find Google Cloud resources that have directly attached or inherited tags
     where the [`TagKey.namespacedName`](https://cloud.google.com/resource-
     manager/reference/rest/v3/tagKeys#resource:-tagkey) contains `env`. * `effectiveTagValues:prod*` to
     find Google Cloud resources that have directly attached or inherited tags where the
     [`TagValue.namespacedName`](https://cloud.google.com/resource-
     manager/reference/rest/v3/tagValues#resource:-tagvalue) contains a word prefixed by `prod`. *
     `effectiveTagValueIds=tagValues/123` to find Google Cloud resources that have directly attached or
     inherited tags where the [`TagValue.name`](https://cloud.google.com/resource-
     manager/reference/rest/v3/tagValues#resource:-tagvalue) is exactly `tagValues/123`. * `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. 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`. * `sccSecurityMarks.key=value` to find Cloud
     resources that are attached with security marks whose key is `key` and value is `value`. *
     `sccSecurityMarks.key:*` to find Cloud resources that are attached with security marks whose key is
     `key`. * `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.
          

          • 

        




          

        • 

          setQuery
          

          public CloudAsset.V1.SearchAllResources setQuery(String query)
          

          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`. * `tagKeys:env` to find Google Cloud resources that have
 directly attached tags where the
 [`TagKey.namespacedName`](https://cloud.google.com/resource-
 manager/reference/rest/v3/tagKeys#resource:-tagkey) contains `env`. * `tagValues:prod*` to
 find Google Cloud resources that have directly attached tags where the
 [`TagValue.namespacedName`](https://cloud.google.com/resource-
 manager/reference/rest/v3/tagValues#resource:-tagvalue) contains a word prefixed by `prod`.
 * `tagValueIds=tagValues/123` to find Google Cloud resources that have directly attached
 tags where the [`TagValue.name`](https://cloud.google.com/resource-
 manager/reference/rest/v3/tagValues#resource:-tagvalue) is exactly `tagValues/123`. *
 `effectiveTagKeys:env` to find Google Cloud resources that have directly attached or
 inherited tags where the [`TagKey.namespacedName`](https://cloud.google.com/resource-
 manager/reference/rest/v3/tagKeys#resource:-tagkey) contains `env`. *
 `effectiveTagValues:prod*` to find Google Cloud resources that have directly attached or
 inherited tags where the [`TagValue.namespacedName`](https://cloud.google.com/resource-
 manager/reference/rest/v3/tagValues#resource:-tagvalue) contains a word prefixed by `prod`.
 * `effectiveTagValueIds=tagValues/123` to find Google Cloud resources that have directly
 attached or inherited tags where the [`TagValue.name`](https://cloud.google.com/resource-
 manager/reference/rest/v3/tagValues#resource:-tagvalue) is exactly `tagValues/123`. *
 `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. 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`. *
 `sccSecurityMarks.key=value` to find Cloud resources that are attached with security marks
 whose key is `key` and value is `value`. * `sccSecurityMarks.key:*` to find Cloud resources
 that are attached with security marks whose key is `key`. * `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.
          

          • 

        




          

        • 

          getReadMask
          

          public String getReadMask()
          

          Optional. A comma-separated list of fields that you want returned in the results. The following
     fields are returned by default if not specified: * `name` * `assetType` * `project` * `folders` *
     `organization` * `displayName` * `description` * `location` * `labels` * `tags` * `effectiveTags` *
     `networkTags` * `kmsKeys` * `createTime` * `updateTime` * `state` * `additionalAttributes` *
     `parentFullResourceName` * `parentAssetType` Some fields of large size, such as
     `versionedResources`, `attachedResources`, `effectiveTags` etc., are not returned by default, but
     you can specify them in the `read_mask` parameter if you want to include them. If `"*"` is
     specified, all [available fields](https://cloud.google.com/asset-
     inventory/docs/reference/rest/v1/TopLevel/searchAllResources#resourcesearchresult) are returned.
     Examples: `"name,location"`, `"name,versionedResources"`, `"*"`. Any invalid field path will
     trigger INVALID_ARGUMENT error.
          

          • 

        




          

        • 

          setReadMask
          

          public CloudAsset.V1.SearchAllResources setReadMask(String readMask)
          

          Optional. A comma-separated list of fields that you want returned in the results. The
 following fields are returned by default if not specified: * `name` * `assetType` *
 `project` * `folders` * `organization` * `displayName` * `description` * `location` *
 `labels` * `tags` * `effectiveTags` * `networkTags` * `kmsKeys` * `createTime` *
 `updateTime` * `state` * `additionalAttributes` * `parentFullResourceName` *
 `parentAssetType` Some fields of large size, such as `versionedResources`,
 `attachedResources`, `effectiveTags` etc., are not returned by default, but you can specify
 them in the `read_mask` parameter if you want to include them. If `"*"` is specified, all
 [available fields](https://cloud.google.com/asset-
 inventory/docs/reference/rest/v1/TopLevel/searchAllResources#resourcesearchresult) are
 returned. Examples: `"name,location"`, `"name,versionedResources"`, `"*"`. Any invalid
 field path will trigger INVALID_ARGUMENT error.
          

          • 

        





        • 

      

      • 

    

    

    



    



    Skip navigation links
    





    

    




    


    

    



    



    


    Copyright © 2011–2024 Google. All rights reserved.




    © 2015 - 2025 Weber Informatics LLC | Privacy Policy