delete method

Future<Status> delete(
  1. String name, {
  2. String? apiVersion,
  3. String? kind,
  4. String? propagationPolicy,
  5. String? $fields,
})

Delete a job.

Request parameters:

name - Required. The name of the job to delete. Replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID Value must have pattern ^namespaces/\[^/\]+/jobs/\[^/\]+$.

apiVersion - Optional. Cloud Run currently ignores this parameter.

kind - Optional. Cloud Run currently ignores this parameter.

propagationPolicy - Optional. Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information.

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

Completes with a Status.

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

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

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