Struct JobBuilder

pub struct JobBuilder { /* private fields */ }

A builder for a job to submit to the queue.

Implementations

impl JobBuilder

pub fn new(job_type: impl Into<Cow<'static, str>>) -> Self

Create a new job builder.

pub fn name(self, name: impl ToString) -> Self

Set the name of this job. This name is purely informational, and does not have to be unique. Jobs can be fetched by their name using Queue::get_jobs_by_name.

pub fn name_opt(self, name: Option<String>) -> Self

Set the name of this job. This name is purely informational, and does not have to be unique. Jobs can be fetched by their name using Queue::get_jobs_by_name.

pub fn priority(self, priority: i32) -> Self

Set the priority of the job.

pub fn weight(self, weight: u32) -> Self

Set the weight of the job.

pub fn run_at(self, run_at: OffsetDateTime) -> Self

Set the time at which the job should run.

pub fn payload(self, payload: Vec<u8>) -> Self

Set the payload of the job.

pub fn json_payload<T: ?Sized + Serialize>(self, payload: &T) -> Result<Self>

Serialize the payload of the job using serde_json.

pub fn retries(self, retries: Retries) -> Self

Configure all of the retry behavior of the job.

pub fn max_retries(self, max_retries: u32) -> Self

Set the maximum number of retries for the job.

pub fn backoff_initial_interval( self, backoff_initial_interval: Duration, ) -> Self

Set the initial backoff interval for the job. See Retries::backoff_initial_interval for more details

pub fn backoff_multiplier(self, backoff_multiplier: f32) -> Self

Set the backoff multiplier for the job. See Retries::backoff_multiplier for more details

pub fn backoff_randomization(self, backoff_randomization: f32) -> Self

Set the backoff randomization factor for the job. See Retries::backoff_randomization for more details

pub fn timeout(self, timeout: Duration) -> Self

Set the timeout of the job.

pub fn heartbeat_increment(self, heartbeat_increment: Duration) -> Self

Set the heartbeat increment of the job.

pub fn build(self) -> Job

Build the job.

pub async fn add_to(self, queue: &Queue) -> Result<Uuid>

Build the job and add it to a Queue.