GoogleApi.CloudAsset.V1.Api.V1.cloudasset_search_all_resources

You're seeing just the function cloudasset_search_all_resources, go back to GoogleApi.CloudAsset.V1.Api.V1 module for more information.
Link to this function

cloudasset_search_all_resources(connection, v1_id, v1_id1, optional_params \\ [], opts \\ [])

View Source

Specs

cloudasset_search_all_resources(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudAsset.V1.Model.SearchAllResourcesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Searches all 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.

Parameters

  • connection (type: GoogleApi.CloudAsset.V1.Connection.t) - Connection to server
  • v1_id (type: String.t) - Part of 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 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")
  • v1_id1 (type: String.t) - Part of scope. See documentation of v1Id.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :assetTypes (type: list(String.t)) - 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.
    • :orderBy (type: String.t) - 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 string fields in the response are sortable, including name, displayName, description, location. All the other fields such as repeated fields (e.g., networkTags), map fields (e.g., labels) and struct fields (e.g., additionalAttributes) are not supported.
    • :pageSize (type: integer()) - 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.
    • :pageToken (type: String.t) - 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.
    • :query (type: String.t) - 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:Importo 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 the word "key". state:ACTIVE to find Cloud resources whose state contains "ACTIVE" as a word. NOT state:ACTIVE to find {{gcp_name}} 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. `Importo 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.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudAsset.V1.Model.SearchAllResourcesResponse{}} on success
  • {:error, info} on failure