Struct JobDefinition

pub struct JobDefinition {
    pub job_type_id: Cow<'static, str>,
    pub target_execution_time: SystemTime,
    pub input_payload_json: String,
    pub labels: IndexMap<String, String>,
    pub timeout_policy: TimeoutPolicy,
    pub retry_policy: RetryPolicy,
    pub metadata_json: Option<String>,
}

The definition of a job that can be executed in the future.

Fields

job_type_id: Cow<'static, str>

The ID of the job type.

target_execution_time: SystemTime

The target execution time of the job.

If not provided, it should be set to the current time.

input_payload_json: String

The job input payload JSON that is passed to the worker.

labels: IndexMap<String, String>

The labels of the job.

timeout_policy: TimeoutPolicy

The timeout policy of the job.

retry_policy: RetryPolicy

Retry policy for the job.

metadata_json: Option<String>

Additional metadata for the job.

Implementations

impl JobDefinition

pub fn at(self, target_execution_time: impl Into<SystemTime>) -> Self

Set the target execution time of the job.

pub fn now(self) -> Self

Set the target execution time of the job to the current time.

pub fn with_label( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Add a label to the job.

pub fn with_label_json( self, key: impl Into<String>, value: impl Serialize, ) -> Self

Add a JSON label to the job.

Panics

If the value cannot be serialized to JSON.

pub fn with_timeout(self, timeout: impl Into<Duration>) -> Self

Set the timeout for the job.

The timeout is calculated from the start time of the job by default.

pub fn with_retries(self, retries: u64) -> Self

Set the number of retries for the job.

pub fn replace_metadata(self, metadata: impl Serialize) -> Self

Set additional metadata for the job.

Note that this will replace any existing metadata.

Panics

If the metadata cannot be serialized to JSON.

impl JobDefinition

pub fn repeat_every(self, interval: Duration) -> ScheduleDefinition

Create a schedule from the job definition that repeats at a fixed interval.

pub fn repeat_cron( self, cron_expression: impl Into<String>, ) -> Result<ScheduleDefinition>

Create a schedule from the job definition that repeats according to a cron expression.

Errors

If the cron expression is invalid.

impl JobDefinition

pub fn into_typed_unknown(self) -> TypedJobDefinition

Cast the job definition to a typed job definition with an unknown job type.

pub fn into_typed<J>(self) -> TypedJobDefinition<J>

Cast the job definition to a typed job definition with a known job type.

Trait Implementations

impl Clone for JobDefinition

fn clone(&self) -> JobDefinition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JobDefinition

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

Formats the value using the given formatter.

impl From<JobDefinition> for JobDefinition

fn from(definition: JobDefinition) -> Self

Converts to this type from the input type.

impl From<JobDefinition> for JobDefinition

fn from(definition: JobDefinition) -> Self

Converts to this type from the input type.

impl<J> From<JobDefinition> for TypedJobDefinition<J>

fn from(job_definition: JobDefinition) -> Self

Converts to this type from the input type.

impl<J> From<TypedJobDefinition<J>> for JobDefinition

fn from(typed: TypedJobDefinition<J>) -> Self

Converts to this type from the input type.