Class PipelineServiceGrpc.PipelineServiceFutureStub (3.52.0)

public static final class PipelineServiceGrpc.PipelineServiceFutureStub extends 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).

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > PipelineServiceGrpc.PipelineServiceFutureStub

Inherited Members

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withOnReadyThreshold(int)

io.grpc.stub.AbstractStub.withWaitForReady()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

batchCancelPipelineJobs(BatchCancelPipelineJobsRequest request)

public ListenableFuture<Operation> batchCancelPipelineJobs(BatchCancelPipelineJobsRequest request)

Batch cancel PipelineJobs. Firstly the server will check if all the jobs are in non-terminal states, and skip the jobs that are already terminated. If the operation failed, none of the pipeline jobs are cancelled. The server will poll the states of all the pipeline jobs periodically to check the cancellation status. This operation will return an LRO.

Parameter
Name	Description
`request`	`BatchCancelPipelineJobsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

batchDeletePipelineJobs(BatchDeletePipelineJobsRequest request)

public ListenableFuture<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.

Parameter
Name	Description
`request`	`BatchDeletePipelineJobsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

build(Channel channel, CallOptions callOptions)

protected PipelineServiceGrpc.PipelineServiceFutureStub build(Channel channel, CallOptions callOptions)

Parameters
Name	Description
`channel`	`io.grpc.Channel`
`callOptions`	`io.grpc.CallOptions`

Returns
Type	Description
`PipelineServiceGrpc.PipelineServiceFutureStub`

Overrides

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

cancelPipelineJob(CancelPipelineJobRequest request)

public ListenableFuture<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
Name	Description
`request`	`CancelPipelineJobRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Empty>`

cancelTrainingPipeline(CancelTrainingPipelineRequest request)

public ListenableFuture<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
Name	Description
`request`	`CancelTrainingPipelineRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Empty>`

createPipelineJob(CreatePipelineJobRequest request)

public ListenableFuture<PipelineJob> createPipelineJob(CreatePipelineJobRequest request)

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

Parameter
Name	Description
`request`	`CreatePipelineJobRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<PipelineJob>`

createTrainingPipeline(CreateTrainingPipelineRequest request)

public ListenableFuture<TrainingPipeline> createTrainingPipeline(CreateTrainingPipelineRequest request)

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

Parameter
Name	Description
`request`	`CreateTrainingPipelineRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<TrainingPipeline>`

deletePipelineJob(DeletePipelineJobRequest request)

public ListenableFuture<Operation> deletePipelineJob(DeletePipelineJobRequest request)

Deletes a PipelineJob.

Parameter
Name	Description
`request`	`DeletePipelineJobRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

deleteTrainingPipeline(DeleteTrainingPipelineRequest request)

public ListenableFuture<Operation> deleteTrainingPipeline(DeleteTrainingPipelineRequest request)

Deletes a TrainingPipeline.

Parameter
Name	Description
`request`	`DeleteTrainingPipelineRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

getPipelineJob(GetPipelineJobRequest request)

public ListenableFuture<PipelineJob> getPipelineJob(GetPipelineJobRequest request)

Gets a PipelineJob.

Parameter
Name	Description
`request`	`GetPipelineJobRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<PipelineJob>`

getTrainingPipeline(GetTrainingPipelineRequest request)

public ListenableFuture<TrainingPipeline> getTrainingPipeline(GetTrainingPipelineRequest request)

Gets a TrainingPipeline.

Parameter
Name	Description
`request`	`GetTrainingPipelineRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<TrainingPipeline>`

listPipelineJobs(ListPipelineJobsRequest request)

public ListenableFuture<ListPipelineJobsResponse> listPipelineJobs(ListPipelineJobsRequest request)

Lists PipelineJobs in a Location.

Parameter
Name	Description
`request`	`ListPipelineJobsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListPipelineJobsResponse>`

listTrainingPipelines(ListTrainingPipelinesRequest request)

public ListenableFuture<ListTrainingPipelinesResponse> listTrainingPipelines(ListTrainingPipelinesRequest request)

Lists TrainingPipelines in a Location.

Parameter
Name	Description
`request`	`ListTrainingPipelinesRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListTrainingPipelinesResponse>`