com.google.cloud.aiplatform.v1beta1

Class JobServiceGrpc.JobServiceFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractFutureStub<JobServiceGrpc.JobServiceFutureStub>

com.google.cloud.aiplatform.v1beta1.JobServiceGrpc.JobServiceFutureStub

Enclosing class:

JobServiceGrpc

public static final class JobServiceGrpc.JobServiceFutureStub
extends io.grpc.stub.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.
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method and Description
protected JobServiceGrpc.JobServiceFutureStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	cancelBatchPredictionJob(CancelBatchPredictionJobRequest request) Cancels a BatchPredictionJob.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	cancelCustomJob(CancelCustomJobRequest request) Cancels a CustomJob.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	cancelDataLabelingJob(CancelDataLabelingJobRequest request) Cancels a DataLabelingJob.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	cancelHyperparameterTuningJob(CancelHyperparameterTuningJobRequest request) Cancels a HyperparameterTuningJob.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	cancelNasJob(CancelNasJobRequest request) Cancels a NasJob.
com.google.common.util.concurrent.ListenableFuture<BatchPredictionJob>	createBatchPredictionJob(CreateBatchPredictionJobRequest request) Creates a BatchPredictionJob.
com.google.common.util.concurrent.ListenableFuture<CustomJob>	createCustomJob(CreateCustomJobRequest request) Creates a CustomJob.
com.google.common.util.concurrent.ListenableFuture<DataLabelingJob>	createDataLabelingJob(CreateDataLabelingJobRequest request) Creates a DataLabelingJob.
com.google.common.util.concurrent.ListenableFuture<HyperparameterTuningJob>	createHyperparameterTuningJob(CreateHyperparameterTuningJobRequest request) Creates a HyperparameterTuningJob
com.google.common.util.concurrent.ListenableFuture<ModelDeploymentMonitoringJob>	createModelDeploymentMonitoringJob(CreateModelDeploymentMonitoringJobRequest request) Creates a ModelDeploymentMonitoringJob.
com.google.common.util.concurrent.ListenableFuture<NasJob>	createNasJob(CreateNasJobRequest request) Creates a NasJob
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	deleteBatchPredictionJob(DeleteBatchPredictionJobRequest request) Deletes a BatchPredictionJob.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	deleteCustomJob(DeleteCustomJobRequest request) Deletes a CustomJob.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	deleteDataLabelingJob(DeleteDataLabelingJobRequest request) Deletes a DataLabelingJob.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	deleteHyperparameterTuningJob(DeleteHyperparameterTuningJobRequest request) Deletes a HyperparameterTuningJob.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	deleteModelDeploymentMonitoringJob(DeleteModelDeploymentMonitoringJobRequest request) Deletes a ModelDeploymentMonitoringJob.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	deleteNasJob(DeleteNasJobRequest request) Deletes a NasJob.
com.google.common.util.concurrent.ListenableFuture<BatchPredictionJob>	getBatchPredictionJob(GetBatchPredictionJobRequest request) Gets a BatchPredictionJob
com.google.common.util.concurrent.ListenableFuture<CustomJob>	getCustomJob(GetCustomJobRequest request) Gets a CustomJob.
com.google.common.util.concurrent.ListenableFuture<DataLabelingJob>	getDataLabelingJob(GetDataLabelingJobRequest request) Gets a DataLabelingJob.
com.google.common.util.concurrent.ListenableFuture<HyperparameterTuningJob>	getHyperparameterTuningJob(GetHyperparameterTuningJobRequest request) Gets a HyperparameterTuningJob
com.google.common.util.concurrent.ListenableFuture<ModelDeploymentMonitoringJob>	getModelDeploymentMonitoringJob(GetModelDeploymentMonitoringJobRequest request) Gets a ModelDeploymentMonitoringJob.
com.google.common.util.concurrent.ListenableFuture<NasJob>	getNasJob(GetNasJobRequest request) Gets a NasJob
com.google.common.util.concurrent.ListenableFuture<NasTrialDetail>	getNasTrialDetail(GetNasTrialDetailRequest request) Gets a NasTrialDetail.
com.google.common.util.concurrent.ListenableFuture<ListBatchPredictionJobsResponse>	listBatchPredictionJobs(ListBatchPredictionJobsRequest request) Lists BatchPredictionJobs in a Location.
com.google.common.util.concurrent.ListenableFuture<ListCustomJobsResponse>	listCustomJobs(ListCustomJobsRequest request) Lists CustomJobs in a Location.
com.google.common.util.concurrent.ListenableFuture<ListDataLabelingJobsResponse>	listDataLabelingJobs(ListDataLabelingJobsRequest request) Lists DataLabelingJobs in a Location.
com.google.common.util.concurrent.ListenableFuture<ListHyperparameterTuningJobsResponse>	listHyperparameterTuningJobs(ListHyperparameterTuningJobsRequest request) Lists HyperparameterTuningJobs in a Location.
com.google.common.util.concurrent.ListenableFuture<ListModelDeploymentMonitoringJobsResponse>	listModelDeploymentMonitoringJobs(ListModelDeploymentMonitoringJobsRequest request) Lists ModelDeploymentMonitoringJobs in a Location.
com.google.common.util.concurrent.ListenableFuture<ListNasJobsResponse>	listNasJobs(ListNasJobsRequest request) Lists NasJobs in a Location.
com.google.common.util.concurrent.ListenableFuture<ListNasTrialDetailsResponse>	listNasTrialDetails(ListNasTrialDetailsRequest request) List top NasTrialDetails of a NasJob.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	pauseModelDeploymentMonitoringJob(PauseModelDeploymentMonitoringJobRequest request) Pauses a ModelDeploymentMonitoringJob.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	resumeModelDeploymentMonitoringJob(ResumeModelDeploymentMonitoringJobRequest request) Resumes a paused ModelDeploymentMonitoringJob.
com.google.common.util.concurrent.ListenableFuture<SearchModelDeploymentMonitoringStatsAnomaliesResponse>	searchModelDeploymentMonitoringStatsAnomalies(SearchModelDeploymentMonitoringStatsAnomaliesRequest request) Searches Model Monitoring Statistics generated within a given time window.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	updateModelDeploymentMonitoringJob(UpdateModelDeploymentMonitoringJobRequest request) Updates a ModelDeploymentMonitoringJob.

Methods inherited from class io.grpc.stub.AbstractFutureStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

protected JobServiceGrpc.JobServiceFutureStub build(io.grpc.Channel channel,
                                                    io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<JobServiceGrpc.JobServiceFutureStub>

createCustomJob

public com.google.common.util.concurrent.ListenableFuture<CustomJob> createCustomJob(CreateCustomJobRequest request)

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

getCustomJob

public com.google.common.util.concurrent.ListenableFuture<CustomJob> getCustomJob(GetCustomJobRequest request)

 Gets a CustomJob.
 

listCustomJobs

public com.google.common.util.concurrent.ListenableFuture<ListCustomJobsResponse> listCustomJobs(ListCustomJobsRequest request)

 Lists CustomJobs in a Location.
 

deleteCustomJob

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> deleteCustomJob(DeleteCustomJobRequest request)

 Deletes a CustomJob.
 

cancelCustomJob

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.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][google.cloud.aiplatform.v1beta1.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][google.cloud.aiplatform.v1beta1.CustomJob.error] value
 with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding
 to `Code.CANCELLED`, and
 [CustomJob.state][google.cloud.aiplatform.v1beta1.CustomJob.state] is set
 to `CANCELLED`.
 

createDataLabelingJob

public com.google.common.util.concurrent.ListenableFuture<DataLabelingJob> createDataLabelingJob(CreateDataLabelingJobRequest request)

 Creates a DataLabelingJob.
 

getDataLabelingJob

public com.google.common.util.concurrent.ListenableFuture<DataLabelingJob> getDataLabelingJob(GetDataLabelingJobRequest request)

 Gets a DataLabelingJob.
 

listDataLabelingJobs

public com.google.common.util.concurrent.ListenableFuture<ListDataLabelingJobsResponse> listDataLabelingJobs(ListDataLabelingJobsRequest request)

 Lists DataLabelingJobs in a Location.
 

deleteDataLabelingJob

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> deleteDataLabelingJob(DeleteDataLabelingJobRequest request)

 Deletes a DataLabelingJob.
 

cancelDataLabelingJob

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> cancelDataLabelingJob(CancelDataLabelingJobRequest request)

 Cancels a DataLabelingJob. Success of cancellation is not guaranteed.
 

createHyperparameterTuningJob

public com.google.common.util.concurrent.ListenableFuture<HyperparameterTuningJob> createHyperparameterTuningJob(CreateHyperparameterTuningJobRequest request)

 Creates a HyperparameterTuningJob
 

getHyperparameterTuningJob

public com.google.common.util.concurrent.ListenableFuture<HyperparameterTuningJob> getHyperparameterTuningJob(GetHyperparameterTuningJobRequest request)

 Gets a HyperparameterTuningJob
 

listHyperparameterTuningJobs

public com.google.common.util.concurrent.ListenableFuture<ListHyperparameterTuningJobsResponse> listHyperparameterTuningJobs(ListHyperparameterTuningJobsRequest request)

 Lists HyperparameterTuningJobs in a Location.
 

deleteHyperparameterTuningJob

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> deleteHyperparameterTuningJob(DeleteHyperparameterTuningJobRequest request)

 Deletes a HyperparameterTuningJob.
 

cancelHyperparameterTuningJob

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.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][google.cloud.aiplatform.v1beta1.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][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.error]
 value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
 corresponding to `Code.CANCELLED`, and
 [HyperparameterTuningJob.state][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.state]
 is set to `CANCELLED`.
 

createNasJob

public com.google.common.util.concurrent.ListenableFuture<NasJob> createNasJob(CreateNasJobRequest request)

 Creates a NasJob
 

getNasJob

public com.google.common.util.concurrent.ListenableFuture<NasJob> getNasJob(GetNasJobRequest request)

 Gets a NasJob
 

listNasJobs

public com.google.common.util.concurrent.ListenableFuture<ListNasJobsResponse> listNasJobs(ListNasJobsRequest request)

 Lists NasJobs in a Location.
 

deleteNasJob

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> deleteNasJob(DeleteNasJobRequest request)

 Deletes a NasJob.
 

cancelNasJob

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.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][google.cloud.aiplatform.v1beta1.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][google.cloud.aiplatform.v1beta1.NasJob.error] value with a
 [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
 `Code.CANCELLED`, and
 [NasJob.state][google.cloud.aiplatform.v1beta1.NasJob.state] is set to
 `CANCELLED`.
 

getNasTrialDetail

public com.google.common.util.concurrent.ListenableFuture<NasTrialDetail> getNasTrialDetail(GetNasTrialDetailRequest request)

 Gets a NasTrialDetail.
 

listNasTrialDetails

public com.google.common.util.concurrent.ListenableFuture<ListNasTrialDetailsResponse> listNasTrialDetails(ListNasTrialDetailsRequest request)

 List top NasTrialDetails of a NasJob.
 

createBatchPredictionJob

public com.google.common.util.concurrent.ListenableFuture<BatchPredictionJob> createBatchPredictionJob(CreateBatchPredictionJobRequest request)

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

getBatchPredictionJob

public com.google.common.util.concurrent.ListenableFuture<BatchPredictionJob> getBatchPredictionJob(GetBatchPredictionJobRequest request)

 Gets a BatchPredictionJob
 

listBatchPredictionJobs

public com.google.common.util.concurrent.ListenableFuture<ListBatchPredictionJobsResponse> listBatchPredictionJobs(ListBatchPredictionJobsRequest request)

 Lists BatchPredictionJobs in a Location.
 

deleteBatchPredictionJob

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> deleteBatchPredictionJob(DeleteBatchPredictionJobRequest request)

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

cancelBatchPredictionJob

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.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][google.cloud.aiplatform.v1beta1.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][google.cloud.aiplatform.v1beta1.BatchPredictionJob.state]
 is set to `CANCELLED`. Any files already outputted by the job are not
 deleted.
 

createModelDeploymentMonitoringJob

public com.google.common.util.concurrent.ListenableFuture<ModelDeploymentMonitoringJob> createModelDeploymentMonitoringJob(CreateModelDeploymentMonitoringJobRequest request)

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

searchModelDeploymentMonitoringStatsAnomalies

public com.google.common.util.concurrent.ListenableFuture<SearchModelDeploymentMonitoringStatsAnomaliesResponse> searchModelDeploymentMonitoringStatsAnomalies(SearchModelDeploymentMonitoringStatsAnomaliesRequest request)

 Searches Model Monitoring Statistics generated within a given time window.
 

getModelDeploymentMonitoringJob

public com.google.common.util.concurrent.ListenableFuture<ModelDeploymentMonitoringJob> getModelDeploymentMonitoringJob(GetModelDeploymentMonitoringJobRequest request)

 Gets a ModelDeploymentMonitoringJob.
 

listModelDeploymentMonitoringJobs

public com.google.common.util.concurrent.ListenableFuture<ListModelDeploymentMonitoringJobsResponse> listModelDeploymentMonitoringJobs(ListModelDeploymentMonitoringJobsRequest request)

 Lists ModelDeploymentMonitoringJobs in a Location.
 

updateModelDeploymentMonitoringJob

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> updateModelDeploymentMonitoringJob(UpdateModelDeploymentMonitoringJobRequest request)

 Updates a ModelDeploymentMonitoringJob.
 

deleteModelDeploymentMonitoringJob

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> deleteModelDeploymentMonitoringJob(DeleteModelDeploymentMonitoringJobRequest request)

 Deletes a ModelDeploymentMonitoringJob.
 

pauseModelDeploymentMonitoringJob

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.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][google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob.state]
 to 'PAUSED'.
 

resumeModelDeploymentMonitoringJob

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> resumeModelDeploymentMonitoringJob(ResumeModelDeploymentMonitoringJobRequest request)

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