Class ProjectsResource.LocationsResource.TuningJobsResource.CancelRequest
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
.
Inheritance
Inherited Members
Namespace: Google.Apis.Aiplatform.v1beta1
Assembly: Google.Apis.Aiplatform.v1beta1.dll
Syntax
public class ProjectsResource.LocationsResource.TuningJobsResource.CancelRequest : AiplatformBaseServiceRequest<GoogleProtobufEmpty>, IClientServiceRequest<GoogleProtobufEmpty>, IClientServiceRequest
Constructors
CancelRequest(IClientService, GoogleCloudAiplatformV1beta1CancelTuningJobRequest, string)
Constructs a new Cancel request.
Declaration
public CancelRequest(IClientService service, GoogleCloudAiplatformV1beta1CancelTuningJobRequest body, string name)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service | |
GoogleCloudAiplatformV1beta1CancelTuningJobRequest | body | |
string | name |
Properties
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
Name
Required. The name of the TuningJob to cancel. Format:
projects/{project}/locations/{location}/tuningJobs/{tuning_job}
Declaration
[RequestParameter("name", RequestParameterType.Path)]
public virtual string Name { get; }
Property Value
Type | Description |
---|---|
string |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
Methods
GetBody()
Returns the body of the request.
Declaration
protected override object GetBody()
Returns
Type | Description |
---|---|
object |
Overrides
InitParameters()
Initializes Cancel parameter list.
Declaration
protected override void InitParameters()