GoogleApi.Recommender.V1.Api.BillingAccounts.recommender_billing_accounts_locations_recommenders_recommendations_mark_claimed

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

recommender_billing_accounts_locations_recommenders_recommendations_mark_claimed(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

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

Marks the Recommendation State as Claimed. Users can use this method to indicate to the Recommender API that they are starting to apply the recommendation themselves. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationClaimed can be applied to recommendations in CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.

Parameters

  • connection (type: GoogleApi.Recommender.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Name of the recommendation.
  • 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").
    • :body (type: GoogleApi.Recommender.V1.Model.GoogleCloudRecommenderV1MarkRecommendationClaimedRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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