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.
recommendations.markClaimed can be applied to recommendations in CLAIMED, SUCCEEDED, FAILED, or ACTIVE state.
Requires the recommender.*.update IAM permission for the specified recommender.
HTTP request
POST https://recommender.googleapis.com/v1/{name=projects/*/locations/*/recommenders/*/recommendations/*}:markClaimed
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
name |
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 |
State properties to include with this state. Overwrites any existing An object containing a list of |
etag |
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 IAM permissions on the name
resource, depending on the resource type:
recommender.usageCommitmentRecommendations.update
recommender.computeAddressIdleResourceRecommendations.update
recommender.computeDiskIdleResourceRecommendations.update
recommender.computeImageIdleResourceRecommendations.update
recommender.computeInstanceGroupManagerMachineTypeRecommendations.update
recommender.computeInstanceIdleResourceRecommendations.update
recommender.computeInstanceMachineTypeRecommendations.update
recommender.iamPolicyRecommendations.update
recommender.resourcemanagerProjectUtilizationRecommendations.update
For more information, see the IAM documentation.