Interface JobServiceGrpc.AsyncService (3.40.0)

public static interface JobServiceGrpc.AsyncService

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

Methods

cancelBatchPredictionJob(CancelBatchPredictionJobRequest request, StreamObserver<Empty> responseObserver)

public default void cancelBatchPredictionJob(CancelBatchPredictionJobRequest request, StreamObserver<Empty> 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
NameDescription
requestCancelBatchPredictionJobRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

cancelCustomJob(CancelCustomJobRequest request, StreamObserver<Empty> responseObserver)

public default void cancelCustomJob(CancelCustomJobRequest request, StreamObserver<Empty> 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
NameDescription
requestCancelCustomJobRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

cancelDataLabelingJob(CancelDataLabelingJobRequest request, StreamObserver<Empty> responseObserver)

public default void cancelDataLabelingJob(CancelDataLabelingJobRequest request, StreamObserver<Empty> responseObserver)

Cancels a DataLabelingJob. Success of cancellation is not guaranteed.

Parameters
NameDescription
requestCancelDataLabelingJobRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

cancelHyperparameterTuningJob(CancelHyperparameterTuningJobRequest request, StreamObserver<Empty> responseObserver)

public default void cancelHyperparameterTuningJob(CancelHyperparameterTuningJobRequest request, StreamObserver<Empty> 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
NameDescription
requestCancelHyperparameterTuningJobRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

cancelNasJob(CancelNasJobRequest request, StreamObserver<Empty> responseObserver)

public default void cancelNasJob(CancelNasJobRequest request, StreamObserver<Empty> 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
NameDescription
requestCancelNasJobRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

createBatchPredictionJob(CreateBatchPredictionJobRequest request, StreamObserver<BatchPredictionJob> responseObserver)

public default void createBatchPredictionJob(CreateBatchPredictionJobRequest request, StreamObserver<BatchPredictionJob> responseObserver)

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

Parameters
NameDescription
requestCreateBatchPredictionJobRequest
responseObserverio.grpc.stub.StreamObserver<BatchPredictionJob>

createCustomJob(CreateCustomJobRequest request, StreamObserver<CustomJob> responseObserver)

public default void createCustomJob(CreateCustomJobRequest request, StreamObserver<CustomJob> responseObserver)

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

Parameters
NameDescription
requestCreateCustomJobRequest
responseObserverio.grpc.stub.StreamObserver<CustomJob>

createDataLabelingJob(CreateDataLabelingJobRequest request, StreamObserver<DataLabelingJob> responseObserver)

public default void createDataLabelingJob(CreateDataLabelingJobRequest request, StreamObserver<DataLabelingJob> responseObserver)

Creates a DataLabelingJob.

Parameters
NameDescription
requestCreateDataLabelingJobRequest
responseObserverio.grpc.stub.StreamObserver<DataLabelingJob>

createHyperparameterTuningJob(CreateHyperparameterTuningJobRequest request, StreamObserver<HyperparameterTuningJob> responseObserver)

public default void createHyperparameterTuningJob(CreateHyperparameterTuningJobRequest request, StreamObserver<HyperparameterTuningJob> responseObserver)

Creates a HyperparameterTuningJob

Parameters
NameDescription
requestCreateHyperparameterTuningJobRequest
responseObserverio.grpc.stub.StreamObserver<HyperparameterTuningJob>

createModelDeploymentMonitoringJob(CreateModelDeploymentMonitoringJobRequest request, StreamObserver<ModelDeploymentMonitoringJob> responseObserver)

public default void createModelDeploymentMonitoringJob(CreateModelDeploymentMonitoringJobRequest request, StreamObserver<ModelDeploymentMonitoringJob> responseObserver)

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

Parameters
NameDescription
requestCreateModelDeploymentMonitoringJobRequest
responseObserverio.grpc.stub.StreamObserver<ModelDeploymentMonitoringJob>

createNasJob(CreateNasJobRequest request, StreamObserver<NasJob> responseObserver)

public default void createNasJob(CreateNasJobRequest request, StreamObserver<NasJob> responseObserver)

Creates a NasJob

Parameters
NameDescription
requestCreateNasJobRequest
responseObserverio.grpc.stub.StreamObserver<NasJob>

deleteBatchPredictionJob(DeleteBatchPredictionJobRequest request, StreamObserver<Operation> responseObserver)

public default void deleteBatchPredictionJob(DeleteBatchPredictionJobRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
NameDescription
requestDeleteBatchPredictionJobRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

deleteCustomJob(DeleteCustomJobRequest request, StreamObserver<Operation> responseObserver)

public default void deleteCustomJob(DeleteCustomJobRequest request, StreamObserver<Operation> responseObserver)

Deletes a CustomJob.

Parameters
NameDescription
requestDeleteCustomJobRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

deleteDataLabelingJob(DeleteDataLabelingJobRequest request, StreamObserver<Operation> responseObserver)

public default void deleteDataLabelingJob(DeleteDataLabelingJobRequest request, StreamObserver<Operation> responseObserver)

Deletes a DataLabelingJob.

Parameters
NameDescription
requestDeleteDataLabelingJobRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

deleteHyperparameterTuningJob(DeleteHyperparameterTuningJobRequest request, StreamObserver<Operation> responseObserver)

public default void deleteHyperparameterTuningJob(DeleteHyperparameterTuningJobRequest request, StreamObserver<Operation> responseObserver)

Deletes a HyperparameterTuningJob.

Parameters
NameDescription
requestDeleteHyperparameterTuningJobRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

deleteModelDeploymentMonitoringJob(DeleteModelDeploymentMonitoringJobRequest request, StreamObserver<Operation> responseObserver)

public default void deleteModelDeploymentMonitoringJob(DeleteModelDeploymentMonitoringJobRequest request, StreamObserver<Operation> responseObserver)

Deletes a ModelDeploymentMonitoringJob.

Parameters
NameDescription
requestDeleteModelDeploymentMonitoringJobRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

deleteNasJob(DeleteNasJobRequest request, StreamObserver<Operation> responseObserver)

public default void deleteNasJob(DeleteNasJobRequest request, StreamObserver<Operation> responseObserver)

Deletes a NasJob.

Parameters
NameDescription
requestDeleteNasJobRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

getBatchPredictionJob(GetBatchPredictionJobRequest request, StreamObserver<BatchPredictionJob> responseObserver)

public default void getBatchPredictionJob(GetBatchPredictionJobRequest request, StreamObserver<BatchPredictionJob> responseObserver)

Gets a BatchPredictionJob

Parameters
NameDescription
requestGetBatchPredictionJobRequest
responseObserverio.grpc.stub.StreamObserver<BatchPredictionJob>

getCustomJob(GetCustomJobRequest request, StreamObserver<CustomJob> responseObserver)

public default void getCustomJob(GetCustomJobRequest request, StreamObserver<CustomJob> responseObserver)

Gets a CustomJob.

Parameters
NameDescription
requestGetCustomJobRequest
responseObserverio.grpc.stub.StreamObserver<CustomJob>

getDataLabelingJob(GetDataLabelingJobRequest request, StreamObserver<DataLabelingJob> responseObserver)

public default void getDataLabelingJob(GetDataLabelingJobRequest request, StreamObserver<DataLabelingJob> responseObserver)

Gets a DataLabelingJob.

Parameters
NameDescription
requestGetDataLabelingJobRequest
responseObserverio.grpc.stub.StreamObserver<DataLabelingJob>

getHyperparameterTuningJob(GetHyperparameterTuningJobRequest request, StreamObserver<HyperparameterTuningJob> responseObserver)

public default void getHyperparameterTuningJob(GetHyperparameterTuningJobRequest request, StreamObserver<HyperparameterTuningJob> responseObserver)

Gets a HyperparameterTuningJob

Parameters
NameDescription
requestGetHyperparameterTuningJobRequest
responseObserverio.grpc.stub.StreamObserver<HyperparameterTuningJob>

getModelDeploymentMonitoringJob(GetModelDeploymentMonitoringJobRequest request, StreamObserver<ModelDeploymentMonitoringJob> responseObserver)

public default void getModelDeploymentMonitoringJob(GetModelDeploymentMonitoringJobRequest request, StreamObserver<ModelDeploymentMonitoringJob> responseObserver)

Gets a ModelDeploymentMonitoringJob.

Parameters
NameDescription
requestGetModelDeploymentMonitoringJobRequest
responseObserverio.grpc.stub.StreamObserver<ModelDeploymentMonitoringJob>

getNasJob(GetNasJobRequest request, StreamObserver<NasJob> responseObserver)

public default void getNasJob(GetNasJobRequest request, StreamObserver<NasJob> responseObserver)

Gets a NasJob

Parameters
NameDescription
requestGetNasJobRequest
responseObserverio.grpc.stub.StreamObserver<NasJob>

getNasTrialDetail(GetNasTrialDetailRequest request, StreamObserver<NasTrialDetail> responseObserver)

public default void getNasTrialDetail(GetNasTrialDetailRequest request, StreamObserver<NasTrialDetail> responseObserver)

Gets a NasTrialDetail.

Parameters
NameDescription
requestGetNasTrialDetailRequest
responseObserverio.grpc.stub.StreamObserver<NasTrialDetail>

listBatchPredictionJobs(ListBatchPredictionJobsRequest request, StreamObserver<ListBatchPredictionJobsResponse> responseObserver)

public default void listBatchPredictionJobs(ListBatchPredictionJobsRequest request, StreamObserver<ListBatchPredictionJobsResponse> responseObserver)

Lists BatchPredictionJobs in a Location.

Parameters
NameDescription
requestListBatchPredictionJobsRequest
responseObserverio.grpc.stub.StreamObserver<ListBatchPredictionJobsResponse>

listCustomJobs(ListCustomJobsRequest request, StreamObserver<ListCustomJobsResponse> responseObserver)

public default void listCustomJobs(ListCustomJobsRequest request, StreamObserver<ListCustomJobsResponse> responseObserver)

Lists CustomJobs in a Location.

Parameters
NameDescription
requestListCustomJobsRequest
responseObserverio.grpc.stub.StreamObserver<ListCustomJobsResponse>

listDataLabelingJobs(ListDataLabelingJobsRequest request, StreamObserver<ListDataLabelingJobsResponse> responseObserver)

public default void listDataLabelingJobs(ListDataLabelingJobsRequest request, StreamObserver<ListDataLabelingJobsResponse> responseObserver)

Lists DataLabelingJobs in a Location.

Parameters
NameDescription
requestListDataLabelingJobsRequest
responseObserverio.grpc.stub.StreamObserver<ListDataLabelingJobsResponse>

listHyperparameterTuningJobs(ListHyperparameterTuningJobsRequest request, StreamObserver<ListHyperparameterTuningJobsResponse> responseObserver)

public default void listHyperparameterTuningJobs(ListHyperparameterTuningJobsRequest request, StreamObserver<ListHyperparameterTuningJobsResponse> responseObserver)

Lists HyperparameterTuningJobs in a Location.

Parameters
NameDescription
requestListHyperparameterTuningJobsRequest
responseObserverio.grpc.stub.StreamObserver<ListHyperparameterTuningJobsResponse>

listModelDeploymentMonitoringJobs(ListModelDeploymentMonitoringJobsRequest request, StreamObserver<ListModelDeploymentMonitoringJobsResponse> responseObserver)

public default void listModelDeploymentMonitoringJobs(ListModelDeploymentMonitoringJobsRequest request, StreamObserver<ListModelDeploymentMonitoringJobsResponse> responseObserver)

Lists ModelDeploymentMonitoringJobs in a Location.

Parameters
NameDescription
requestListModelDeploymentMonitoringJobsRequest
responseObserverio.grpc.stub.StreamObserver<ListModelDeploymentMonitoringJobsResponse>

listNasJobs(ListNasJobsRequest request, StreamObserver<ListNasJobsResponse> responseObserver)

public default void listNasJobs(ListNasJobsRequest request, StreamObserver<ListNasJobsResponse> responseObserver)

Lists NasJobs in a Location.

Parameters
NameDescription
requestListNasJobsRequest
responseObserverio.grpc.stub.StreamObserver<ListNasJobsResponse>

listNasTrialDetails(ListNasTrialDetailsRequest request, StreamObserver<ListNasTrialDetailsResponse> responseObserver)

public default void listNasTrialDetails(ListNasTrialDetailsRequest request, StreamObserver<ListNasTrialDetailsResponse> responseObserver)

List top NasTrialDetails of a NasJob.

Parameters
NameDescription
requestListNasTrialDetailsRequest
responseObserverio.grpc.stub.StreamObserver<ListNasTrialDetailsResponse>

pauseModelDeploymentMonitoringJob(PauseModelDeploymentMonitoringJobRequest request, StreamObserver<Empty> responseObserver)

public default void pauseModelDeploymentMonitoringJob(PauseModelDeploymentMonitoringJobRequest request, StreamObserver<Empty> 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
NameDescription
requestPauseModelDeploymentMonitoringJobRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

resumeModelDeploymentMonitoringJob(ResumeModelDeploymentMonitoringJobRequest request, StreamObserver<Empty> responseObserver)

public default void resumeModelDeploymentMonitoringJob(ResumeModelDeploymentMonitoringJobRequest request, StreamObserver<Empty> responseObserver)

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

Parameters
NameDescription
requestResumeModelDeploymentMonitoringJobRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

searchModelDeploymentMonitoringStatsAnomalies(SearchModelDeploymentMonitoringStatsAnomaliesRequest request, StreamObserver<SearchModelDeploymentMonitoringStatsAnomaliesResponse> responseObserver)

public default void searchModelDeploymentMonitoringStatsAnomalies(SearchModelDeploymentMonitoringStatsAnomaliesRequest request, StreamObserver<SearchModelDeploymentMonitoringStatsAnomaliesResponse> responseObserver)

Searches Model Monitoring Statistics generated within a given time window.

Parameters
NameDescription
requestSearchModelDeploymentMonitoringStatsAnomaliesRequest
responseObserverio.grpc.stub.StreamObserver<SearchModelDeploymentMonitoringStatsAnomaliesResponse>

updateModelDeploymentMonitoringJob(UpdateModelDeploymentMonitoringJobRequest request, StreamObserver<Operation> responseObserver)

public default void updateModelDeploymentMonitoringJob(UpdateModelDeploymentMonitoringJobRequest request, StreamObserver<Operation> responseObserver)

Updates a ModelDeploymentMonitoringJob.

Parameters
NameDescription
requestUpdateModelDeploymentMonitoringJobRequest
responseObserverio.grpc.stub.StreamObserver<Operation>