pub struct JobsResource<'a> { /* private fields */ }Expand description
client.jobs()
Implementations§
Source§impl<'a> JobsResource<'a>
impl<'a> JobsResource<'a>
Sourcepub fn list(&self) -> Result<Vec<Job>>
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);
}Sourcepub fn list_with(&self, query: &GetJobsQuery) -> Result<Vec<Job>>
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.
Sourcepub fn logs(&self, identifier: impl Display, body: &JobLogCreate) -> Result<()>
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)?;Sourcepub fn update_status(
&self,
identifier: impl Display,
body: &JobStatusUpdate,
) -> Result<()>
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)?;