Skip to main content

JobsResource

Struct JobsResource 

Source
pub struct JobsResource<'a> { /* private fields */ }
Expand description

client.jobs()

Implementations§

Source§

impl<'a> JobsResource<'a>

Source

pub fn list(&self) -> Result<Vec<Job>>

List background jobs

GET /jobs

Lists persisted background jobs, newest creation time first. Requires “administer settings” permission in churchcore. All supplied filters are combined with AND; status/domain ID lists match any contained value. Empty lists add no restriction. No pagination or result limit is implemented.

Use Self::list_with to pass query parameters.

§Example
for job in client.jobs().list()? {
    println!("{}", job.name);
}
Source

pub fn list_with(&self, query: &GetJobsQuery) -> Result<Vec<Job>>

List background jobs

Like Self::list, with query parameters.

GET /jobs

Lists persisted background jobs, newest creation time first. Requires “administer settings” permission in churchcore. All supplied filters are combined with AND; status/domain ID lists match any contained value. Empty lists add no restriction. No pagination or result limit is implemented.

Source

pub fn logs(&self, identifier: impl Display, body: &JobLogCreate) -> Result<()>

Append a background-job log message

POST /jobs/{identifier}/logs

Appends an application log entry for an existing background job. Requires “administer settings” permission in churchcore. Returns no response body.

§Example
let body = models::JobLogCreate {
    log_message: "Processed 25 records.".into(),
    ..Default::default()
};
client.jobs().logs("1a9e9b86-78ee-4c8a-bf58-51e653073a0c", &body)?;
Source

pub fn update_status( &self, identifier: impl Display, body: &JobStatusUpdate, ) -> Result<()>

Update a background-job status

PUT /jobs/{identifier}/status

Updates the stored job status. For sync_job jobs, “view” permission in churchsync is required; other jobs require “administer settings” permission in churchcore. This endpoint does not start or stop a worker.

§Example
let body = models::JobStatusUpdate {
    status: "QUEUED".into(),
    ..Default::default()
};
client.jobs().update_status("1a9e9b86-78ee-4c8a-bf58-51e653073a0c", &body)?;

Trait Implementations§

Source§

impl<'a> Clone for JobsResource<'a>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for JobsResource<'a>

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for JobsResource<'a>

§

impl<'a> !UnwindSafe for JobsResource<'a>

§

impl<'a> Freeze for JobsResource<'a>

§

impl<'a> Send for JobsResource<'a>

§

impl<'a> Sync for JobsResource<'a>

§

impl<'a> Unpin for JobsResource<'a>

§

impl<'a> UnsafeUnpin for JobsResource<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more