Struct CreateScheduleRequest 

pub struct CreateScheduleRequest {
    pub catchup: Option<CatchupPolicy>,
    pub catchup_max: Option<i32>,
    pub catchup_window_secs: Option<i32>,
    pub cron_expression: String,
    pub inputs: Option<Value>,
    pub overlap: Option<OverlapPolicy>,
    pub priority: Option<i32>,
    pub timezone: Option<String>,
    pub workflow_name: String,
}

Create schedule request body.

JSON schema

{
 "description": "Create schedule request body.",
 "type": "object",
 "required": [
   "cron_expression",
   "workflow_name"
 ],
 "properties": {
   "catchup": {
     "$ref": "#/components/schemas/CatchupPolicy"
   },
   "catchup_max": {
     "description": "Most runs created to catch up under `catchup = all`, from 1 to 1000.\nDefaults to 10.",
     "type": [
       "integer",
       "null"
     ],
     "format": "int32",
     "minimum": 0.0
   },
   "catchup_window_secs": {
     "description": "How far back, in seconds, a missed occurrence is still caught up, from\n60 to 2592000 (30 days). Defaults to 86400 (one day).",
     "type": [
       "integer",
       "null"
     ],
     "format": "int32",
     "minimum": 0.0
   },
   "cron_expression": {
     "description": "Cron expression (6-field format, e.g. `\"0 */5 * * * *\"`).",
     "type": "string"
   },
   "inputs": {
     "description": "JSON payload for the workflow. Defaults to `{}`."
   },
   "overlap": {
     "$ref": "#/components/schemas/OverlapPolicy"
   },
   "priority": {
     "description": "Queue priority given to every run the schedule creates, from -100 to\n100. Defaults to the priority the workflow handler declares.\n\nA higher priority run is picked first by workers. A running run is\nnever preempted, and a low priority run is not aged.",
     "type": [
       "integer",
       "null"
     ],
     "format": "int32"
   },
   "timezone": {
     "description": "IANA timezone the cron expression is evaluated in, e.g.\n`\"Europe/Paris\"`. Defaults to `\"UTC\"`.",
     "type": [
       "string",
       "null"
     ]
   },
   "workflow_name": {
     "description": "Name of the workflow to trigger.",
     "type": "string"
   }
 }
}
```ignore
</details>

Fields

catchup: Option<CatchupPolicy>

catchup_max: Option<i32>

Most runs created to catch up under catchup = all, from 1 to 1000. Defaults to 10.

catchup_window_secs: Option<i32>

How far back, in seconds, a missed occurrence is still caught up, from 60 to 2592000 (30 days). Defaults to 86400 (one day).

cron_expression: String

Cron expression (6-field format, e.g. "0 */5 * * * *").

inputs: Option<Value>

JSON payload for the workflow. Defaults to {}.

overlap: Option<OverlapPolicy>

priority: Option<i32>

Queue priority given to every run the schedule creates, from -100 to 100. Defaults to the priority the workflow handler declares.

A higher priority run is picked first by workers. A running run is never preempted, and a low priority run is not aged.

timezone: Option<String>

IANA timezone the cron expression is evaluated in, e.g. "Europe/Paris". Defaults to "UTC".

workflow_name: String

Name of the workflow to trigger.

Implementations

impl CreateScheduleRequest

pub fn builder() -> CreateScheduleRequest

Trait Implementations

impl Clone for CreateScheduleRequest

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateScheduleRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CreateScheduleRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CreateScheduleRequest> for CreateScheduleRequest

fn from(value: CreateScheduleRequest) -> Self

Converts to this type from the input type.

impl Serialize for CreateScheduleRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<CreateScheduleRequest> for CreateScheduleRequest

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: CreateScheduleRequest) -> Result<Self, ConversionError>

Performs the conversion.