Struct google_api_proto::google::cloud::aiplatform::v1beta1::schedule_service_client::ScheduleServiceClient

pub struct ScheduleServiceClient<T> { /* private fields */ }

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

Implementations

impl<T> ScheduleServiceClient<T>

where T: GrpcService<BoxBody>, T::Error: Into<StdError>, T::ResponseBody: Body<Data = Bytes> + Send + 'static, <T::ResponseBody as Body>::Error: Into<StdError> + Send,

pub fn new(inner: T) -> Self

pub fn with_origin(inner: T, origin: Uri) -> Self

pub fn with_interceptor<F>( inner: T, interceptor: F, ) -> ScheduleServiceClient<InterceptedService<T, F>>

where F: Interceptor, T::ResponseBody: Default, T: Service<Request<BoxBody>, Response = Response<<T as GrpcService<BoxBody>>::ResponseBody>>, <T as Service<Request<BoxBody>>>::Error: Into<StdError> + Send + Sync,

pub fn send_compressed(self, encoding: CompressionEncoding) -> Self

Compress requests with the given encoding.

This requires the server to support it otherwise it might respond with an error.

pub fn accept_compressed(self, encoding: CompressionEncoding) -> Self

Enable decompressing responses.

pub fn max_decoding_message_size(self, limit: usize) -> Self

Limits the maximum size of a decoded message.

Default: 4MB

pub fn max_encoding_message_size(self, limit: usize) -> Self

Limits the maximum size of an encoded message.

Default: usize::MAX

pub async fn create_schedule( &mut self, request: impl IntoRequest<CreateScheduleRequest>, ) -> Result<Response<Schedule>, Status>

Creates a Schedule.

pub async fn delete_schedule( &mut self, request: impl IntoRequest<DeleteScheduleRequest>, ) -> Result<Response<Operation>, Status>

Deletes a Schedule.

pub async fn get_schedule( &mut self, request: impl IntoRequest<GetScheduleRequest>, ) -> Result<Response<Schedule>, Status>

Gets a Schedule.

pub async fn list_schedules( &mut self, request: impl IntoRequest<ListSchedulesRequest>, ) -> Result<Response<ListSchedulesResponse>, Status>

Lists Schedules in a Location.

pub async fn pause_schedule( &mut self, request: impl IntoRequest<PauseScheduleRequest>, ) -> Result<Response<()>, Status>

Pauses a Schedule. Will mark [Schedule.state][google.cloud.aiplatform.v1beta1.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 async fn resume_schedule( &mut self, request: impl IntoRequest<ResumeScheduleRequest>, ) -> Result<Response<()>, Status>

Resumes a paused Schedule to start scheduling new runs. Will mark [Schedule.state][google.cloud.aiplatform.v1beta1.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.catchUp][] is set up true, all missed runs will be scheduled for backfill first.

pub async fn update_schedule( &mut self, request: impl IntoRequest<UpdateScheduleRequest>, ) -> Result<Response<Schedule>, Status>

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.

Trait Implementations

impl<T: Clone> Clone for ScheduleServiceClient<T>

fn clone(&self) -> ScheduleServiceClient<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for ScheduleServiceClient<T>

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

Formats the value using the given formatter.