cancel method
- GoogleCloudAiplatformV1CancelTuningJobRequest request,
- String name, {
- String? $fields,
Cancels a TuningJob.
Starts asynchronous cancellation on the TuningJob. The server makes a best
effort to cancel the job, but success is not guaranteed. Clients can use
GenAiTuningService.GetTuningJob or other methods to check whether the
cancellation succeeded or whether the job completed despite cancellation.
On successful cancellation, the TuningJob is not deleted; instead it
becomes a job with a TuningJob.error value with a google.rpc.Status.code
of 1, corresponding to Code.CANCELLED
, and TuningJob.state is set to
CANCELLED
.
request
- The metadata request object.
Request parameters:
name
- Required. The name of the TuningJob to cancel. Format:
projects/{project}/locations/{location}/tuningJobs/{tuning_job}
Value must have pattern
^projects/\[^/\]+/locations/\[^/\]+/tuningJobs/\[^/\]+$
.
$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(
GoogleCloudAiplatformV1CancelTuningJobRequest 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>);
}