Struct WorkflowOptions 

pub struct WorkflowOptions {

    pub workflow_id: Option<String>,
    pub dedup_id: Option<String>,
    pub dedup_policy: DeduplicationPolicy,
    pub app_version: Option<String>,
    pub queue: Option<String>,
    pub priority: i32,
    pub partition_key: Option<String>,
    pub timeout: Option<Duration>,
    pub delay: Option<Duration>,
    pub authenticated_user: Option<String>,
    pub assumed_role: Option<String>,
    pub authenticated_roles: Vec<String>,
    pub config_name: Option<String>,
    pub class_name: Option<String>,
}

Per-invocation options for starting or enqueuing a workflow — its idempotency key, queue and priority, deduplication, timeout, app version, and authenticated identity. Build with the chained setters (e.g. WorkflowOptions::with_id then queue); all fields default to unset.

Fields

workflow_id: Option<String>

Explicit idempotency key. If None, a uuid is generated.

dedup_id: Option<String>

Queue-scoped deduplication key.

dedup_policy: DeduplicationPolicy

How a deduplication-id collision is handled (queued runs only); requires dedup_id when not Reject.

app_version: Option<String>

Application version to stamp on this run, overriding the engine/client default. None uses the default (an empty default lets any executor claim the work).

queue: Option<String>

Route through this queue instead of running inline.

priority: i32

Dispatch priority within a queue; lower runs first.

partition_key: Option<String>

Partition key for a partitioned queue (see WorkflowQueue::partitioned). Each partition gets its own concurrency / rate-limit budget. Ignored by non-partitioned queues and direct runs.

timeout: Option<Duration>

Wall-clock deadline for the whole workflow.

delay: Option<Duration>

Delay before the workflow becomes eligible to run (queued workflows only): it sits in DELAYED until the dispatcher transitions it.

authenticated_user: Option<String>

User on whose behalf the workflow runs; persisted and readable from the workflow via DurableContext::authenticated_user.

assumed_role: Option<String>

Role assumed for this run.

authenticated_roles: Vec<String>

Roles available to the authenticated user.

config_name: Option<String>

Config / instance name: routes this run to the handler registered for that instance under the same workflow name (see DurableEngine::register_configured), and is recorded so recovery re-dispatches to the same instance.

class_name: Option<String>

Class / namespace name recorded on the row (cross-SDK metadata). Not used for routing on its own.

Implementations

impl WorkflowOptions

pub fn with_id(id: impl Into<String>) -> Self

Convenience: options that only pin the workflow id.

pub fn queue(self, name: impl Into<String>) -> Self

Enqueue onto the named queue instead of running in-process: the row is persisted ENQUEUED and a dispatcher on any executor claims it. Pair with start/start_with.

pub fn authenticated_user(self, user: impl Into<String>) -> Self

Set the user the workflow runs on behalf of.

pub fn assumed_role(self, role: impl Into<String>) -> Self

Set the role assumed for this run.

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

Set the partition key for a partitioned queue.

pub fn dedup_id(self, id: impl Into<String>) -> Self

Set the queue-scoped deduplication id.

pub fn dedup_policy(self, policy: DeduplicationPolicy) -> Self

Set how a deduplication-id collision is handled (see DeduplicationPolicy).

pub fn config_name(self, name: impl Into<String>) -> Self

Route this run to the handler registered for a configured instance under the same workflow name (see DurableEngine::register_configured).

pub fn class_name(self, name: impl Into<String>) -> Self

Set the class / namespace name recorded on the row (cross-SDK metadata).

pub fn app_version(self, version: impl Into<String>) -> Self

Stamp a specific application version on this run, overriding the default.

pub fn authenticated_roles<I, S>(self, roles: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Set the roles available to the authenticated user.

Trait Implementations

impl Clone for WorkflowOptions

fn clone(&self) -> WorkflowOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for WorkflowOptions

fn default() -> WorkflowOptions

Returns the “default value” for a type.