Method: projects.locations.recommenders.recommendations.markSucceeded

Marks the Recommendation State as Succeeded. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation was successful. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state.

recommendations.markSucceeded can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state.

Requires the recommender.*.update IAM permission for the specified recommender.

HTTP request

POST https://recommender.googleapis.com/v1/{name=projects/*/locations/*/recommenders/*/recommendations/*}:markSucceeded

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Name of the recommendation.

Request body

The request body contains data with the following structure:

JSON representation
{
  "stateMetadata": {
    string: string,
    ...
  },
  "etag": string
}
Fields
stateMetadata

map (key: string, value: string)

State properties to include with this state. Overwrites any existing stateMetadata. Keys must match the regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. Values must match the regex /^[a-zA-Z0-9_./-]{0,255}$/.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

etag

string

Required. Fingerprint of the Recommendation. Provides optimistic locking.

Response body

If successful, the response body contains an instance of Recommendation.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires one of the following Cloud IAM permissions on the name resource, depending on the resource type:

  • recommender.computeDiskIdleResourceRecommendations.update
  • recommender.computeInstanceGroupManagerMachineTypeRecommendations.update
  • recommender.computeInstanceIdleResourceRecommendations.update
  • recommender.computeInstanceMachineTypeRecommendations.update
  • recommender.iamPolicyRecommendations.update

For more information, see the Cloud IAM Documentation.