Struct JobService

pub struct JobService { /* private fields */ }

Available on crate feature job-service only.

Implements a client for the Vertex AI API.

Example

let client = JobService::builder().build().await?;
// use `client` to make requests to the Vertex AI API.

Service Description

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

Configuration

To configure JobService use the with_* methods in the type returned by builder(). The default configuration should work for most applications. Common configuration changes include

• with_endpoint(): by default this client uses the global default endpoint (https://aiplatform.googleapis.com). Applications using regional endpoints or running in restricted networks (e.g. a network configured override this default.
• with_credentials(): by default this client uses Application Default Credentials. Applications using custom authentication may need to override this default.

Pooling and Cloning

JobService holds a connection pool internally, it is advised to create one and the reuse it. You do not need to wrap JobService in an Rc or Arc to reuse it, because it already uses an Arc internally.

Implementations

impl JobService

pub fn builder() -> ClientBuilder

Returns a builder for JobService.

let client = JobService::builder().build().await?;

pub fn from_stub<T>(stub: T) -> Self

where T: JobService + 'static,

Creates a new client from the provided stub.

The most common case for calling this function is in tests mocking the client’s behavior.

pub fn create_custom_job(&self) -> CreateCustomJob

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

pub fn get_custom_job(&self) -> GetCustomJob

Gets a CustomJob.

pub fn list_custom_jobs(&self) -> ListCustomJobs

Lists CustomJobs in a Location.

pub fn delete_custom_job(&self) -> DeleteCustomJob

Deletes a CustomJob.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn cancel_custom_job(&self) -> CancelCustomJob

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.

pub fn create_data_labeling_job(&self) -> CreateDataLabelingJob

Creates a DataLabelingJob.

pub fn get_data_labeling_job(&self) -> GetDataLabelingJob

Gets a DataLabelingJob.

pub fn list_data_labeling_jobs(&self) -> ListDataLabelingJobs

Lists DataLabelingJobs in a Location.

pub fn delete_data_labeling_job(&self) -> DeleteDataLabelingJob

Deletes a DataLabelingJob.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn cancel_data_labeling_job(&self) -> CancelDataLabelingJob

Cancels a DataLabelingJob. Success of cancellation is not guaranteed.

pub fn create_hyperparameter_tuning_job(&self) -> CreateHyperparameterTuningJob

Creates a HyperparameterTuningJob

pub fn get_hyperparameter_tuning_job(&self) -> GetHyperparameterTuningJob

Gets a HyperparameterTuningJob

pub fn list_hyperparameter_tuning_jobs(&self) -> ListHyperparameterTuningJobs

Lists HyperparameterTuningJobs in a Location.

pub fn delete_hyperparameter_tuning_job(&self) -> DeleteHyperparameterTuningJob

Deletes a HyperparameterTuningJob.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn cancel_hyperparameter_tuning_job(&self) -> CancelHyperparameterTuningJob

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.

pub fn create_nas_job(&self) -> CreateNasJob

Creates a NasJob

pub fn get_nas_job(&self) -> GetNasJob

Gets a NasJob

pub fn list_nas_jobs(&self) -> ListNasJobs

Lists NasJobs in a Location.

pub fn delete_nas_job(&self) -> DeleteNasJob

Deletes a NasJob.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn cancel_nas_job(&self) -> CancelNasJob

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.

pub fn get_nas_trial_detail(&self) -> GetNasTrialDetail

Gets a NasTrialDetail.

pub fn list_nas_trial_details(&self) -> ListNasTrialDetails

List top NasTrialDetails of a NasJob.

pub fn create_batch_prediction_job(&self) -> CreateBatchPredictionJob

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

pub fn get_batch_prediction_job(&self) -> GetBatchPredictionJob

Gets a BatchPredictionJob

pub fn list_batch_prediction_jobs(&self) -> ListBatchPredictionJobs

Lists BatchPredictionJobs in a Location.

pub fn delete_batch_prediction_job(&self) -> DeleteBatchPredictionJob

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

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn cancel_batch_prediction_job(&self) -> CancelBatchPredictionJob

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.

pub fn create_model_deployment_monitoring_job( &self, ) -> CreateModelDeploymentMonitoringJob

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

pub fn search_model_deployment_monitoring_stats_anomalies( &self, ) -> SearchModelDeploymentMonitoringStatsAnomalies

Searches Model Monitoring Statistics generated within a given time window.

pub fn get_model_deployment_monitoring_job( &self, ) -> GetModelDeploymentMonitoringJob

Gets a ModelDeploymentMonitoringJob.

pub fn list_model_deployment_monitoring_jobs( &self, ) -> ListModelDeploymentMonitoringJobs

Lists ModelDeploymentMonitoringJobs in a Location.

pub fn update_model_deployment_monitoring_job( &self, ) -> UpdateModelDeploymentMonitoringJob

Updates a ModelDeploymentMonitoringJob.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn delete_model_deployment_monitoring_job( &self, ) -> DeleteModelDeploymentMonitoringJob

Deletes a ModelDeploymentMonitoringJob.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn pause_model_deployment_monitoring_job( &self, ) -> PauseModelDeploymentMonitoringJob

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

pub fn resume_model_deployment_monitoring_job( &self, ) -> ResumeModelDeploymentMonitoringJob

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

pub fn list_locations(&self) -> ListLocations

Lists information about the supported locations for this service.

pub fn get_location(&self) -> GetLocation

Gets information about a location.

pub fn set_iam_policy(&self) -> SetIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

pub fn get_iam_policy(&self) -> GetIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

pub fn test_iam_permissions(&self) -> TestIamPermissions

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.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may “fail open” without warning.

pub fn list_operations(&self) -> ListOperations

Provides the Operations service functionality in this service.

pub fn get_operation(&self) -> GetOperation

Provides the Operations service functionality in this service.

pub fn delete_operation(&self) -> DeleteOperation

Provides the Operations service functionality in this service.

pub fn cancel_operation(&self) -> CancelOperation

Provides the Operations service functionality in this service.

pub fn wait_operation(&self) -> WaitOperation

Provides the Operations service functionality in this service.

Trait Implementations

impl Clone for JobService

fn clone(&self) -> JobService

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for JobService

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.