Struct AdminClient

pub struct AdminClient<C = Channel> { /* private fields */ }

A high-level client for interacting with the Ora server admin endpoints.

Implementations

impl<C> AdminClient<C>

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

pub fn new(client: AdminServiceClient<C>) -> Self

Create a new admin client from a gRPC client.

pub async fn add_job<J>( &self, definition: TypedJobDefinition<J>, ) -> Result<JobHandle<J, C>, AdminClientError>

Add a new job to be executed.

pub async fn add_job_persistent<J>( &self, definition: TypedJobDefinition<J>, ) -> Result<PersistentJob<J, C>, AdminClientError>

Add a new job to be executed.

If an active job with the same job type and labels already exists, it will be returned instead.

pub async fn add_jobs<J>( &self, definitions: impl IntoIterator<Item = TypedJobDefinition<J>>, ) -> Result<Vec<JobHandle<J, C>>, AdminClientError>

Add multiple new jobs to be executed.

pub fn job(&self, job_id: Uuid) -> JobHandle<(), C>

Create a job handle for a specific job.

Note that this method does not check if the job exists.

pub fn jobs_of_type<J>( &self, filter: JobFilter, order_by: JobOrder, ) -> impl Stream<Item = Result<JobHandle<J, C>, AdminClientError>> + Send + Unpin + 'static

where J: JobType,

Retrieve a list of jobs of a specific type with a specific filter and order.

The returned job handles will have their details pre-fetched.

pub fn jobs( &self, filter: JobFilter, order_by: JobOrder, ) -> impl Stream<Item = Result<JobHandle<(), C>, AdminClientError>> + Send + Unpin + 'static

Retrieve a list of jobs with a specific filter and order.

The returned job handles will have their details pre-fetched.

pub async fn job_count( &self, filter: JobFilter, ) -> Result<u64, AdminClientError>

Count the number of jobs with a specific filter.

pub async fn job_count_of_type<J>( &self, filter: JobFilter, ) -> Result<u64, AdminClientError>

where J: JobType,

Count the number of jobs of a specific type with a specific filter.

pub async fn cancel_jobs( &self, filter: JobFilter, ) -> Result<Vec<JobHandle<(), C>>, AdminClientError>

Cancel jobs with a specific filter.

Returns handles to jobs that were successfully cancelled.

pub async fn delete_inactive_jobs( &self, filter: JobFilter, ) -> Result<Vec<Uuid>, AdminClientError>

Delete inactive jobs and associated with a specific filter, returning the deleted job IDs.

pub async fn add_schedule( &self, schedule: ScheduleDefinition, ) -> Result<ScheduleHandle<C>, AdminClientError>

Add a new schedule.

pub async fn add_schedule_persistent( &self, schedule: ScheduleDefinition, ) -> Result<PersistentSchedule<C>, AdminClientError>

Add a new schedule.

If an active schedule with the same job type and labels already exists, it will be returned instead.

pub async fn add_schedules( &self, schedules: impl IntoIterator<Item = ScheduleDefinition>, ) -> Result<Vec<ScheduleHandle<C>>, AdminClientError>

Add multiple new schedules.

Returns handles to the created schedules.

pub fn schedule(&self, schedule_id: Uuid) -> ScheduleHandle<C>

Create a new schedule handle for a specific schedule.

Note that this method does not check if the schedule exists.

pub fn schedules( &self, filter: ScheduleFilter, order: ScheduleOrder, ) -> impl Stream<Item = Result<ScheduleHandle<C>, AdminClientError>> + Send + Unpin + 'static

Retrieve a list of schedules with a specific filter and order.

The returned schedule handles will have their details pre-fetched.

pub async fn schedule_count( &self, filter: ScheduleFilter, ) -> Result<u64, AdminClientError>

Return the number of schedules that match a specific filter.

pub async fn cancel_schedules( &self, filter: ScheduleFilter, cancel_jobs: bool, ) -> Result<ScheduleCancellationResult<C>, AdminClientError>

Cancel schedules with a specific filter, optionally cancelling the jobs associated with them.

Trait Implementations

impl<C: Clone> Clone for AdminClient<C>

fn clone(&self) -> AdminClient<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug> Debug for AdminClient<C>

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

Formats the value using the given formatter.

impl From<AdminServiceClient<Channel>> for AdminClient

fn from(client: AdminServiceClient<Channel>) -> Self

Converts to this type from the input type.