cancel method
- GoogleCloudAiplatformV1CancelCustomJobRequest request,
- String name, {
- String? $fields,
Cancels a CustomJob.
Starts asynchronous cancellation on the CustomJob. The server makes a best
effort to cancel the job, but success is not guaranteed. Clients can use
JobService.GetCustomJob or other methods to check whether the cancellation
succeeded or whether the job completed despite cancellation. On successful
cancellation, the CustomJob is not deleted; instead it becomes a job with
a CustomJob.error value with a google.rpc.Status.code of 1, corresponding
to Code.CANCELLED
, and CustomJob.state is set to CANCELLED
.
request
- The metadata request object.
Request parameters:
name
- Required. The name of the CustomJob to cancel. Format:
projects/{project}/locations/{location}/customJobs/{custom_job}
Value must have pattern
^projects/\[^/\]+/locations/\[^/\]+/customJobs/\[^/\]+$
.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a GoogleProtobufEmpty.
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<GoogleProtobufEmpty> cancel(
GoogleCloudAiplatformV1CancelCustomJobRequest request,
core.String name, {
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$name') + ':cancel';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return GoogleProtobufEmpty.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}