class ProjectsLocationsPipelineJobs extends Resource (View source)

The "pipelineJobs" collection of methods.

Typical usage is:

 $aiplatformService = new Google\Service\Aiplatform(...);
 $pipelineJobs = $aiplatformService->projects_locations_pipelineJobs;

Methods

batchCancel(string $parent, GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest $postBody, array $optParams = [])

Batch cancel PipelineJobs. Firstly the server will check if all the jobs are in non-terminal states, and skip the jobs that are already terminated. If the operation failed, none of the pipeline jobs are cancelled. The server will poll the states of all the pipeline jobs periodically to check the cancellation status. This operation will return an LRO.

batchDelete(string $parent, GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest $postBody, array $optParams = [])

Batch deletes PipelineJobs The Operation is atomic. If it fails, none of the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs are deleted. (pipelineJobs.batchDelete)

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

Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob.

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

Creates a PipelineJob. A PipelineJob will run immediately when created.

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

Deletes a PipelineJob. (pipelineJobs.delete)

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

Gets a PipelineJob. (pipelineJobs.get)

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

Lists PipelineJobs in a Location.

Details

GoogleLongrunningOperation batchCancel(string $parent, GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest $postBody, array $optParams = [])

Batch cancel PipelineJobs. Firstly the server will check if all the jobs are in non-terminal states, and skip the jobs that are already terminated. If the operation failed, none of the pipeline jobs are cancelled. The server will poll the states of all the pipeline jobs periodically to check the cancellation status. This operation will return an LRO.

(pipelineJobs.batchCancel)

Parameters

string $parent

Required. The name of the PipelineJobs' parent resource. Format: projects/{project}/locations/{location}

GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

GoogleLongrunningOperation batchDelete(string $parent, GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest $postBody, array $optParams = [])

Batch deletes PipelineJobs The Operation is atomic. If it fails, none of the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs are deleted. (pipelineJobs.batchDelete)

Parameters

string $parent

Required. The name of the PipelineJobs' parent resource. Format: projects/{project}/locations/{location}

GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

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

Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob.

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

Parameters

string $name

Required. The name of the PipelineJob to cancel. Format: projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}

GoogleCloudAiplatformV1CancelPipelineJobRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

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

Creates a PipelineJob. A PipelineJob will run immediately when created.

(pipelineJobs.create)

Parameters

string $parent

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

GoogleCloudAiplatformV1PipelineJob $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1PipelineJob

Exceptions

Exception

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

Deletes a PipelineJob. (pipelineJobs.delete)

Parameters

string $name

Required. The name of the PipelineJob resource to be deleted. Format: projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}

array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

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

Gets a PipelineJob. (pipelineJobs.get)

Parameters

string $name

Required. The name of the PipelineJob resource. Format: projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}

array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1PipelineJob

Exceptions

Exception

GoogleCloudAiplatformV1ListPipelineJobsResponse listProjectsLocationsPipelineJobs(string $parent, array $optParams = [])

Lists PipelineJobs in a Location.

(pipelineJobs.listProjectsLocationsPipelineJobs)

Parameters

string $parent

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

array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1ListPipelineJobsResponse

Exceptions

Exception