Class ProjectsResource.LocationsResource.BatchPredictionJobsResource.CancelRequest
Cancels a BatchPredictionJob. Starts asynchronous cancellation on the BatchPredictionJob. The server
makes the best effort to cancel the job, but success is not guaranteed. Clients can use
JobService.GetBatchPredictionJob or other methods to check whether the cancellation succeeded or
whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob
is not deleted;instead its BatchPredictionJob.state is set to CANCELLED
. Any files already
outputted by the job are not deleted.
Inheritance
Inherited Members
Namespace: Google.Apis.Aiplatform.v1
Assembly: Google.Apis.Aiplatform.v1.dll
Syntax
public class ProjectsResource.LocationsResource.BatchPredictionJobsResource.CancelRequest : AiplatformBaseServiceRequest<GoogleProtobufEmpty>, IClientServiceRequest<GoogleProtobufEmpty>, IClientServiceRequest
Constructors
CancelRequest(IClientService, GoogleCloudAiplatformV1CancelBatchPredictionJobRequest, string)
Constructs a new Cancel request.
Declaration
public CancelRequest(IClientService service, GoogleCloudAiplatformV1CancelBatchPredictionJobRequest body, string name)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service | |
GoogleCloudAiplatformV1CancelBatchPredictionJobRequest | 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 BatchPredictionJob to cancel. Format:
projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_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()