patch method

Future<CryptoKeyVersion> patch(
  1. CryptoKeyVersion request,
  2. String name, {
  3. String? updateMask,
  4. String? $fields,
})

Update a CryptoKeyVersion's metadata.

state may be changed between ENABLED and DISABLED using this method. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to move between other states.

request - The metadata request object.

Request parameters:

name - Output only. The resource name for this CryptoKeyVersion in the format projects / * /locations / * /keyRings / * /cryptoKeys / * /cryptoKeyVersions / * . Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/keyRings/\[^/\]+/cryptoKeys/\[^/\]+/cryptoKeyVersions/\[^/\]+$.

updateMask - Required. List of fields to be updated in this request.

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

Completes with a CryptoKeyVersion.

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<CryptoKeyVersion> patch(
  CryptoKeyVersion 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 CryptoKeyVersion.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}