delete method

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

Deletes a single DeliveryPipeline.

Request parameters:

name - Required. The name of the DeliveryPipeline to delete. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/deliveryPipelines/\[^/\]+$.

allowMissing - Optional. If set to true, then deleting an already deleted or non-existing DeliveryPipeline will succeed.

etag - Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

force - Optional. If set to true, all child resources under this pipeline will also be deleted. Otherwise, the request will only work if the pipeline has no child resources.

requestId - Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after 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 - Optional. If set, validate the request and preview the review, but do not actually post it.

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