Class ProjectsResource.LocationsResource.TrainingPipelinesResource.CancelRequest

Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetTrainingPipeline or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a TrainingPipeline.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and TrainingPipeline.state is set to CANCELLED.

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

Constructors

CancelRequest(IClientService, GoogleCloudAiplatformV1beta1CancelTrainingPipelineRequest, string)

Constructs a new Cancel request.

Declaration
public CancelRequest(IClientService service, GoogleCloudAiplatformV1beta1CancelTrainingPipelineRequest body, string name)
Parameters
Type Name Description
IClientService service
GoogleCloudAiplatformV1beta1CancelTrainingPipelineRequest 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 TrainingPipeline to cancel. Format: projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}

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