Class ProjectsResource.LocationsResource.CustomJobsResource.CancelRequest

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.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<GoogleProtobufEmpty>
AiplatformBaseServiceRequest<GoogleProtobufEmpty>
ProjectsResource.LocationsResource.CustomJobsResource.CancelRequest
Implements
Inherited Members
Namespace: Google.Apis.Aiplatform.v1
Assembly: Google.Apis.Aiplatform.v1.dll
Syntax
public class ProjectsResource.LocationsResource.CustomJobsResource.CancelRequest : AiplatformBaseServiceRequest<GoogleProtobufEmpty>, IClientServiceRequest<GoogleProtobufEmpty>, IClientServiceRequest

Constructors

CancelRequest(IClientService, GoogleCloudAiplatformV1CancelCustomJobRequest, string)

Constructs a new Cancel request.

Declaration
public CancelRequest(IClientService service, GoogleCloudAiplatformV1CancelCustomJobRequest body, string name)
Parameters
Type Name Description
IClientService service
GoogleCloudAiplatformV1CancelCustomJobRequest 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 CustomJob to cancel. Format: projects/{project}/locations/{location}/customJobs/{custom_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()
Overrides

Implements