delete method

Future<Empty> delete(
  1. String name, {
  2. String? etag,
  3. String? requestId,
  4. bool? validateOnly,
  5. String? $fields,
})

Delete a single unit operation.

Request parameters:

name - Required. The resource name of the resource within a service. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/unitOperations/\[^/\]+$.

etag - The etag known to the client for the expected state of the unit operation. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the unit operation. The Any wildcard (*) requires that the resource must already exists, and the Not Any wildcard (!*) requires that it must not.

requestId - An optional request 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).

validateOnly - If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.

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

Completes with a Empty.

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<Empty> delete(
  core.String name, {
  core.String? etag,
  core.String? requestId,
  core.bool? validateOnly,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    'etag': ?etag == null ? null : [etag],
    'requestId': ?requestId == null ? null : [requestId],
    'validateOnly': ?validateOnly == null ? null : ['${validateOnly}'],
    'fields': ?$fields == null ? null : [$fields],
  };

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

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