destroy method

Future<CryptoKeyVersion> destroy(
  1. DestroyCryptoKeyVersionRequest request,
  2. String name, {
  3. String? $fields,
})

Schedule a CryptoKeyVersion for destruction.

Upon calling this method, CryptoKeyVersion.state will be set to DESTROY_SCHEDULED, and destroy_time will be set to the time destroy_scheduled_duration in the future. At that time, the state will automatically change to DESTROYED, and the key material will be irrevocably destroyed. Before the destroy_time is reached, RestoreCryptoKeyVersion may be called to reverse the process.

request - The metadata request object.

Request parameters:

name - Required. The resource name of the CryptoKeyVersion to destroy. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/keyRings/\[^/\]+/cryptoKeys/\[^/\]+/cryptoKeyVersions/\[^/\]+$.

$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> destroy(
  DestroyCryptoKeyVersionRequest 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') + ':destroy';

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