delete method

Future<Operation> delete(
  1. String name, {
  2. bool? ignoreActiveCertificates,
  3. bool? ignoreDependentResources,
  4. String? requestId,
  5. bool? skipGracePeriod,
  6. String? $fields,
})

Delete a CertificateAuthority.

Request parameters:

name - Required. The resource name for this CertificateAuthority in the format `projects / * /locations / * /caPools / * /certificateAuthorities /

  • . Value must have pattern ^projects/[^/]+/locations/[^/]+/caPools/[^/]+/certificateAuthorities/[^/]+$`.

ignoreActiveCertificates - Optional. This field allows the CA to be deleted even if the CA has active certs. Active certs include both unrevoked and unexpired certs.

ignoreDependentResources - Optional. This field allows this CA to be deleted even if it's being depended on by another resource. However, doing so may result in unintended and unrecoverable effects on any dependent resources since the CA will no longer be able to issue certificates.

requestId - Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

skipGracePeriod - Optional. If this flag is set, the Certificate Authority will be deleted as soon as possible without a 30-day grace period where undeletion would have been allowed. If you proceed, there will be no way to recover this CA.

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

Completes with a Operation.

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<Operation> delete(
  core.String name, {
  core.bool? ignoreActiveCertificates,
  core.bool? ignoreDependentResources,
  core.String? requestId,
  core.bool? skipGracePeriod,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (ignoreActiveCertificates != null)
      'ignoreActiveCertificates': ['${ignoreActiveCertificates}'],
    if (ignoreDependentResources != null)
      'ignoreDependentResources': ['${ignoreDependentResources}'],
    if (requestId != null) 'requestId': [requestId],
    if (skipGracePeriod != null) 'skipGracePeriod': ['${skipGracePeriod}'],
    if ($fields != null) 'fields': [$fields],
  };

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

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