- 3.56.0 (latest)
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.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> |