com.google.cloud.aiplatform.v1beta1

Class PipelineServiceGrpc.PipelineServiceFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractFutureStub<PipelineServiceGrpc.PipelineServiceFutureStub>

com.google.cloud.aiplatform.v1beta1.PipelineServiceGrpc.PipelineServiceFutureStub

Enclosing class:

PipelineServiceGrpc

public static final class PipelineServiceGrpc.PipelineServiceFutureStub
extends io.grpc.stub.AbstractFutureStub<PipelineServiceGrpc.PipelineServiceFutureStub>

A stub to allow clients to do ListenableFuture-style 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
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	batchDeletePipelineJobs(BatchDeletePipelineJobsRequest request) Batch deletes PipelineJobs The Operation is atomic.
protected PipelineServiceGrpc.PipelineServiceFutureStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	cancelPipelineJob(CancelPipelineJobRequest request) Cancels a PipelineJob.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	cancelTrainingPipeline(CancelTrainingPipelineRequest request) Cancels a TrainingPipeline.
com.google.common.util.concurrent.ListenableFuture<PipelineJob>	createPipelineJob(CreatePipelineJobRequest request) Creates a PipelineJob.
com.google.common.util.concurrent.ListenableFuture<TrainingPipeline>	createTrainingPipeline(CreateTrainingPipelineRequest request) Creates a TrainingPipeline.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	deletePipelineJob(DeletePipelineJobRequest request) Deletes a PipelineJob.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	deleteTrainingPipeline(DeleteTrainingPipelineRequest request) Deletes a TrainingPipeline.
com.google.common.util.concurrent.ListenableFuture<PipelineJob>	getPipelineJob(GetPipelineJobRequest request) Gets a PipelineJob.
com.google.common.util.concurrent.ListenableFuture<TrainingPipeline>	getTrainingPipeline(GetTrainingPipelineRequest request) Gets a TrainingPipeline.
com.google.common.util.concurrent.ListenableFuture<ListPipelineJobsResponse>	listPipelineJobs(ListPipelineJobsRequest request) Lists PipelineJobs in a Location.
com.google.common.util.concurrent.ListenableFuture<ListTrainingPipelinesResponse>	listTrainingPipelines(ListTrainingPipelinesRequest request) Lists TrainingPipelines in a Location.

Methods inherited from class io.grpc.stub.AbstractFutureStub

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.PipelineServiceFutureStub build(io.grpc.Channel channel,
                                                              io.grpc.CallOptions callOptions)

Specified by:

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

createTrainingPipeline

public com.google.common.util.concurrent.ListenableFuture<TrainingPipeline> createTrainingPipeline(CreateTrainingPipelineRequest request)

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

getTrainingPipeline

public com.google.common.util.concurrent.ListenableFuture<TrainingPipeline> getTrainingPipeline(GetTrainingPipelineRequest request)

 Gets a TrainingPipeline.
 

listTrainingPipelines

public com.google.common.util.concurrent.ListenableFuture<ListTrainingPipelinesResponse> listTrainingPipelines(ListTrainingPipelinesRequest request)

 Lists TrainingPipelines in a Location.
 

deleteTrainingPipeline

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> deleteTrainingPipeline(DeleteTrainingPipelineRequest request)

 Deletes a TrainingPipeline.
 

cancelTrainingPipeline

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.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][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 com.google.common.util.concurrent.ListenableFuture<PipelineJob> createPipelineJob(CreatePipelineJobRequest request)

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

getPipelineJob

public com.google.common.util.concurrent.ListenableFuture<PipelineJob> getPipelineJob(GetPipelineJobRequest request)

 Gets a PipelineJob.
 

listPipelineJobs

public com.google.common.util.concurrent.ListenableFuture<ListPipelineJobsResponse> listPipelineJobs(ListPipelineJobsRequest request)

 Lists PipelineJobs in a Location.
 

deletePipelineJob

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> deletePipelineJob(DeletePipelineJobRequest request)

 Deletes a PipelineJob.
 

batchDeletePipelineJobs

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.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.
 

cancelPipelineJob

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.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][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`.