public static final class JobServiceGrpc.JobServiceFutureStub extends AbstractFutureStub<JobServiceGrpc.JobServiceFutureStub>
A service for creating and managing Vertex AI's jobs.
Inheritance
java.lang.Object >
io.grpc.stub.AbstractStub >
io.grpc.stub.AbstractFutureStub >
JobServiceGrpc.JobServiceFutureStub
Inherited Members
io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)
io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.getCallOptions()
io.grpc.stub.AbstractStub.getChannel()
io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)
io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)
io.grpc.stub.AbstractStub.withCompression(java.lang.String)
io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)
io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)
io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)
io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)
io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)
io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)
io.grpc.stub.AbstractStub.withWaitForReady()
Methods
protected JobServiceGrpc.JobServiceFutureStub build(Channel channel, CallOptions callOptions)
Parameters
Name | Description |
channel | io.grpc.Channel
|
callOptions | io.grpc.CallOptions
|
Returns
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
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
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
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
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
public ListenableFuture<Empty> cancelDataLabelingJob(CancelDataLabelingJobRequest request)
Cancels a DataLabelingJob. Success of cancellation is not guaranteed.
Parameter
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
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
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
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
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
public ListenableFuture<BatchPredictionJob> createBatchPredictionJob(CreateBatchPredictionJobRequest request)
Creates a BatchPredictionJob. A BatchPredictionJob once created will
right away be attempted to start.
Parameter
Returns
public ListenableFuture<CustomJob> createCustomJob(CreateCustomJobRequest request)
Creates a CustomJob. A created CustomJob right away
will be attempted to be run.
Parameter
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<CustomJob> | |
public ListenableFuture<DataLabelingJob> createDataLabelingJob(CreateDataLabelingJobRequest request)
Creates a DataLabelingJob.
Parameter
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<DataLabelingJob> | |
public ListenableFuture<HyperparameterTuningJob> createHyperparameterTuningJob(CreateHyperparameterTuningJobRequest request)
Creates a HyperparameterTuningJob
Parameter
Returns
public ListenableFuture<ModelDeploymentMonitoringJob> createModelDeploymentMonitoringJob(CreateModelDeploymentMonitoringJobRequest request)
Creates a ModelDeploymentMonitoringJob. It will run periodically on a
configured interval.
Parameter
Returns
public ListenableFuture<NasJob> createNasJob(CreateNasJobRequest request)
Parameter
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<NasJob> | |
public ListenableFuture<Operation> deleteBatchPredictionJob(DeleteBatchPredictionJobRequest request)
Deletes a BatchPredictionJob. Can only be called on jobs that already
finished.
Parameter
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<Operation> | |
public ListenableFuture<Operation> deleteCustomJob(DeleteCustomJobRequest request)
Parameter
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<Operation> | |
public ListenableFuture<Operation> deleteDataLabelingJob(DeleteDataLabelingJobRequest request)
Deletes a DataLabelingJob.
Parameter
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<Operation> | |
public ListenableFuture<Operation> deleteHyperparameterTuningJob(DeleteHyperparameterTuningJobRequest request)
Deletes a HyperparameterTuningJob.
Parameter
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<Operation> | |
public ListenableFuture<Operation> deleteModelDeploymentMonitoringJob(DeleteModelDeploymentMonitoringJobRequest request)
Deletes a ModelDeploymentMonitoringJob.
Parameter
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<Operation> | |
public ListenableFuture<Operation> deleteNasJob(DeleteNasJobRequest request)
Parameter
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<Operation> | |
public ListenableFuture<BatchPredictionJob> getBatchPredictionJob(GetBatchPredictionJobRequest request)
Gets a BatchPredictionJob
Parameter
Returns
public ListenableFuture<CustomJob> getCustomJob(GetCustomJobRequest request)
Parameter
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<CustomJob> | |
public ListenableFuture<DataLabelingJob> getDataLabelingJob(GetDataLabelingJobRequest request)
Parameter
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<DataLabelingJob> | |
public ListenableFuture<HyperparameterTuningJob> getHyperparameterTuningJob(GetHyperparameterTuningJobRequest request)
Gets a HyperparameterTuningJob
Parameter
Returns
public ListenableFuture<ModelDeploymentMonitoringJob> getModelDeploymentMonitoringJob(GetModelDeploymentMonitoringJobRequest request)
Gets a ModelDeploymentMonitoringJob.
Parameter
Returns
public ListenableFuture<NasJob> getNasJob(GetNasJobRequest request)
Parameter
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<NasJob> | |
public ListenableFuture<NasTrialDetail> getNasTrialDetail(GetNasTrialDetailRequest request)
Parameter
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<NasTrialDetail> | |
public ListenableFuture<ListBatchPredictionJobsResponse> listBatchPredictionJobs(ListBatchPredictionJobsRequest request)
Lists BatchPredictionJobs in a Location.
Parameter
Returns
public ListenableFuture<ListCustomJobsResponse> listCustomJobs(ListCustomJobsRequest request)
Lists CustomJobs in a Location.
Parameter
Returns
public ListenableFuture<ListDataLabelingJobsResponse> listDataLabelingJobs(ListDataLabelingJobsRequest request)
Lists DataLabelingJobs in a Location.
Parameter
Returns
public ListenableFuture<ListHyperparameterTuningJobsResponse> listHyperparameterTuningJobs(ListHyperparameterTuningJobsRequest request)
Lists HyperparameterTuningJobs in a Location.
Parameter
Returns
public ListenableFuture<ListModelDeploymentMonitoringJobsResponse> listModelDeploymentMonitoringJobs(ListModelDeploymentMonitoringJobsRequest request)
Lists ModelDeploymentMonitoringJobs in a Location.
Parameter
Returns
public ListenableFuture<ListNasJobsResponse> listNasJobs(ListNasJobsRequest request)
Lists NasJobs in a Location.
Parameter
Returns
public ListenableFuture<ListNasTrialDetailsResponse> listNasTrialDetails(ListNasTrialDetailsRequest request)
List top NasTrialDetails of a NasJob.
Parameter
Returns
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
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
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
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
public ListenableFuture<SearchModelDeploymentMonitoringStatsAnomaliesResponse> searchModelDeploymentMonitoringStatsAnomalies(SearchModelDeploymentMonitoringStatsAnomaliesRequest request)
Searches Model Monitoring Statistics generated within a given time window.
Parameter
Returns
public ListenableFuture<Operation> updateModelDeploymentMonitoringJob(UpdateModelDeploymentMonitoringJobRequest request)
Updates a ModelDeploymentMonitoringJob.
Parameter
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<Operation> | |