GoogleApi.Recommender.V1.Api.Organizations.recommender_organizations_locations_recommenders_recommendations_list

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

recommender_organizations_locations_recommenders_recommendations_list(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

recommender_organizations_locations_recommenders_recommendations_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Recommender.V1.Model.GoogleCloudRecommenderV1ListRecommendationsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists recommendations for a Cloud project. Requires the recommender.*.list IAM permission for the specified recommender.

Parameters

  • connection (type: GoogleApi.Recommender.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The container resource on which to execute the request. Acceptable formats: 1. projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] 2. billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] 3. folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] 4. organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ RECOMMENDER_ID refers to supported recommenders: https://cloud.google.com/recommender/docs/recommenders.
  • 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").
    • :filter (type: String.t) - Filter expression to restrict the recommendations returned. Supported filter fields: state_info.state Eg: state_info.state:"DISMISSED" or state_info.state:"FAILED" *:pageSize(*type:*integer()) - Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return. *:pageToken(*type:*String.t) - Optional. If present, retrieves the next batch of results from the preceding call to this method.page_tokenmust be the value ofnext_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.
  • opts (type: keyword()) - Call options

Returns

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