Class PipelineServiceGrpc.PipelineServiceBlockingStub (3.15.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

build(Channel channel, CallOptions callOptions)

protected PipelineServiceGrpc.PipelineServiceBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
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
NameDescription
requestCancelPipelineJobRequest
Returns
TypeDescription
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
NameDescription
requestCancelTrainingPipelineRequest
Returns
TypeDescription
Empty

createPipelineJob(CreatePipelineJobRequest request)

public PipelineJob createPipelineJob(CreatePipelineJobRequest request)

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

Parameter
NameDescription
requestCreatePipelineJobRequest
Returns
TypeDescription
PipelineJob

createTrainingPipeline(CreateTrainingPipelineRequest request)

public TrainingPipeline createTrainingPipeline(CreateTrainingPipelineRequest request)

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

Parameter
NameDescription
requestCreateTrainingPipelineRequest
Returns
TypeDescription
TrainingPipeline

deletePipelineJob(DeletePipelineJobRequest request)

public Operation deletePipelineJob(DeletePipelineJobRequest request)

Deletes a PipelineJob.

Parameter
NameDescription
requestDeletePipelineJobRequest
Returns
TypeDescription
Operation

deleteTrainingPipeline(DeleteTrainingPipelineRequest request)

public Operation deleteTrainingPipeline(DeleteTrainingPipelineRequest request)

Deletes a TrainingPipeline.

Parameter
NameDescription
requestDeleteTrainingPipelineRequest
Returns
TypeDescription
Operation

getPipelineJob(GetPipelineJobRequest request)

public PipelineJob getPipelineJob(GetPipelineJobRequest request)

Gets a PipelineJob.

Parameter
NameDescription
requestGetPipelineJobRequest
Returns
TypeDescription
PipelineJob

getTrainingPipeline(GetTrainingPipelineRequest request)

public TrainingPipeline getTrainingPipeline(GetTrainingPipelineRequest request)

Gets a TrainingPipeline.

Parameter
NameDescription
requestGetTrainingPipelineRequest
Returns
TypeDescription
TrainingPipeline

listPipelineJobs(ListPipelineJobsRequest request)

public ListPipelineJobsResponse listPipelineJobs(ListPipelineJobsRequest request)

Lists PipelineJobs in a Location.

Parameter
NameDescription
requestListPipelineJobsRequest
Returns
TypeDescription
ListPipelineJobsResponse

listTrainingPipelines(ListTrainingPipelinesRequest request)

public ListTrainingPipelinesResponse listTrainingPipelines(ListTrainingPipelinesRequest request)

Lists TrainingPipelines in a Location.

Parameter
NameDescription
requestListTrainingPipelinesRequest
Returns
TypeDescription
ListTrainingPipelinesResponse