Class PipelineServiceGrpc.PipelineServiceBlockingStub (3.42.0)

public static final class PipelineServiceGrpc.PipelineServiceBlockingStub extends AbstractBlockingStub<PipelineServiceGrpc.PipelineServiceBlockingStub>

A stub to allow clients to do synchronous rpc calls to service PipelineService.

A service for creating and managing Vertex AI's pipelines. This includes both TrainingPipeline resources (used for AutoML and custom training) and PipelineJob resources (used for Vertex AI Pipelines).

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > PipelineServiceGrpc.PipelineServiceBlockingStub

Methods

batchCancelPipelineJobs(BatchCancelPipelineJobsRequest request)

public Operation batchCancelPipelineJobs(BatchCancelPipelineJobsRequest request)

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.

Parameter
Name Description
request BatchCancelPipelineJobsRequest
Returns
Type Description
Operation

batchDeletePipelineJobs(BatchDeletePipelineJobsRequest request)

public Operation batchDeletePipelineJobs(BatchDeletePipelineJobsRequest request)

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.

Parameter
Name Description
request BatchDeletePipelineJobsRequest
Returns
Type Description
Operation

build(Channel channel, CallOptions callOptions)

protected PipelineServiceGrpc.PipelineServiceBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
PipelineServiceGrpc.PipelineServiceBlockingStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

cancelPipelineJob(CancelPipelineJobRequest request)

public Empty cancelPipelineJob(CancelPipelineJobRequest request)

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.

Parameter
Name Description
request CancelPipelineJobRequest
Returns
Type Description
Empty

cancelTrainingPipeline(CancelTrainingPipelineRequest request)

public Empty cancelTrainingPipeline(CancelTrainingPipelineRequest request)

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.

Parameter
Name Description
request CancelTrainingPipelineRequest
Returns
Type Description
Empty

createPipelineJob(CreatePipelineJobRequest request)

public PipelineJob createPipelineJob(CreatePipelineJobRequest request)

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

Parameter
Name Description
request CreatePipelineJobRequest
Returns
Type Description
PipelineJob

createTrainingPipeline(CreateTrainingPipelineRequest request)

public TrainingPipeline createTrainingPipeline(CreateTrainingPipelineRequest request)

Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.

Parameter
Name Description
request CreateTrainingPipelineRequest
Returns
Type Description
TrainingPipeline

deletePipelineJob(DeletePipelineJobRequest request)

public Operation deletePipelineJob(DeletePipelineJobRequest request)

Deletes a PipelineJob.

Parameter
Name Description
request DeletePipelineJobRequest
Returns
Type Description
Operation

deleteTrainingPipeline(DeleteTrainingPipelineRequest request)

public Operation deleteTrainingPipeline(DeleteTrainingPipelineRequest request)

Deletes a TrainingPipeline.

Parameter
Name Description
request DeleteTrainingPipelineRequest
Returns
Type Description
Operation

getPipelineJob(GetPipelineJobRequest request)

public PipelineJob getPipelineJob(GetPipelineJobRequest request)

Gets a PipelineJob.

Parameter
Name Description
request GetPipelineJobRequest
Returns
Type Description
PipelineJob

getTrainingPipeline(GetTrainingPipelineRequest request)

public TrainingPipeline getTrainingPipeline(GetTrainingPipelineRequest request)

Gets a TrainingPipeline.

Parameter
Name Description
request GetTrainingPipelineRequest
Returns
Type Description
TrainingPipeline

listPipelineJobs(ListPipelineJobsRequest request)

public ListPipelineJobsResponse listPipelineJobs(ListPipelineJobsRequest request)

Lists PipelineJobs in a Location.

Parameter
Name Description
request ListPipelineJobsRequest
Returns
Type Description
ListPipelineJobsResponse

listTrainingPipelines(ListTrainingPipelinesRequest request)

public ListTrainingPipelinesResponse listTrainingPipelines(ListTrainingPipelinesRequest request)

Lists TrainingPipelines in a Location.

Parameter
Name Description
request ListTrainingPipelinesRequest
Returns
Type Description
ListTrainingPipelinesResponse