JobService class final

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

Constructors

JobService({required Client client})
Creates a JobService using client for transport.
JobService.fromApiKey([String? apiKey])
Creates a JobService that does authentication through an API key.
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

cancelBatchPredictionJob(CancelBatchPredictionJobRequest request) → Future<void>
Cancels a BatchPredictionJob.
cancelCustomJob(CancelCustomJobRequest request) → Future<void>
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.
cancelDataLabelingJob(CancelDataLabelingJobRequest request) → Future<void>
Cancels a DataLabelingJob. Success of cancellation is not guaranteed.
cancelHyperparameterTuningJob(CancelHyperparameterTuningJobRequest request) → Future<void>
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.
cancelNasJob(CancelNasJobRequest request) → Future<void>
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.
cancelOperation(CancelOperationRequest request) → Future<void>
Provides the Operations service functionality in this service.
close() → void
Closes the client and cleans up any resources associated with it.
createBatchPredictionJob(CreateBatchPredictionJobRequest request) → Future<BatchPredictionJob>
Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.
createCustomJob(CreateCustomJobRequest request) → Future<CustomJob>
Creates a CustomJob. A created CustomJob right away will be attempted to be run.
createDataLabelingJob(CreateDataLabelingJobRequest request) → Future<DataLabelingJob>
Creates a DataLabelingJob.
createHyperparameterTuningJob(CreateHyperparameterTuningJobRequest request) → Future<HyperparameterTuningJob>
Creates a HyperparameterTuningJob
createModelDeploymentMonitoringJob(CreateModelDeploymentMonitoringJobRequest request) → Future<ModelDeploymentMonitoringJob>
Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval.
createNasJob(CreateNasJobRequest request) → Future<NasJob>
Creates a NasJob
deleteBatchPredictionJob(DeleteBatchPredictionJobRequest request) → Future<Operation<Empty, DeleteOperationMetadata>>
Deletes a BatchPredictionJob. Can only be called on jobs that already finished.
deleteCustomJob(DeleteCustomJobRequest request) → Future<Operation<Empty, DeleteOperationMetadata>>
Deletes a CustomJob.
deleteDataLabelingJob(DeleteDataLabelingJobRequest request) → Future<Operation<Empty, DeleteOperationMetadata>>
Deletes a DataLabelingJob.
deleteHyperparameterTuningJob(DeleteHyperparameterTuningJobRequest request) → Future<Operation<Empty, DeleteOperationMetadata>>
Deletes a HyperparameterTuningJob.
deleteModelDeploymentMonitoringJob(DeleteModelDeploymentMonitoringJobRequest request) → Future<Operation<Empty, DeleteOperationMetadata>>
Deletes a ModelDeploymentMonitoringJob.
deleteNasJob(DeleteNasJobRequest request) → Future<Operation<Empty, DeleteOperationMetadata>>
Deletes a NasJob.
deleteOperation(DeleteOperationRequest request) → Future<void>
Provides the Operations service functionality in this service.
getBatchPredictionJob(GetBatchPredictionJobRequest request) → Future<BatchPredictionJob>
Gets a BatchPredictionJob
getCustomJob(GetCustomJobRequest request) → Future<CustomJob>
Gets a CustomJob.
getDataLabelingJob(GetDataLabelingJobRequest request) → Future<DataLabelingJob>
Gets a DataLabelingJob.
getHyperparameterTuningJob(GetHyperparameterTuningJobRequest request) → Future<HyperparameterTuningJob>
Gets a HyperparameterTuningJob
getIamPolicy(GetIamPolicyRequest request) → Future<Policy>
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
getLocation(GetLocationRequest request) → Future<Location>
Gets information about a location.
getModelDeploymentMonitoringJob(GetModelDeploymentMonitoringJobRequest request) → Future<ModelDeploymentMonitoringJob>
Gets a ModelDeploymentMonitoringJob.
getNasJob(GetNasJobRequest request) → Future<NasJob>
Gets a NasJob
getNasTrialDetail(GetNasTrialDetailRequest request) → Future<NasTrialDetail>
Gets a NasTrialDetail.
getOperation<T extends ProtoMessage, S extends ProtoMessage>(Operation<T, S> request) → Future<Operation<T, S>>
Provides the Operations service functionality in this service.
listBatchPredictionJobs(ListBatchPredictionJobsRequest request) → Future<ListBatchPredictionJobsResponse>
Lists BatchPredictionJobs in a Location.
listCustomJobs(ListCustomJobsRequest request) → Future<ListCustomJobsResponse>
Lists CustomJobs in a Location.
listDataLabelingJobs(ListDataLabelingJobsRequest request) → Future<ListDataLabelingJobsResponse>
Lists DataLabelingJobs in a Location.
listHyperparameterTuningJobs(ListHyperparameterTuningJobsRequest request) → Future<ListHyperparameterTuningJobsResponse>
Lists HyperparameterTuningJobs in a Location.
listLocations(ListLocationsRequest request) → Future<ListLocationsResponse>
Lists information about the supported locations for this service.
listModelDeploymentMonitoringJobs(ListModelDeploymentMonitoringJobsRequest request) → Future<ListModelDeploymentMonitoringJobsResponse>
Lists ModelDeploymentMonitoringJobs in a Location.
listNasJobs(ListNasJobsRequest request) → Future<ListNasJobsResponse>
Lists NasJobs in a Location.
listNasTrialDetails(ListNasTrialDetailsRequest request) → Future<ListNasTrialDetailsResponse>
List top NasTrialDetails of a NasJob.
listOperations(ListOperationsRequest request) → Future<ListOperationsResponse>
Provides the Operations service functionality in this service.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pauseModelDeploymentMonitoringJob(PauseModelDeploymentMonitoringJobRequest request) → Future<void>
Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark ModelDeploymentMonitoringJob.state to 'PAUSED'.
resumeModelDeploymentMonitoringJob(ResumeModelDeploymentMonitoringJobRequest request) → Future<void>
Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.
searchModelDeploymentMonitoringStatsAnomalies(SearchModelDeploymentMonitoringStatsAnomaliesRequest request) → Future<SearchModelDeploymentMonitoringStatsAnomaliesResponse>
Searches Model Monitoring Statistics generated within a given time window.
setIamPolicy(SetIamPolicyRequest request) → Future<Policy>
Sets the access control policy on the specified resource. Replaces any existing policy.
testIamPermissions(TestIamPermissionsRequest request) → Future<TestIamPermissionsResponse>
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
toString() → String
A string representation of this object.
inherited
updateModelDeploymentMonitoringJob(UpdateModelDeploymentMonitoringJobRequest request) → Future<Operation<ModelDeploymentMonitoringJob, UpdateModelDeploymentMonitoringJobOperationMetadata>>
Updates a ModelDeploymentMonitoringJob.
waitOperation(WaitOperationRequest request) → Future<Operation<ProtoMessage, ProtoMessage>>
Provides the Operations service functionality in this service.

Operators

operator ==(Object other) → bool
The equality operator.
inherited