com.google.cloud.aiplatform.v1beta1

Class PipelineServiceGrpc.PipelineServiceBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<PipelineServiceGrpc.PipelineServiceBlockingStub>

com.google.cloud.aiplatform.v1beta1.PipelineServiceGrpc.PipelineServiceBlockingStub

Enclosing class:

PipelineServiceGrpc

public static final class PipelineServiceGrpc.PipelineServiceBlockingStub
extends io.grpc.stub.AbstractBlockingStub<PipelineServiceGrpc.PipelineServiceBlockingStub>

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

Methods inherited from class io.grpc.stub.AbstractBlockingStub

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

Specified by:

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

createTrainingPipeline

public TrainingPipeline createTrainingPipeline(CreateTrainingPipelineRequest request)

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

getTrainingPipeline

public TrainingPipeline getTrainingPipeline(GetTrainingPipelineRequest request)

 Gets a TrainingPipeline.
 

listTrainingPipelines

public ListTrainingPipelinesResponse listTrainingPipelines(ListTrainingPipelinesRequest request)

 Lists TrainingPipelines in a Location.
 

deleteTrainingPipeline

public com.google.longrunning.Operation deleteTrainingPipeline(DeleteTrainingPipelineRequest request)

 Deletes a TrainingPipeline.
 

cancelTrainingPipeline

public 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 PipelineJob createPipelineJob(CreatePipelineJobRequest request)

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

getPipelineJob

public PipelineJob getPipelineJob(GetPipelineJobRequest request)

 Gets a PipelineJob.
 

listPipelineJobs

public ListPipelineJobsResponse listPipelineJobs(ListPipelineJobsRequest request)

 Lists PipelineJobs in a Location.
 

deletePipelineJob

public com.google.longrunning.Operation deletePipelineJob(DeletePipelineJobRequest request)

 Deletes a PipelineJob.
 

batchDeletePipelineJobs

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