markClaimed method

Future<GoogleCloudRecommenderV1Recommendation> markClaimed(
  1. GoogleCloudRecommenderV1MarkRecommendationClaimedRequest request,
  2. String name, {
  3. String? $fields,
})

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.

request - The metadata request object.

Request parameters:

name - Required. Name of the recommendation. Value must have pattern ^folders/\[^/\]+/locations/\[^/\]+/recommenders/\[^/\]+/recommendations/\[^/\]+$.

$fields - Selector specifying which fields to include in a partial response.

Completes with a GoogleCloudRecommenderV1Recommendation.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<GoogleCloudRecommenderV1Recommendation> markClaimed(
  GoogleCloudRecommenderV1MarkRecommendationClaimedRequest request,
  core.String name, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$name') + ':markClaimed';

  final response_ = await _requester.request(
    url_,
    'POST',
    body: body_,
    queryParams: queryParams_,
  );
  return GoogleCloudRecommenderV1Recommendation.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}