projects

Changed on

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

post/v1/{+name}:markFailed

Request

  • Base URL: https://recommender.googleapis.com
  • URL: https://recommender.googleapis.com/v1/{+name}:markFailed
  • Auth: OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/cloud-platform) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/cloud-platform)

Path parameters

namestring required

Required. Name of the recommendation.

Request body

etagstring

Required. Fingerprint of the Recommendation. Provides optimistic locking.

stateMetadataobject

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

Response

Successful response

Changes

  • f036637ff57eRevision changes
    • breaking

      removed the request body

    • breaking

      removed the media type */* for the response with the status

    • info

      api operation id recommender.billingAccounts.locations.recommenders.recommendations.markFailed removed and replaced with recommender.projects.locations.recommenders.recommendations.markFailed

    • info

      api tag projects added

    • info

      api tag billingAccounts removed