Struct gcp_client::google::cloud::scheduler::v1::cloud_scheduler_client::CloudSchedulerClient

pub struct CloudSchedulerClient<T> { /* fields omitted */ }

The Cloud Scheduler API allows external entities to reliably schedule asynchronous jobs.

Implementations

impl<T> CloudSchedulerClient<T> where
    T: GrpcService<BoxBody>,
    T::ResponseBody: Body + HttpBody + Send + 'static,
    T::Error: Into<StdError>,
    <T::ResponseBody as HttpBody>::Error: Into<StdError> + Send, 

pub fn new(inner: T) -> Self

pub fn with_interceptor(inner: T, interceptor: impl Into<Interceptor>) -> Self

pub async fn list_jobs<'_>(
    &'_ mut self,
    request: impl IntoRequest<ListJobsRequest>
) -> Result<Response<ListJobsResponse>, Status>

Lists jobs.

pub async fn get_job<'_>(
    &'_ mut self,
    request: impl IntoRequest<GetJobRequest>
) -> Result<Response<Job>, Status>

Gets a job.

pub async fn create_job<'_>(
    &'_ mut self,
    request: impl IntoRequest<CreateJobRequest>
) -> Result<Response<Job>, Status>

Creates a job.

pub async fn update_job<'_>(
    &'_ mut self,
    request: impl IntoRequest<UpdateJobRequest>
) -> Result<Response<Job>, Status>

Updates a job.

If successful, the updated [Job][google.cloud.scheduler.v1.Job] is returned. If the job does not exist, NOT_FOUND is returned.

If UpdateJob does not successfully return, it is possible for the job to be in an [Job.State.UPDATE_FAILED][google.cloud.scheduler.v1.Job.State.UPDATE_FAILED] state. A job in this state may not be executed. If this happens, retry the UpdateJob request until a successful response is received.

pub async fn delete_job<'_>(
    &'_ mut self,
    request: impl IntoRequest<DeleteJobRequest>
) -> Result<Response<()>, Status>

Deletes a job.

pub async fn pause_job<'_>(
    &'_ mut self,
    request: impl IntoRequest<PauseJobRequest>
) -> Result<Response<Job>, Status>

Pauses a job.

If a job is paused then the system will stop executing the job until it is re-enabled via [ResumeJob][google.cloud.scheduler.v1.CloudScheduler.ResumeJob]. The state of the job is stored in [state][google.cloud.scheduler.v1.Job.state]; if paused it will be set to [Job.State.PAUSED][google.cloud.scheduler.v1.Job.State.PAUSED]. A job must be in [Job.State.ENABLED][google.cloud.scheduler.v1.Job.State.ENABLED] to be paused.

pub async fn resume_job<'_>(
    &'_ mut self,
    request: impl IntoRequest<ResumeJobRequest>
) -> Result<Response<Job>, Status>

Resume a job.

This method reenables a job after it has been [Job.State.PAUSED][google.cloud.scheduler.v1.Job.State.PAUSED]. The state of a job is stored in [Job.state][google.cloud.scheduler.v1.Job.state]; after calling this method it will be set to [Job.State.ENABLED][google.cloud.scheduler.v1.Job.State.ENABLED]. A job must be in [Job.State.PAUSED][google.cloud.scheduler.v1.Job.State.PAUSED] to be resumed.

pub async fn run_job<'_>(
    &'_ mut self,
    request: impl IntoRequest<RunJobRequest>
) -> Result<Response<Job>, Status>

Forces a job to run now.

When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running.

Trait Implementations

impl<T: Clone> Clone for CloudSchedulerClient<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for CloudSchedulerClient<T>

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

Formats the value using the given formatter.