Class JobServiceGrpc.JobServiceBlockingStub (3.33.0)

public static final class JobServiceGrpc.JobServiceBlockingStub extends AbstractBlockingStub<JobServiceGrpc.JobServiceBlockingStub>

A stub to allow clients to do synchronous 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.AbstractBlockingStub > JobServiceGrpc.JobServiceBlockingStub

Methods

build(Channel channel, CallOptions callOptions)

protected JobServiceGrpc.JobServiceBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
JobServiceGrpc.JobServiceBlockingStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

cancelBatchPredictionJob(CancelBatchPredictionJobRequest request)

public 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
NameDescription
requestCancelBatchPredictionJobRequest
Returns
TypeDescription
Empty

cancelCustomJob(CancelCustomJobRequest request)

public 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
NameDescription
requestCancelCustomJobRequest
Returns
TypeDescription
Empty

cancelDataLabelingJob(CancelDataLabelingJobRequest request)

public Empty cancelDataLabelingJob(CancelDataLabelingJobRequest request)

Cancels a DataLabelingJob. Success of cancellation is not guaranteed.

Parameter
NameDescription
requestCancelDataLabelingJobRequest
Returns
TypeDescription
Empty

cancelHyperparameterTuningJob(CancelHyperparameterTuningJobRequest request)

public 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
NameDescription
requestCancelHyperparameterTuningJobRequest
Returns
TypeDescription
Empty

cancelNasJob(CancelNasJobRequest request)

public 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
NameDescription
requestCancelNasJobRequest
Returns
TypeDescription
Empty

createBatchPredictionJob(CreateBatchPredictionJobRequest request)

public BatchPredictionJob createBatchPredictionJob(CreateBatchPredictionJobRequest request)

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

Parameter
NameDescription
requestCreateBatchPredictionJobRequest
Returns
TypeDescription
BatchPredictionJob

createCustomJob(CreateCustomJobRequest request)

public CustomJob createCustomJob(CreateCustomJobRequest request)

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

Parameter
NameDescription
requestCreateCustomJobRequest
Returns
TypeDescription
CustomJob

createDataLabelingJob(CreateDataLabelingJobRequest request)

public DataLabelingJob createDataLabelingJob(CreateDataLabelingJobRequest request)

Creates a DataLabelingJob.

Parameter
NameDescription
requestCreateDataLabelingJobRequest
Returns
TypeDescription
DataLabelingJob

createHyperparameterTuningJob(CreateHyperparameterTuningJobRequest request)

public HyperparameterTuningJob createHyperparameterTuningJob(CreateHyperparameterTuningJobRequest request)

Creates a HyperparameterTuningJob

Parameter
NameDescription
requestCreateHyperparameterTuningJobRequest
Returns
TypeDescription
HyperparameterTuningJob

createModelDeploymentMonitoringJob(CreateModelDeploymentMonitoringJobRequest request)

public ModelDeploymentMonitoringJob createModelDeploymentMonitoringJob(CreateModelDeploymentMonitoringJobRequest request)

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

Parameter
NameDescription
requestCreateModelDeploymentMonitoringJobRequest
Returns
TypeDescription
ModelDeploymentMonitoringJob

createNasJob(CreateNasJobRequest request)

public NasJob createNasJob(CreateNasJobRequest request)

Creates a NasJob

Parameter
NameDescription
requestCreateNasJobRequest
Returns
TypeDescription
NasJob

deleteBatchPredictionJob(DeleteBatchPredictionJobRequest request)

public Operation deleteBatchPredictionJob(DeleteBatchPredictionJobRequest request)

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

Parameter
NameDescription
requestDeleteBatchPredictionJobRequest
Returns
TypeDescription
Operation

deleteCustomJob(DeleteCustomJobRequest request)

public Operation deleteCustomJob(DeleteCustomJobRequest request)

Deletes a CustomJob.

Parameter
NameDescription
requestDeleteCustomJobRequest
Returns
TypeDescription
Operation

deleteDataLabelingJob(DeleteDataLabelingJobRequest request)

public Operation deleteDataLabelingJob(DeleteDataLabelingJobRequest request)

Deletes a DataLabelingJob.

Parameter
NameDescription
requestDeleteDataLabelingJobRequest
Returns
TypeDescription
Operation

deleteHyperparameterTuningJob(DeleteHyperparameterTuningJobRequest request)

public Operation deleteHyperparameterTuningJob(DeleteHyperparameterTuningJobRequest request)

Deletes a HyperparameterTuningJob.

Parameter
NameDescription
requestDeleteHyperparameterTuningJobRequest
Returns
TypeDescription
Operation

deleteModelDeploymentMonitoringJob(DeleteModelDeploymentMonitoringJobRequest request)

public Operation deleteModelDeploymentMonitoringJob(DeleteModelDeploymentMonitoringJobRequest request)

Deletes a ModelDeploymentMonitoringJob.

Parameter
NameDescription
requestDeleteModelDeploymentMonitoringJobRequest
Returns
TypeDescription
Operation

deleteNasJob(DeleteNasJobRequest request)

public Operation deleteNasJob(DeleteNasJobRequest request)

Deletes a NasJob.

Parameter
NameDescription
requestDeleteNasJobRequest
Returns
TypeDescription
Operation

getBatchPredictionJob(GetBatchPredictionJobRequest request)

public BatchPredictionJob getBatchPredictionJob(GetBatchPredictionJobRequest request)

Gets a BatchPredictionJob

Parameter
NameDescription
requestGetBatchPredictionJobRequest
Returns
TypeDescription
BatchPredictionJob

getCustomJob(GetCustomJobRequest request)

public CustomJob getCustomJob(GetCustomJobRequest request)

Gets a CustomJob.

Parameter
NameDescription
requestGetCustomJobRequest
Returns
TypeDescription
CustomJob

getDataLabelingJob(GetDataLabelingJobRequest request)

public DataLabelingJob getDataLabelingJob(GetDataLabelingJobRequest request)

Gets a DataLabelingJob.

Parameter
NameDescription
requestGetDataLabelingJobRequest
Returns
TypeDescription
DataLabelingJob

getHyperparameterTuningJob(GetHyperparameterTuningJobRequest request)

public HyperparameterTuningJob getHyperparameterTuningJob(GetHyperparameterTuningJobRequest request)

Gets a HyperparameterTuningJob

Parameter
NameDescription
requestGetHyperparameterTuningJobRequest
Returns
TypeDescription
HyperparameterTuningJob

getModelDeploymentMonitoringJob(GetModelDeploymentMonitoringJobRequest request)

public ModelDeploymentMonitoringJob getModelDeploymentMonitoringJob(GetModelDeploymentMonitoringJobRequest request)

Gets a ModelDeploymentMonitoringJob.

Parameter
NameDescription
requestGetModelDeploymentMonitoringJobRequest
Returns
TypeDescription
ModelDeploymentMonitoringJob

getNasJob(GetNasJobRequest request)

public NasJob getNasJob(GetNasJobRequest request)

Gets a NasJob

Parameter
NameDescription
requestGetNasJobRequest
Returns
TypeDescription
NasJob

getNasTrialDetail(GetNasTrialDetailRequest request)

public NasTrialDetail getNasTrialDetail(GetNasTrialDetailRequest request)

Gets a NasTrialDetail.

Parameter
NameDescription
requestGetNasTrialDetailRequest
Returns
TypeDescription
NasTrialDetail

listBatchPredictionJobs(ListBatchPredictionJobsRequest request)

public ListBatchPredictionJobsResponse listBatchPredictionJobs(ListBatchPredictionJobsRequest request)

Lists BatchPredictionJobs in a Location.

Parameter
NameDescription
requestListBatchPredictionJobsRequest
Returns
TypeDescription
ListBatchPredictionJobsResponse

listCustomJobs(ListCustomJobsRequest request)

public ListCustomJobsResponse listCustomJobs(ListCustomJobsRequest request)

Lists CustomJobs in a Location.

Parameter
NameDescription
requestListCustomJobsRequest
Returns
TypeDescription
ListCustomJobsResponse

listDataLabelingJobs(ListDataLabelingJobsRequest request)

public ListDataLabelingJobsResponse listDataLabelingJobs(ListDataLabelingJobsRequest request)

Lists DataLabelingJobs in a Location.

Parameter
NameDescription
requestListDataLabelingJobsRequest
Returns
TypeDescription
ListDataLabelingJobsResponse

listHyperparameterTuningJobs(ListHyperparameterTuningJobsRequest request)

public ListHyperparameterTuningJobsResponse listHyperparameterTuningJobs(ListHyperparameterTuningJobsRequest request)

Lists HyperparameterTuningJobs in a Location.

Parameter
NameDescription
requestListHyperparameterTuningJobsRequest
Returns
TypeDescription
ListHyperparameterTuningJobsResponse

listModelDeploymentMonitoringJobs(ListModelDeploymentMonitoringJobsRequest request)

public ListModelDeploymentMonitoringJobsResponse listModelDeploymentMonitoringJobs(ListModelDeploymentMonitoringJobsRequest request)

Lists ModelDeploymentMonitoringJobs in a Location.

Parameter
NameDescription
requestListModelDeploymentMonitoringJobsRequest
Returns
TypeDescription
ListModelDeploymentMonitoringJobsResponse

listNasJobs(ListNasJobsRequest request)

public ListNasJobsResponse listNasJobs(ListNasJobsRequest request)

Lists NasJobs in a Location.

Parameter
NameDescription
requestListNasJobsRequest
Returns
TypeDescription
ListNasJobsResponse

listNasTrialDetails(ListNasTrialDetailsRequest request)

public ListNasTrialDetailsResponse listNasTrialDetails(ListNasTrialDetailsRequest request)

List top NasTrialDetails of a NasJob.

Parameter
NameDescription
requestListNasTrialDetailsRequest
Returns
TypeDescription
ListNasTrialDetailsResponse

pauseModelDeploymentMonitoringJob(PauseModelDeploymentMonitoringJobRequest request)

public 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
NameDescription
requestPauseModelDeploymentMonitoringJobRequest
Returns
TypeDescription
Empty

resumeModelDeploymentMonitoringJob(ResumeModelDeploymentMonitoringJobRequest request)

public 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
NameDescription
requestResumeModelDeploymentMonitoringJobRequest
Returns
TypeDescription
Empty

searchModelDeploymentMonitoringStatsAnomalies(SearchModelDeploymentMonitoringStatsAnomaliesRequest request)

public SearchModelDeploymentMonitoringStatsAnomaliesResponse searchModelDeploymentMonitoringStatsAnomalies(SearchModelDeploymentMonitoringStatsAnomaliesRequest request)

Searches Model Monitoring Statistics generated within a given time window.

Parameter
NameDescription
requestSearchModelDeploymentMonitoringStatsAnomaliesRequest
Returns
TypeDescription
SearchModelDeploymentMonitoringStatsAnomaliesResponse

updateModelDeploymentMonitoringJob(UpdateModelDeploymentMonitoringJobRequest request)

public Operation updateModelDeploymentMonitoringJob(UpdateModelDeploymentMonitoringJobRequest request)

Updates a ModelDeploymentMonitoringJob.

Parameter
NameDescription
requestUpdateModelDeploymentMonitoringJobRequest
Returns
TypeDescription
Operation