Class JobServiceGrpc.JobServiceStub (3.43.0)

public static final class JobServiceGrpc.JobServiceStub extends AbstractAsyncStub<JobServiceGrpc.JobServiceStub>

A stub to allow clients to do asynchronous rpc calls to service JobService.

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

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractAsyncStub > JobServiceGrpc.JobServiceStub

Methods

build(Channel channel, CallOptions callOptions)

protected JobServiceGrpc.JobServiceStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
JobServiceGrpc.JobServiceStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

cancelBatchPredictionJob(CancelBatchPredictionJobRequest request, StreamObserver<Empty> responseObserver)

public 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
Name Description
request CancelBatchPredictionJobRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

cancelCustomJob(CancelCustomJobRequest request, StreamObserver<Empty> responseObserver)

public 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
Name Description
request CancelCustomJobRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

cancelDataLabelingJob(CancelDataLabelingJobRequest request, StreamObserver<Empty> responseObserver)

public void cancelDataLabelingJob(CancelDataLabelingJobRequest request, StreamObserver<Empty> 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<Empty> responseObserver)

public 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
Name Description
request CancelHyperparameterTuningJobRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

cancelNasJob(CancelNasJobRequest request, StreamObserver<Empty> responseObserver)

public 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
Name Description
request CancelNasJobRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

createBatchPredictionJob(CreateBatchPredictionJobRequest request, StreamObserver<BatchPredictionJob> responseObserver)

public void createBatchPredictionJob(CreateBatchPredictionJobRequest request, StreamObserver<BatchPredictionJob> 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<CustomJob> responseObserver)

public void createCustomJob(CreateCustomJobRequest request, StreamObserver<CustomJob> 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<DataLabelingJob> responseObserver)

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

Creates a DataLabelingJob.

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

createHyperparameterTuningJob(CreateHyperparameterTuningJobRequest request, StreamObserver<HyperparameterTuningJob> responseObserver)

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

Creates a HyperparameterTuningJob

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

createModelDeploymentMonitoringJob(CreateModelDeploymentMonitoringJobRequest request, StreamObserver<ModelDeploymentMonitoringJob> responseObserver)

public void createModelDeploymentMonitoringJob(CreateModelDeploymentMonitoringJobRequest request, StreamObserver<ModelDeploymentMonitoringJob> 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<NasJob> responseObserver)

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

Creates a NasJob

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

deleteBatchPredictionJob(DeleteBatchPredictionJobRequest request, StreamObserver<Operation> responseObserver)

public void deleteBatchPredictionJob(DeleteBatchPredictionJobRequest request, StreamObserver<Operation> 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<Operation> responseObserver)

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

Deletes a CustomJob.

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

deleteDataLabelingJob(DeleteDataLabelingJobRequest request, StreamObserver<Operation> responseObserver)

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

Deletes a DataLabelingJob.

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

deleteHyperparameterTuningJob(DeleteHyperparameterTuningJobRequest request, StreamObserver<Operation> responseObserver)

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

Deletes a HyperparameterTuningJob.

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

deleteModelDeploymentMonitoringJob(DeleteModelDeploymentMonitoringJobRequest request, StreamObserver<Operation> responseObserver)

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

Deletes a ModelDeploymentMonitoringJob.

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

deleteNasJob(DeleteNasJobRequest request, StreamObserver<Operation> responseObserver)

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

Deletes a NasJob.

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

getBatchPredictionJob(GetBatchPredictionJobRequest request, StreamObserver<BatchPredictionJob> responseObserver)

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

Gets a BatchPredictionJob

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

getCustomJob(GetCustomJobRequest request, StreamObserver<CustomJob> responseObserver)

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

Gets a CustomJob.

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

getDataLabelingJob(GetDataLabelingJobRequest request, StreamObserver<DataLabelingJob> responseObserver)

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

Gets a DataLabelingJob.

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

getHyperparameterTuningJob(GetHyperparameterTuningJobRequest request, StreamObserver<HyperparameterTuningJob> responseObserver)

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

Gets a HyperparameterTuningJob

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

getModelDeploymentMonitoringJob(GetModelDeploymentMonitoringJobRequest request, StreamObserver<ModelDeploymentMonitoringJob> responseObserver)

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

Gets a ModelDeploymentMonitoringJob.

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

getNasJob(GetNasJobRequest request, StreamObserver<NasJob> responseObserver)

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

Gets a NasJob

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

getNasTrialDetail(GetNasTrialDetailRequest request, StreamObserver<NasTrialDetail> responseObserver)

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

Gets a NasTrialDetail.

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

listBatchPredictionJobs(ListBatchPredictionJobsRequest request, StreamObserver<ListBatchPredictionJobsResponse> responseObserver)

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

Lists BatchPredictionJobs in a Location.

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

listCustomJobs(ListCustomJobsRequest request, StreamObserver<ListCustomJobsResponse> responseObserver)

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

Lists CustomJobs in a Location.

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

listDataLabelingJobs(ListDataLabelingJobsRequest request, StreamObserver<ListDataLabelingJobsResponse> responseObserver)

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

Lists DataLabelingJobs in a Location.

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

listHyperparameterTuningJobs(ListHyperparameterTuningJobsRequest request, StreamObserver<ListHyperparameterTuningJobsResponse> responseObserver)

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

Lists HyperparameterTuningJobs in a Location.

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

listModelDeploymentMonitoringJobs(ListModelDeploymentMonitoringJobsRequest request, StreamObserver<ListModelDeploymentMonitoringJobsResponse> responseObserver)

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

Lists ModelDeploymentMonitoringJobs in a Location.

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

listNasJobs(ListNasJobsRequest request, StreamObserver<ListNasJobsResponse> responseObserver)

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

Lists NasJobs in a Location.

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

listNasTrialDetails(ListNasTrialDetailsRequest request, StreamObserver<ListNasTrialDetailsResponse> responseObserver)

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

List top NasTrialDetails of a NasJob.

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

pauseModelDeploymentMonitoringJob(PauseModelDeploymentMonitoringJobRequest request, StreamObserver<Empty> responseObserver)

public 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
Name Description
request PauseModelDeploymentMonitoringJobRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

resumeModelDeploymentMonitoringJob(ResumeModelDeploymentMonitoringJobRequest request, StreamObserver<Empty> responseObserver)

public 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
Name Description
request ResumeModelDeploymentMonitoringJobRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

searchModelDeploymentMonitoringStatsAnomalies(SearchModelDeploymentMonitoringStatsAnomaliesRequest request, StreamObserver<SearchModelDeploymentMonitoringStatsAnomaliesResponse> responseObserver)

public void searchModelDeploymentMonitoringStatsAnomalies(SearchModelDeploymentMonitoringStatsAnomaliesRequest request, StreamObserver<SearchModelDeploymentMonitoringStatsAnomaliesResponse> 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<Operation> responseObserver)

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

Updates a ModelDeploymentMonitoringJob.

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