Struct WorkflowStartOptions 

#[non_exhaustive]
pub struct WorkflowStartOptions {

    pub task_queue: String,
    pub workflow_id: String,
    pub id_reuse_policy: WorkflowIdReusePolicy,
    pub id_conflict_policy: WorkflowIdConflictPolicy,
    pub execution_timeout: Option<Duration>,
    pub run_timeout: Option<Duration>,
    pub task_timeout: Option<Duration>,
    pub cron_schedule: Option<String>,
    pub search_attributes: Option<HashMap<String, Payload>>,
    pub enable_eager_workflow_start: bool,
    pub retry_policy: Option<RetryPolicy>,
    pub start_signal: Option<WorkflowStartSignal>,
    pub links: Vec<Link>,
    pub completion_callbacks: Vec<Callback>,
    pub priority: Priority,
    pub header: Option<Header>,
}

Options for starting a workflow execution.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

task_queue: String

The task queue to run the workflow on.

workflow_id: String

The workflow ID.

id_reuse_policy: WorkflowIdReusePolicy

Set the policy for reusing the workflow id

id_conflict_policy: WorkflowIdConflictPolicy

Set the policy for how to resolve conflicts with running policies. NOTE: This is ignored for child workflows.

execution_timeout: Option<Duration>

Optionally set the execution timeout for the workflow https://docs.temporal.io/workflows/#workflow-execution-timeout

run_timeout: Option<Duration>

Optionally indicates the default run timeout for a workflow run

task_timeout: Option<Duration>

Optionally indicates the default task timeout for a workflow run

cron_schedule: Option<String>

Optionally set a cron schedule for the workflow

search_attributes: Option<HashMap<String, Payload>>

Optionally associate extra search attributes with a workflow

enable_eager_workflow_start: bool

Optionally enable Eager Workflow Start, a latency optimization using local workers NOTE: Experimental

retry_policy: Option<RetryPolicy>

Optionally set a retry policy for the workflow

start_signal: Option<WorkflowStartSignal>

If set, send a signal to the workflow atomically with start. The workflow will receive this signal before its first task.

links: Vec<Link>

Links to associate with the workflow. Ex: References to a nexus operation.

completion_callbacks: Vec<Callback>

Callbacks that will be invoked upon workflow completion. For, ex, completing nexus operations.

priority: Priority

Priority for the workflow. Defaults to all-inherited (empty).

header: Option<Header>

Headers to include with the start request.

Implementations

impl WorkflowStartOptions

pub fn new( task_queue: impl Into<String>, workflow_id: impl Into<String>, ) -> WorkflowStartOptionsBuilder

Create an instance of WorkflowStartOptions using the builder syntax

Trait Implementations

impl Clone for WorkflowStartOptions

fn clone(&self) -> WorkflowStartOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkflowStartOptions

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

Formats the value using the given formatter.