Class PipelineServiceGrpc.PipelineServiceImplBase (3.5.0)

public abstract static class PipelineServiceGrpc.PipelineServiceImplBase implements BindableService

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 > PipelineServiceGrpc.PipelineServiceImplBase

Implements

io.grpc.BindableService

Constructors

PipelineServiceImplBase()

public PipelineServiceImplBase()

Methods

bindService()

public final ServerServiceDefinition bindService()
Returns
Type Description
io.grpc.ServerServiceDefinition

cancelPipelineJob(CancelPipelineJobRequest request, StreamObserver responseObserver)

public void cancelPipelineJob(CancelPipelineJobRequest request, StreamObserver responseObserver)

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.

Parameters
Name Description
request CancelPipelineJobRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

cancelTrainingPipeline(CancelTrainingPipelineRequest request, StreamObserver responseObserver)

public void cancelTrainingPipeline(CancelTrainingPipelineRequest request, StreamObserver responseObserver)

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.

Parameters
Name Description
request CancelTrainingPipelineRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

createPipelineJob(CreatePipelineJobRequest request, StreamObserver responseObserver)

public void createPipelineJob(CreatePipelineJobRequest request, StreamObserver responseObserver)

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

Parameters
Name Description
request CreatePipelineJobRequest
responseObserver io.grpc.stub.StreamObserver<PipelineJob>

createTrainingPipeline(CreateTrainingPipelineRequest request, StreamObserver responseObserver)

public void createTrainingPipeline(CreateTrainingPipelineRequest request, StreamObserver responseObserver)

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

Parameters
Name Description
request CreateTrainingPipelineRequest
responseObserver io.grpc.stub.StreamObserver<TrainingPipeline>

deletePipelineJob(DeletePipelineJobRequest request, StreamObserver responseObserver)

public void deletePipelineJob(DeletePipelineJobRequest request, StreamObserver responseObserver)

Deletes a PipelineJob.

Parameters
Name Description
request DeletePipelineJobRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteTrainingPipeline(DeleteTrainingPipelineRequest request, StreamObserver responseObserver)

public void deleteTrainingPipeline(DeleteTrainingPipelineRequest request, StreamObserver responseObserver)

Deletes a TrainingPipeline.

Parameters
Name Description
request DeleteTrainingPipelineRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

getPipelineJob(GetPipelineJobRequest request, StreamObserver responseObserver)

public void getPipelineJob(GetPipelineJobRequest request, StreamObserver responseObserver)

Gets a PipelineJob.

Parameters
Name Description
request GetPipelineJobRequest
responseObserver io.grpc.stub.StreamObserver<PipelineJob>

getTrainingPipeline(GetTrainingPipelineRequest request, StreamObserver responseObserver)

public void getTrainingPipeline(GetTrainingPipelineRequest request, StreamObserver responseObserver)

Gets a TrainingPipeline.

Parameters
Name Description
request GetTrainingPipelineRequest
responseObserver io.grpc.stub.StreamObserver<TrainingPipeline>

listPipelineJobs(ListPipelineJobsRequest request, StreamObserver responseObserver)

public void listPipelineJobs(ListPipelineJobsRequest request, StreamObserver responseObserver)

Lists PipelineJobs in a Location.

Parameters
Name Description
request ListPipelineJobsRequest
responseObserver io.grpc.stub.StreamObserver<ListPipelineJobsResponse>

listTrainingPipelines(ListTrainingPipelinesRequest request, StreamObserver responseObserver)

public void listTrainingPipelines(ListTrainingPipelinesRequest request, StreamObserver responseObserver)

Lists TrainingPipelines in a Location.

Parameters
Name Description
request ListTrainingPipelinesRequest
responseObserver io.grpc.stub.StreamObserver<ListTrainingPipelinesResponse>