Interface JobServiceGrpc.AsyncService (3.64.0)

public static interface JobServiceGrpc.AsyncService

A service for creating and managing Vertex AI's jobs.

Methods

cancelBatchPredictionJob(CancelBatchPredictionJobRequest request, StreamObserver responseObserver)

public default void cancelBatchPredictionJob(CancelBatchPredictionJobRequest request, StreamObserver responseObserver)

Cancels a BatchPredictionJob. Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetBatchPredictionJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its BatchPredictionJob.state is set to CANCELLED. Any files already outputted by the job are not deleted.

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

cancelCustomJob(CancelCustomJobRequest request, StreamObserver responseObserver)

public default void cancelCustomJob(CancelCustomJobRequest request, StreamObserver responseObserver)

Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetCustomJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a CustomJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and CustomJob.state is set to CANCELLED.

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

cancelDataLabelingJob(CancelDataLabelingJobRequest request, StreamObserver responseObserver)

public default void cancelDataLabelingJob(CancelDataLabelingJobRequest request, StreamObserver responseObserver)

Cancels a DataLabelingJob. Success of cancellation is not guaranteed.

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

cancelHyperparameterTuningJob(CancelHyperparameterTuningJobRequest request, StreamObserver responseObserver)

public default void cancelHyperparameterTuningJob(CancelHyperparameterTuningJobRequest request, StreamObserver responseObserver)

Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetHyperparameterTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and HyperparameterTuningJob.state is set to CANCELLED.

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

cancelNasJob(CancelNasJobRequest request, StreamObserver responseObserver)

public default void cancelNasJob(CancelNasJobRequest request, StreamObserver responseObserver)

Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetNasJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a NasJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and NasJob.state is set to CANCELLED.

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

createBatchPredictionJob(CreateBatchPredictionJobRequest request, StreamObserver responseObserver)

public default void createBatchPredictionJob(CreateBatchPredictionJobRequest request, StreamObserver responseObserver)

Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.

Parameters
Name Description
request CreateBatchPredictionJobRequest
responseObserver io.grpc.stub.StreamObserver<BatchPredictionJob>

createCustomJob(CreateCustomJobRequest request, StreamObserver responseObserver)

public default void createCustomJob(CreateCustomJobRequest request, StreamObserver responseObserver)

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

Parameters
Name Description
request CreateCustomJobRequest
responseObserver io.grpc.stub.StreamObserver<CustomJob>

createDataLabelingJob(CreateDataLabelingJobRequest request, StreamObserver responseObserver)

public default void createDataLabelingJob(CreateDataLabelingJobRequest request, StreamObserver responseObserver)

Creates a DataLabelingJob.

Parameters
Name Description
request CreateDataLabelingJobRequest
responseObserver io.grpc.stub.StreamObserver<DataLabelingJob>

createHyperparameterTuningJob(CreateHyperparameterTuningJobRequest request, StreamObserver responseObserver)

public default void createHyperparameterTuningJob(CreateHyperparameterTuningJobRequest request, StreamObserver responseObserver)

Creates a HyperparameterTuningJob

Parameters
Name Description
request CreateHyperparameterTuningJobRequest
responseObserver io.grpc.stub.StreamObserver<HyperparameterTuningJob>

createModelDeploymentMonitoringJob(CreateModelDeploymentMonitoringJobRequest request, StreamObserver responseObserver)

public default void createModelDeploymentMonitoringJob(CreateModelDeploymentMonitoringJobRequest request, StreamObserver responseObserver)

Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval.

Parameters
Name Description
request CreateModelDeploymentMonitoringJobRequest
responseObserver io.grpc.stub.StreamObserver<ModelDeploymentMonitoringJob>

createNasJob(CreateNasJobRequest request, StreamObserver responseObserver)

public default void createNasJob(CreateNasJobRequest request, StreamObserver responseObserver)

Creates a NasJob

Parameters
Name Description
request CreateNasJobRequest
responseObserver io.grpc.stub.StreamObserver<NasJob>

deleteBatchPredictionJob(DeleteBatchPredictionJobRequest request, StreamObserver responseObserver)

public default void deleteBatchPredictionJob(DeleteBatchPredictionJobRequest request, StreamObserver responseObserver)

Deletes a BatchPredictionJob. Can only be called on jobs that already finished.

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

deleteCustomJob(DeleteCustomJobRequest request, StreamObserver responseObserver)

public default void deleteCustomJob(DeleteCustomJobRequest request, StreamObserver responseObserver)

Deletes a CustomJob.

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

deleteDataLabelingJob(DeleteDataLabelingJobRequest request, StreamObserver responseObserver)

public default void deleteDataLabelingJob(DeleteDataLabelingJobRequest request, StreamObserver responseObserver)

Deletes a DataLabelingJob.

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

deleteHyperparameterTuningJob(DeleteHyperparameterTuningJobRequest request, StreamObserver responseObserver)

public default void deleteHyperparameterTuningJob(DeleteHyperparameterTuningJobRequest request, StreamObserver responseObserver)

Deletes a HyperparameterTuningJob.

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

deleteModelDeploymentMonitoringJob(DeleteModelDeploymentMonitoringJobRequest request, StreamObserver responseObserver)

public default void deleteModelDeploymentMonitoringJob(DeleteModelDeploymentMonitoringJobRequest request, StreamObserver responseObserver)

Deletes a ModelDeploymentMonitoringJob.

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

deleteNasJob(DeleteNasJobRequest request, StreamObserver responseObserver)

public default void deleteNasJob(DeleteNasJobRequest request, StreamObserver responseObserver)

Deletes a NasJob.

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

getBatchPredictionJob(GetBatchPredictionJobRequest request, StreamObserver responseObserver)

public default void getBatchPredictionJob(GetBatchPredictionJobRequest request, StreamObserver responseObserver)

Gets a BatchPredictionJob

Parameters
Name Description
request GetBatchPredictionJobRequest
responseObserver io.grpc.stub.StreamObserver<BatchPredictionJob>

getCustomJob(GetCustomJobRequest request, StreamObserver responseObserver)

public default void getCustomJob(GetCustomJobRequest request, StreamObserver responseObserver)

Gets a CustomJob.

Parameters
Name Description
request GetCustomJobRequest
responseObserver io.grpc.stub.StreamObserver<CustomJob>

getDataLabelingJob(GetDataLabelingJobRequest request, StreamObserver responseObserver)

public default void getDataLabelingJob(GetDataLabelingJobRequest request, StreamObserver responseObserver)

Gets a DataLabelingJob.

Parameters
Name Description
request GetDataLabelingJobRequest
responseObserver io.grpc.stub.StreamObserver<DataLabelingJob>

getHyperparameterTuningJob(GetHyperparameterTuningJobRequest request, StreamObserver responseObserver)

public default void getHyperparameterTuningJob(GetHyperparameterTuningJobRequest request, StreamObserver responseObserver)

Gets a HyperparameterTuningJob

Parameters
Name Description
request GetHyperparameterTuningJobRequest
responseObserver io.grpc.stub.StreamObserver<HyperparameterTuningJob>

getModelDeploymentMonitoringJob(GetModelDeploymentMonitoringJobRequest request, StreamObserver responseObserver)

public default void getModelDeploymentMonitoringJob(GetModelDeploymentMonitoringJobRequest request, StreamObserver responseObserver)

Gets a ModelDeploymentMonitoringJob.

Parameters
Name Description
request GetModelDeploymentMonitoringJobRequest
responseObserver io.grpc.stub.StreamObserver<ModelDeploymentMonitoringJob>

getNasJob(GetNasJobRequest request, StreamObserver responseObserver)

public default void getNasJob(GetNasJobRequest request, StreamObserver responseObserver)

Gets a NasJob

Parameters
Name Description
request GetNasJobRequest
responseObserver io.grpc.stub.StreamObserver<NasJob>

getNasTrialDetail(GetNasTrialDetailRequest request, StreamObserver responseObserver)

public default void getNasTrialDetail(GetNasTrialDetailRequest request, StreamObserver responseObserver)

Gets a NasTrialDetail.

Parameters
Name Description
request GetNasTrialDetailRequest
responseObserver io.grpc.stub.StreamObserver<NasTrialDetail>

listBatchPredictionJobs(ListBatchPredictionJobsRequest request, StreamObserver responseObserver)

public default void listBatchPredictionJobs(ListBatchPredictionJobsRequest request, StreamObserver responseObserver)

Lists BatchPredictionJobs in a Location.

Parameters
Name Description
request ListBatchPredictionJobsRequest
responseObserver io.grpc.stub.StreamObserver<ListBatchPredictionJobsResponse>

listCustomJobs(ListCustomJobsRequest request, StreamObserver responseObserver)

public default void listCustomJobs(ListCustomJobsRequest request, StreamObserver responseObserver)

Lists CustomJobs in a Location.

Parameters
Name Description
request ListCustomJobsRequest
responseObserver io.grpc.stub.StreamObserver<ListCustomJobsResponse>

listDataLabelingJobs(ListDataLabelingJobsRequest request, StreamObserver responseObserver)

public default void listDataLabelingJobs(ListDataLabelingJobsRequest request, StreamObserver responseObserver)

Lists DataLabelingJobs in a Location.

Parameters
Name Description
request ListDataLabelingJobsRequest
responseObserver io.grpc.stub.StreamObserver<ListDataLabelingJobsResponse>

listHyperparameterTuningJobs(ListHyperparameterTuningJobsRequest request, StreamObserver responseObserver)

public default void listHyperparameterTuningJobs(ListHyperparameterTuningJobsRequest request, StreamObserver responseObserver)

Lists HyperparameterTuningJobs in a Location.

Parameters
Name Description
request ListHyperparameterTuningJobsRequest
responseObserver io.grpc.stub.StreamObserver<ListHyperparameterTuningJobsResponse>

listModelDeploymentMonitoringJobs(ListModelDeploymentMonitoringJobsRequest request, StreamObserver responseObserver)

public default void listModelDeploymentMonitoringJobs(ListModelDeploymentMonitoringJobsRequest request, StreamObserver responseObserver)

Lists ModelDeploymentMonitoringJobs in a Location.

Parameters
Name Description
request ListModelDeploymentMonitoringJobsRequest
responseObserver io.grpc.stub.StreamObserver<ListModelDeploymentMonitoringJobsResponse>

listNasJobs(ListNasJobsRequest request, StreamObserver responseObserver)

public default void listNasJobs(ListNasJobsRequest request, StreamObserver responseObserver)

Lists NasJobs in a Location.

Parameters
Name Description
request ListNasJobsRequest
responseObserver io.grpc.stub.StreamObserver<ListNasJobsResponse>

listNasTrialDetails(ListNasTrialDetailsRequest request, StreamObserver responseObserver)

public default void listNasTrialDetails(ListNasTrialDetailsRequest request, StreamObserver responseObserver)

List top NasTrialDetails of a NasJob.

Parameters
Name Description
request ListNasTrialDetailsRequest
responseObserver io.grpc.stub.StreamObserver<ListNasTrialDetailsResponse>

pauseModelDeploymentMonitoringJob(PauseModelDeploymentMonitoringJobRequest request, StreamObserver responseObserver)

public default void pauseModelDeploymentMonitoringJob(PauseModelDeploymentMonitoringJobRequest request, StreamObserver responseObserver)

Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark ModelDeploymentMonitoringJob.state to 'PAUSED'.

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

resumeModelDeploymentMonitoringJob(ResumeModelDeploymentMonitoringJobRequest request, StreamObserver responseObserver)

public default void resumeModelDeploymentMonitoringJob(ResumeModelDeploymentMonitoringJobRequest request, StreamObserver responseObserver)

Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.

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

searchModelDeploymentMonitoringStatsAnomalies(SearchModelDeploymentMonitoringStatsAnomaliesRequest request, StreamObserver responseObserver)

public default void searchModelDeploymentMonitoringStatsAnomalies(SearchModelDeploymentMonitoringStatsAnomaliesRequest request, StreamObserver responseObserver)

Searches Model Monitoring Statistics generated within a given time window.

Parameters
Name Description
request SearchModelDeploymentMonitoringStatsAnomaliesRequest
responseObserver io.grpc.stub.StreamObserver<SearchModelDeploymentMonitoringStatsAnomaliesResponse>

updateModelDeploymentMonitoringJob(UpdateModelDeploymentMonitoringJobRequest request, StreamObserver responseObserver)

public default void updateModelDeploymentMonitoringJob(UpdateModelDeploymentMonitoringJobRequest request, StreamObserver responseObserver)

Updates a ModelDeploymentMonitoringJob.

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