Google Cloud Ai Platform V1 Client - Class CancelTrainingPipelineRequest (0.17.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class CancelTrainingPipelineRequest.

Request message for PipelineService.CancelTrainingPipeline.

Generated from protobuf message google.cloud.aiplatform.v1.CancelTrainingPipelineRequest

Methods

build

Parameter
NameDescription
name string

Required. The name of the TrainingPipeline to cancel. Format: projects/{project}/locations/{location}/trainingPipelines/{training_pipeline} Please see {@see \Google\Cloud\AIPlatform\V1\PipelineServiceClient::trainingPipelineName()} for help formatting this field.

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\CancelTrainingPipelineRequest

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. The name of the TrainingPipeline to cancel. Format: projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}

getName

Required. The name of the TrainingPipeline to cancel.

Format: projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}

Returns
TypeDescription
string

setName

Required. The name of the TrainingPipeline to cancel.

Format: projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}

Parameter
NameDescription
var string
Returns
TypeDescription
$this