Class PipelineServiceGrpc.PipelineServiceBlockingStub (3.4.1)

public static final class PipelineServiceGrpc.PipelineServiceBlockingStub extends AbstractBlockingStub<PipelineServiceGrpc.PipelineServiceBlockingStub>

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.AbstractBlockingStub > PipelineServiceGrpc.PipelineServiceBlockingStub

Inherited Members

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

io.grpc.stub.AbstractBlockingStub.<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.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

build(Channel channel, CallOptions callOptions)

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

Parameters

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

Returns

Type	Description
PipelineServiceGrpc.PipelineServiceBlockingStub

Overrides

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

cancelPipelineJob(CancelPipelineJobRequest request)

public 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
Empty

cancelTrainingPipeline(CancelTrainingPipelineRequest request)

public 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
Empty

createPipelineJob(CreatePipelineJobRequest request)

public PipelineJob createPipelineJob(CreatePipelineJobRequest request)

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

Parameter

Name	Description
request	`CreatePipelineJobRequest`

Returns

Type	Description
PipelineJob

createTrainingPipeline(CreateTrainingPipelineRequest request)

public 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
TrainingPipeline

deletePipelineJob(DeletePipelineJobRequest request)

public Operation deletePipelineJob(DeletePipelineJobRequest request)

Deletes a PipelineJob.

Parameter

Name	Description
request	`DeletePipelineJobRequest`

Returns

Type	Description
Operation

deleteTrainingPipeline(DeleteTrainingPipelineRequest request)

public Operation deleteTrainingPipeline(DeleteTrainingPipelineRequest request)

Deletes a TrainingPipeline.

Parameter

Name	Description
request	`DeleteTrainingPipelineRequest`

Returns

Type	Description
Operation

getPipelineJob(GetPipelineJobRequest request)

public PipelineJob getPipelineJob(GetPipelineJobRequest request)

Gets a PipelineJob.

Parameter

Name	Description
request	`GetPipelineJobRequest`

Returns

Type	Description
PipelineJob

getTrainingPipeline(GetTrainingPipelineRequest request)

public TrainingPipeline getTrainingPipeline(GetTrainingPipelineRequest request)

Gets a TrainingPipeline.

Parameter

Name	Description
request	`GetTrainingPipelineRequest`

Returns

Type	Description
TrainingPipeline

listPipelineJobs(ListPipelineJobsRequest request)

public ListPipelineJobsResponse listPipelineJobs(ListPipelineJobsRequest request)

Lists PipelineJobs in a Location.

Parameter

Name	Description
request	`ListPipelineJobsRequest`

Returns

Type	Description
ListPipelineJobsResponse

listTrainingPipelines(ListTrainingPipelinesRequest request)

public ListTrainingPipelinesResponse listTrainingPipelines(ListTrainingPipelinesRequest request)

Lists TrainingPipelines in a Location.

Parameter

Name	Description
request	`ListTrainingPipelinesRequest`

Returns

Type	Description
ListTrainingPipelinesResponse