class ProjectsLocationsTrainingPipelines extends Resource (View source)

The "trainingPipelines" collection of methods.

Typical usage is:

 $aiplatformService = new Google\Service\Aiplatform(...);
 $trainingPipelines = $aiplatformService->projects_locations_trainingPipelines;

Methods

cancel(string $name, GoogleCloudAiplatformV1CancelTrainingPipelineRequest $postBody, array $optParams = [])

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. (trainingPipelines.cancel)

create(string $parent, GoogleCloudAiplatformV1TrainingPipeline $postBody, array $optParams = [])

Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run. (trainingPipelines.create)

delete(string $name, array $optParams = [])

Deletes a TrainingPipeline. (trainingPipelines.delete)

get(string $name, array $optParams = [])

Gets a TrainingPipeline. (trainingPipelines.get)

listProjectsLocationsTrainingPipelines(string $parent, array $optParams = [])

Lists TrainingPipelines in a Location.

Details

GoogleProtobufEmpty cancel(string $name, GoogleCloudAiplatformV1CancelTrainingPipelineRequest $postBody, array $optParams = [])

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. (trainingPipelines.cancel)

Parameters

string $name

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

GoogleCloudAiplatformV1CancelTrainingPipelineRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

GoogleCloudAiplatformV1TrainingPipeline create(string $parent, GoogleCloudAiplatformV1TrainingPipeline $postBody, array $optParams = [])

Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run. (trainingPipelines.create)

Parameters

string $parent

Required. The resource name of the Location to create the TrainingPipeline in. Format: projects/{project}/locations/{location}

GoogleCloudAiplatformV1TrainingPipeline $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1TrainingPipeline

Exceptions

Exception

GoogleLongrunningOperation delete(string $name, array $optParams = [])

Deletes a TrainingPipeline. (trainingPipelines.delete)

Parameters

string $name

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

array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

GoogleCloudAiplatformV1TrainingPipeline get(string $name, array $optParams = [])

Gets a TrainingPipeline. (trainingPipelines.get)

Parameters

string $name

Required. The name of the TrainingPipeline resource. Format: projects/{project}/locations/{location}/trainingPipelines/{training_ pipeline}

array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1TrainingPipeline

Exceptions

Exception

GoogleCloudAiplatformV1ListTrainingPipelinesResponse listProjectsLocationsTrainingPipelines(string $parent, array $optParams = [])

Lists TrainingPipelines in a Location.

(trainingPipelines.listProjectsLocationsTrainingPipelines)

Parameters

string $parent

Required. The resource name of the Location to list the TrainingPipelines from. Format: projects/{project}/locations/{location}

array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1ListTrainingPipelinesResponse

Exceptions

Exception