Class PipelineServiceGrpc.PipelineServiceStub (3.38.0)

public static final class PipelineServiceGrpc.PipelineServiceStub extends AbstractAsyncStub<PipelineServiceGrpc.PipelineServiceStub>

A stub to allow clients to do asynchronous 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.AbstractAsyncStub > PipelineServiceGrpc.PipelineServiceStub

Methods

build(Channel channel, CallOptions callOptions)

protected PipelineServiceGrpc.PipelineServiceStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
PipelineServiceGrpc.PipelineServiceStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

cancelPipelineJob(CancelPipelineJobRequest request, StreamObserver<Empty> responseObserver)

public void cancelPipelineJob(CancelPipelineJobRequest request, StreamObserver<Empty> 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
NameDescription
requestCancelPipelineJobRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

cancelTrainingPipeline(CancelTrainingPipelineRequest request, StreamObserver<Empty> responseObserver)

public void cancelTrainingPipeline(CancelTrainingPipelineRequest request, StreamObserver<Empty> 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
NameDescription
requestCancelTrainingPipelineRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

createPipelineJob(CreatePipelineJobRequest request, StreamObserver<PipelineJob> responseObserver)

public void createPipelineJob(CreatePipelineJobRequest request, StreamObserver<PipelineJob> responseObserver)

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

Parameters
NameDescription
requestCreatePipelineJobRequest
responseObserverio.grpc.stub.StreamObserver<PipelineJob>

createTrainingPipeline(CreateTrainingPipelineRequest request, StreamObserver<TrainingPipeline> responseObserver)

public void createTrainingPipeline(CreateTrainingPipelineRequest request, StreamObserver<TrainingPipeline> responseObserver)

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

Parameters
NameDescription
requestCreateTrainingPipelineRequest
responseObserverio.grpc.stub.StreamObserver<TrainingPipeline>

deletePipelineJob(DeletePipelineJobRequest request, StreamObserver<Operation> responseObserver)

public void deletePipelineJob(DeletePipelineJobRequest request, StreamObserver<Operation> responseObserver)

Deletes a PipelineJob.

Parameters
NameDescription
requestDeletePipelineJobRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

deleteTrainingPipeline(DeleteTrainingPipelineRequest request, StreamObserver<Operation> responseObserver)

public void deleteTrainingPipeline(DeleteTrainingPipelineRequest request, StreamObserver<Operation> responseObserver)

Deletes a TrainingPipeline.

Parameters
NameDescription
requestDeleteTrainingPipelineRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

getPipelineJob(GetPipelineJobRequest request, StreamObserver<PipelineJob> responseObserver)

public void getPipelineJob(GetPipelineJobRequest request, StreamObserver<PipelineJob> responseObserver)

Gets a PipelineJob.

Parameters
NameDescription
requestGetPipelineJobRequest
responseObserverio.grpc.stub.StreamObserver<PipelineJob>

getTrainingPipeline(GetTrainingPipelineRequest request, StreamObserver<TrainingPipeline> responseObserver)

public void getTrainingPipeline(GetTrainingPipelineRequest request, StreamObserver<TrainingPipeline> responseObserver)

Gets a TrainingPipeline.

Parameters
NameDescription
requestGetTrainingPipelineRequest
responseObserverio.grpc.stub.StreamObserver<TrainingPipeline>

listPipelineJobs(ListPipelineJobsRequest request, StreamObserver<ListPipelineJobsResponse> responseObserver)

public void listPipelineJobs(ListPipelineJobsRequest request, StreamObserver<ListPipelineJobsResponse> responseObserver)

Lists PipelineJobs in a Location.

Parameters
NameDescription
requestListPipelineJobsRequest
responseObserverio.grpc.stub.StreamObserver<ListPipelineJobsResponse>

listTrainingPipelines(ListTrainingPipelinesRequest request, StreamObserver<ListTrainingPipelinesResponse> responseObserver)

public void listTrainingPipelines(ListTrainingPipelinesRequest request, StreamObserver<ListTrainingPipelinesResponse> responseObserver)

Lists TrainingPipelines in a Location.

Parameters
NameDescription
requestListTrainingPipelinesRequest
responseObserverio.grpc.stub.StreamObserver<ListTrainingPipelinesResponse>