Struct ScheduleService

pub struct ScheduleService { /* private fields */ }

Available on crate feature schedule-service only.

Implements a client for the Vertex AI API.

Example

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

Service Description

A service for creating and managing Vertex AI’s Schedule resources to periodically launch shceudled runs to make API calls.

Configuration

To configure ScheduleService 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

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

Implementations

impl ScheduleService

pub fn builder() -> ClientBuilder

Returns a builder for ScheduleService.

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

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

where T: ScheduleService + '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_schedule(&self) -> CreateSchedule

Creates a Schedule.

pub fn delete_schedule(&self) -> DeleteSchedule

Deletes a Schedule.

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 get_schedule(&self) -> GetSchedule

Gets a Schedule.

pub fn list_schedules(&self) -> ListSchedules

Lists Schedules in a Location.

pub fn pause_schedule(&self) -> PauseSchedule

Pauses a Schedule. Will mark Schedule.state to ‘PAUSED’. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.

pub fn resume_schedule(&self) -> ResumeSchedule

Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to ‘ACTIVE’. Only paused Schedule can be resumed.

When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If Schedule.catch_up is set up true, all missed runs will be scheduled for backfill first.

pub fn update_schedule(&self) -> UpdateSchedule

Updates an active or paused Schedule.

When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled.

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 ScheduleService

fn clone(&self) -> ScheduleService

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScheduleService

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

Formats the value using the given formatter.