Class JobServiceGrpc.JobServiceFutureStub (3.46.0)

public static final class JobServiceGrpc.JobServiceFutureStub extends AbstractFutureStub<JobServiceGrpc.JobServiceFutureStub>

A stub to allow clients to do ListenableFuture-style 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.AbstractFutureStub > JobServiceGrpc.JobServiceFutureStub

Methods

build(Channel channel, CallOptions callOptions)

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

cancelBatchPredictionJob(CancelBatchPredictionJobRequest request)

public ListenableFuture<Empty> cancelBatchPredictionJob(CancelBatchPredictionJobRequest request)

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.

Parameter
Name Description
request CancelBatchPredictionJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

cancelCustomJob(CancelCustomJobRequest request)

public ListenableFuture<Empty> cancelCustomJob(CancelCustomJobRequest request)

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.

Parameter
Name Description
request CancelCustomJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

cancelDataLabelingJob(CancelDataLabelingJobRequest request)

public ListenableFuture<Empty> cancelDataLabelingJob(CancelDataLabelingJobRequest request)

Cancels a DataLabelingJob. Success of cancellation is not guaranteed.

Parameter
Name Description
request CancelDataLabelingJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

cancelHyperparameterTuningJob(CancelHyperparameterTuningJobRequest request)

public ListenableFuture<Empty> cancelHyperparameterTuningJob(CancelHyperparameterTuningJobRequest request)

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.

Parameter
Name Description
request CancelHyperparameterTuningJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

cancelNasJob(CancelNasJobRequest request)

public ListenableFuture<Empty> cancelNasJob(CancelNasJobRequest request)

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.

Parameter
Name Description
request CancelNasJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

createBatchPredictionJob(CreateBatchPredictionJobRequest request)

public ListenableFuture<BatchPredictionJob> createBatchPredictionJob(CreateBatchPredictionJobRequest request)

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

Parameter
Name Description
request CreateBatchPredictionJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<BatchPredictionJob>

createCustomJob(CreateCustomJobRequest request)

public ListenableFuture<CustomJob> createCustomJob(CreateCustomJobRequest request)

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

Parameter
Name Description
request CreateCustomJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<CustomJob>

createDataLabelingJob(CreateDataLabelingJobRequest request)

public ListenableFuture<DataLabelingJob> createDataLabelingJob(CreateDataLabelingJobRequest request)

Creates a DataLabelingJob.

Parameter
Name Description
request CreateDataLabelingJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DataLabelingJob>

createHyperparameterTuningJob(CreateHyperparameterTuningJobRequest request)

public ListenableFuture<HyperparameterTuningJob> createHyperparameterTuningJob(CreateHyperparameterTuningJobRequest request)

Creates a HyperparameterTuningJob

Parameter
Name Description
request CreateHyperparameterTuningJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<HyperparameterTuningJob>

createModelDeploymentMonitoringJob(CreateModelDeploymentMonitoringJobRequest request)

public ListenableFuture<ModelDeploymentMonitoringJob> createModelDeploymentMonitoringJob(CreateModelDeploymentMonitoringJobRequest request)

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

Parameter
Name Description
request CreateModelDeploymentMonitoringJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ModelDeploymentMonitoringJob>

createNasJob(CreateNasJobRequest request)

public ListenableFuture<NasJob> createNasJob(CreateNasJobRequest request)

Creates a NasJob

Parameter
Name Description
request CreateNasJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<NasJob>

deleteBatchPredictionJob(DeleteBatchPredictionJobRequest request)

public ListenableFuture<Operation> deleteBatchPredictionJob(DeleteBatchPredictionJobRequest request)

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

Parameter
Name Description
request DeleteBatchPredictionJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteCustomJob(DeleteCustomJobRequest request)

public ListenableFuture<Operation> deleteCustomJob(DeleteCustomJobRequest request)

Deletes a CustomJob.

Parameter
Name Description
request DeleteCustomJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteDataLabelingJob(DeleteDataLabelingJobRequest request)

public ListenableFuture<Operation> deleteDataLabelingJob(DeleteDataLabelingJobRequest request)

Deletes a DataLabelingJob.

Parameter
Name Description
request DeleteDataLabelingJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteHyperparameterTuningJob(DeleteHyperparameterTuningJobRequest request)

public ListenableFuture<Operation> deleteHyperparameterTuningJob(DeleteHyperparameterTuningJobRequest request)

Deletes a HyperparameterTuningJob.

Parameter
Name Description
request DeleteHyperparameterTuningJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteModelDeploymentMonitoringJob(DeleteModelDeploymentMonitoringJobRequest request)

public ListenableFuture<Operation> deleteModelDeploymentMonitoringJob(DeleteModelDeploymentMonitoringJobRequest request)

Deletes a ModelDeploymentMonitoringJob.

Parameter
Name Description
request DeleteModelDeploymentMonitoringJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteNasJob(DeleteNasJobRequest request)

public ListenableFuture<Operation> deleteNasJob(DeleteNasJobRequest request)

Deletes a NasJob.

Parameter
Name Description
request DeleteNasJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

getBatchPredictionJob(GetBatchPredictionJobRequest request)

public ListenableFuture<BatchPredictionJob> getBatchPredictionJob(GetBatchPredictionJobRequest request)

Gets a BatchPredictionJob

Parameter
Name Description
request GetBatchPredictionJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<BatchPredictionJob>

getCustomJob(GetCustomJobRequest request)

public ListenableFuture<CustomJob> getCustomJob(GetCustomJobRequest request)

Gets a CustomJob.

Parameter
Name Description
request GetCustomJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<CustomJob>

getDataLabelingJob(GetDataLabelingJobRequest request)

public ListenableFuture<DataLabelingJob> getDataLabelingJob(GetDataLabelingJobRequest request)

Gets a DataLabelingJob.

Parameter
Name Description
request GetDataLabelingJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DataLabelingJob>

getHyperparameterTuningJob(GetHyperparameterTuningJobRequest request)

public ListenableFuture<HyperparameterTuningJob> getHyperparameterTuningJob(GetHyperparameterTuningJobRequest request)

Gets a HyperparameterTuningJob

Parameter
Name Description
request GetHyperparameterTuningJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<HyperparameterTuningJob>

getModelDeploymentMonitoringJob(GetModelDeploymentMonitoringJobRequest request)

public ListenableFuture<ModelDeploymentMonitoringJob> getModelDeploymentMonitoringJob(GetModelDeploymentMonitoringJobRequest request)

Gets a ModelDeploymentMonitoringJob.

Parameter
Name Description
request GetModelDeploymentMonitoringJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ModelDeploymentMonitoringJob>

getNasJob(GetNasJobRequest request)

public ListenableFuture<NasJob> getNasJob(GetNasJobRequest request)

Gets a NasJob

Parameter
Name Description
request GetNasJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<NasJob>

getNasTrialDetail(GetNasTrialDetailRequest request)

public ListenableFuture<NasTrialDetail> getNasTrialDetail(GetNasTrialDetailRequest request)

Gets a NasTrialDetail.

Parameter
Name Description
request GetNasTrialDetailRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<NasTrialDetail>

listBatchPredictionJobs(ListBatchPredictionJobsRequest request)

public ListenableFuture<ListBatchPredictionJobsResponse> listBatchPredictionJobs(ListBatchPredictionJobsRequest request)

Lists BatchPredictionJobs in a Location.

Parameter
Name Description
request ListBatchPredictionJobsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListBatchPredictionJobsResponse>

listCustomJobs(ListCustomJobsRequest request)

public ListenableFuture<ListCustomJobsResponse> listCustomJobs(ListCustomJobsRequest request)

Lists CustomJobs in a Location.

Parameter
Name Description
request ListCustomJobsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListCustomJobsResponse>

listDataLabelingJobs(ListDataLabelingJobsRequest request)

public ListenableFuture<ListDataLabelingJobsResponse> listDataLabelingJobs(ListDataLabelingJobsRequest request)

Lists DataLabelingJobs in a Location.

Parameter
Name Description
request ListDataLabelingJobsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListDataLabelingJobsResponse>

listHyperparameterTuningJobs(ListHyperparameterTuningJobsRequest request)

public ListenableFuture<ListHyperparameterTuningJobsResponse> listHyperparameterTuningJobs(ListHyperparameterTuningJobsRequest request)

Lists HyperparameterTuningJobs in a Location.

Parameter
Name Description
request ListHyperparameterTuningJobsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListHyperparameterTuningJobsResponse>

listModelDeploymentMonitoringJobs(ListModelDeploymentMonitoringJobsRequest request)

public ListenableFuture<ListModelDeploymentMonitoringJobsResponse> listModelDeploymentMonitoringJobs(ListModelDeploymentMonitoringJobsRequest request)

Lists ModelDeploymentMonitoringJobs in a Location.

Parameter
Name Description
request ListModelDeploymentMonitoringJobsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListModelDeploymentMonitoringJobsResponse>

listNasJobs(ListNasJobsRequest request)

public ListenableFuture<ListNasJobsResponse> listNasJobs(ListNasJobsRequest request)

Lists NasJobs in a Location.

Parameter
Name Description
request ListNasJobsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListNasJobsResponse>

listNasTrialDetails(ListNasTrialDetailsRequest request)

public ListenableFuture<ListNasTrialDetailsResponse> listNasTrialDetails(ListNasTrialDetailsRequest request)

List top NasTrialDetails of a NasJob.

Parameter
Name Description
request ListNasTrialDetailsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListNasTrialDetailsResponse>

pauseModelDeploymentMonitoringJob(PauseModelDeploymentMonitoringJobRequest request)

public ListenableFuture<Empty> pauseModelDeploymentMonitoringJob(PauseModelDeploymentMonitoringJobRequest request)

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

Parameter
Name Description
request PauseModelDeploymentMonitoringJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

resumeModelDeploymentMonitoringJob(ResumeModelDeploymentMonitoringJobRequest request)

public ListenableFuture<Empty> resumeModelDeploymentMonitoringJob(ResumeModelDeploymentMonitoringJobRequest request)

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

Parameter
Name Description
request ResumeModelDeploymentMonitoringJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

searchModelDeploymentMonitoringStatsAnomalies(SearchModelDeploymentMonitoringStatsAnomaliesRequest request)

public ListenableFuture<SearchModelDeploymentMonitoringStatsAnomaliesResponse> searchModelDeploymentMonitoringStatsAnomalies(SearchModelDeploymentMonitoringStatsAnomaliesRequest request)

Searches Model Monitoring Statistics generated within a given time window.

Parameter
Name Description
request SearchModelDeploymentMonitoringStatsAnomaliesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<SearchModelDeploymentMonitoringStatsAnomaliesResponse>

updateModelDeploymentMonitoringJob(UpdateModelDeploymentMonitoringJobRequest request)

public ListenableFuture<Operation> updateModelDeploymentMonitoringJob(UpdateModelDeploymentMonitoringJobRequest request)

Updates a ModelDeploymentMonitoringJob.

Parameter
Name Description
request UpdateModelDeploymentMonitoringJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>