Interface PipelineServiceGrpc.AsyncService (3.49.0)

public static interface PipelineServiceGrpc.AsyncService

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).

Methods

batchCancelPipelineJobs(BatchCancelPipelineJobsRequest request, StreamObserver<Operation> responseObserver)

public default void batchCancelPipelineJobs(BatchCancelPipelineJobsRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
Name Description
request BatchCancelPipelineJobsRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

batchDeletePipelineJobs(BatchDeletePipelineJobsRequest request, StreamObserver<Operation> responseObserver)

public default void batchDeletePipelineJobs(BatchDeletePipelineJobsRequest request, StreamObserver<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.

Parameters
Name Description
request BatchDeletePipelineJobsRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

cancelPipelineJob(CancelPipelineJobRequest request, StreamObserver<Empty> responseObserver)

public default void cancelPipelineJob(CancelPipelineJobRequest request, StreamObserver<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 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.

Parameters
Name Description
request CancelPipelineJobRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

cancelTrainingPipeline(CancelTrainingPipelineRequest request, StreamObserver<Empty> responseObserver)

public default void cancelTrainingPipeline(CancelTrainingPipelineRequest request, StreamObserver<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 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.

Parameters
Name Description
request CancelTrainingPipelineRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

createPipelineJob(CreatePipelineJobRequest request, StreamObserver<PipelineJob> responseObserver)

public default void createPipelineJob(CreatePipelineJobRequest request, StreamObserver<PipelineJob> responseObserver)

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

Parameters
Name Description
request CreatePipelineJobRequest
responseObserver io.grpc.stub.StreamObserver<PipelineJob>

createTrainingPipeline(CreateTrainingPipelineRequest request, StreamObserver<TrainingPipeline> responseObserver)

public default void createTrainingPipeline(CreateTrainingPipelineRequest request, StreamObserver<TrainingPipeline> responseObserver)

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

Parameters
Name Description
request CreateTrainingPipelineRequest
responseObserver io.grpc.stub.StreamObserver<TrainingPipeline>

deletePipelineJob(DeletePipelineJobRequest request, StreamObserver<Operation> responseObserver)

public default void deletePipelineJob(DeletePipelineJobRequest request, StreamObserver<Operation> responseObserver)

Deletes a PipelineJob.

Parameters
Name Description
request DeletePipelineJobRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteTrainingPipeline(DeleteTrainingPipelineRequest request, StreamObserver<Operation> responseObserver)

public default void deleteTrainingPipeline(DeleteTrainingPipelineRequest request, StreamObserver<Operation> responseObserver)

Deletes a TrainingPipeline.

Parameters
Name Description
request DeleteTrainingPipelineRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

getPipelineJob(GetPipelineJobRequest request, StreamObserver<PipelineJob> responseObserver)

public default void getPipelineJob(GetPipelineJobRequest request, StreamObserver<PipelineJob> responseObserver)

Gets a PipelineJob.

Parameters
Name Description
request GetPipelineJobRequest
responseObserver io.grpc.stub.StreamObserver<PipelineJob>

getTrainingPipeline(GetTrainingPipelineRequest request, StreamObserver<TrainingPipeline> responseObserver)

public default void getTrainingPipeline(GetTrainingPipelineRequest request, StreamObserver<TrainingPipeline> responseObserver)

Gets a TrainingPipeline.

Parameters
Name Description
request GetTrainingPipelineRequest
responseObserver io.grpc.stub.StreamObserver<TrainingPipeline>

listPipelineJobs(ListPipelineJobsRequest request, StreamObserver<ListPipelineJobsResponse> responseObserver)

public default void listPipelineJobs(ListPipelineJobsRequest request, StreamObserver<ListPipelineJobsResponse> responseObserver)

Lists PipelineJobs in a Location.

Parameters
Name Description
request ListPipelineJobsRequest
responseObserver io.grpc.stub.StreamObserver<ListPipelineJobsResponse>

listTrainingPipelines(ListTrainingPipelinesRequest request, StreamObserver<ListTrainingPipelinesResponse> responseObserver)

public default void listTrainingPipelines(ListTrainingPipelinesRequest request, StreamObserver<ListTrainingPipelinesResponse> responseObserver)

Lists TrainingPipelines in a Location.

Parameters
Name Description
request ListTrainingPipelinesRequest
responseObserver io.grpc.stub.StreamObserver<ListTrainingPipelinesResponse>