com.google.cloud.aiplatform.v1beta1

Class PipelineServiceGrpc.PipelineServiceStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractAsyncStub<PipelineServiceGrpc.PipelineServiceStub>

com.google.cloud.aiplatform.v1beta1.PipelineServiceGrpc.PipelineServiceStub

Enclosing class:

PipelineServiceGrpc

public static final class PipelineServiceGrpc.PipelineServiceStub
extends io.grpc.stub.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).
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method and Description
void	batchDeletePipelineJobs(BatchDeletePipelineJobsRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Batch deletes PipelineJobs The Operation is atomic.
protected PipelineServiceGrpc.PipelineServiceStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
void	cancelPipelineJob(CancelPipelineJobRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Cancels a PipelineJob.
void	cancelTrainingPipeline(CancelTrainingPipelineRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Cancels a TrainingPipeline.
void	createPipelineJob(CreatePipelineJobRequest request, io.grpc.stub.StreamObserver<PipelineJob> responseObserver) Creates a PipelineJob.
void	createTrainingPipeline(CreateTrainingPipelineRequest request, io.grpc.stub.StreamObserver<TrainingPipeline> responseObserver) Creates a TrainingPipeline.
void	deletePipelineJob(DeletePipelineJobRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Deletes a PipelineJob.
void	deleteTrainingPipeline(DeleteTrainingPipelineRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Deletes a TrainingPipeline.
void	getPipelineJob(GetPipelineJobRequest request, io.grpc.stub.StreamObserver<PipelineJob> responseObserver) Gets a PipelineJob.
void	getTrainingPipeline(GetTrainingPipelineRequest request, io.grpc.stub.StreamObserver<TrainingPipeline> responseObserver) Gets a TrainingPipeline.
void	listPipelineJobs(ListPipelineJobsRequest request, io.grpc.stub.StreamObserver<ListPipelineJobsResponse> responseObserver) Lists PipelineJobs in a Location.
void	listTrainingPipelines(ListTrainingPipelinesRequest request, io.grpc.stub.StreamObserver<ListTrainingPipelinesResponse> responseObserver) Lists TrainingPipelines in a Location.

Methods inherited from class io.grpc.stub.AbstractAsyncStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

protected PipelineServiceGrpc.PipelineServiceStub build(io.grpc.Channel channel,
                                                        io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<PipelineServiceGrpc.PipelineServiceStub>

createTrainingPipeline

public void createTrainingPipeline(CreateTrainingPipelineRequest request,
                                   io.grpc.stub.StreamObserver<TrainingPipeline> responseObserver)

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

getTrainingPipeline

public void getTrainingPipeline(GetTrainingPipelineRequest request,
                                io.grpc.stub.StreamObserver<TrainingPipeline> responseObserver)

 Gets a TrainingPipeline.
 

listTrainingPipelines

public void listTrainingPipelines(ListTrainingPipelinesRequest request,
                                  io.grpc.stub.StreamObserver<ListTrainingPipelinesResponse> responseObserver)

 Lists TrainingPipelines in a Location.
 

deleteTrainingPipeline

public void deleteTrainingPipeline(DeleteTrainingPipelineRequest request,
                                   io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 Deletes a TrainingPipeline.
 

cancelTrainingPipeline

public void cancelTrainingPipeline(CancelTrainingPipelineRequest request,
                                   io.grpc.stub.StreamObserver<com.google.protobuf.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][google.cloud.aiplatform.v1beta1.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][google.cloud.aiplatform.v1beta1.TrainingPipeline.error]
 value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
 corresponding to `Code.CANCELLED`, and
 [TrainingPipeline.state][google.cloud.aiplatform.v1beta1.TrainingPipeline.state]
 is set to `CANCELLED`.
 

createPipelineJob

public void createPipelineJob(CreatePipelineJobRequest request,
                              io.grpc.stub.StreamObserver<PipelineJob> responseObserver)

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

getPipelineJob

public void getPipelineJob(GetPipelineJobRequest request,
                           io.grpc.stub.StreamObserver<PipelineJob> responseObserver)

 Gets a PipelineJob.
 

listPipelineJobs

public void listPipelineJobs(ListPipelineJobsRequest request,
                             io.grpc.stub.StreamObserver<ListPipelineJobsResponse> responseObserver)

 Lists PipelineJobs in a Location.
 

deletePipelineJob

public void deletePipelineJob(DeletePipelineJobRequest request,
                              io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 Deletes a PipelineJob.
 

batchDeletePipelineJobs

public void batchDeletePipelineJobs(BatchDeletePipelineJobsRequest request,
                                    io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 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.
 

cancelPipelineJob

public void cancelPipelineJob(CancelPipelineJobRequest request,
                              io.grpc.stub.StreamObserver<com.google.protobuf.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][google.cloud.aiplatform.v1beta1.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][google.cloud.aiplatform.v1beta1.PipelineJob.error]
 value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
 corresponding to `Code.CANCELLED`, and
 [PipelineJob.state][google.cloud.aiplatform.v1beta1.PipelineJob.state] is
 set to `CANCELLED`.