patch method

Future<CapacityCommitment> patch(CapacityCommitment request, String name, { String? updateMask, String? $fields, })

Updates an existing capacity commitment.

Only plan and renewal_plan fields can be updated. Plan can only be changed to a plan of a longer commitment period. Attempting to change to a plan with shorter commitment period will fail with the error code google.rpc.Code.FAILED_PRECONDITION.

request - The metadata request object.

Request parameters:

name - Output only. The resource name of the capacity commitment, e.g., projects/myproject/locations/US/capacityCommitments/123 The commitment_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/capacityCommitments/\[^/\]+$.

updateMask - Standard field mask for the set of fields to be updated.

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

Completes with a CapacityCommitment.

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<CapacityCommitment> patch(
  CapacityCommitment request,
  core.String name, {
  core.String? updateMask,
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if (updateMask != null) 'updateMask': [updateMask],
    if ($fields != null) 'fields': [$fields],
  };

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

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