delete method

Future<GoogleLongrunningOperation> delete(
  1. String name, {
  2. String? retention,
  3. String? $fields,
})

Delete an Apigee organization.

For organizations with BillingType EVALUATION, an immediate deletion is performed. For paid organizations, a soft-deletion is performed. The organization can be restored within the soft-deletion period which can be controlled using the retention field in the request.

Request parameters:

name - Required. Name of the organization. Use the following structure in your request: organizations/{org} Value must have pattern ^organizations/\[^/\]+$.

retention - Optional. This setting is applicable only for organizations that are soft-deleted (i.e., BillingType is not EVALUATION). It controls how long Organization data will be retained after the initial delete operation completes. During this period, the Organization may be restored to its last known state. After this period, the Organization will no longer be able to be restored. Possible string values are:

  • "DELETION_RETENTION_UNSPECIFIED" : Default data retention setting of seven days will be applied.
  • "MINIMUM" : Organization data will be retained for the minimum period of 24 hours.

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

Completes with a GoogleLongrunningOperation.

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

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

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