Struct StartOptions 

pub struct StartOptions {
    pub namespace: Option<String>,
    pub idempotency_key: Option<String>,
    pub routing_key: Option<String>,
    pub task_queue: Option<String>,
    pub display_name: Option<String>,
}

Options accepted by Client::start.

Fields

namespace: Option<String>

Namespace override for this start request.

idempotency_key: Option<String>

Caller-supplied idempotency key for safe local retry replay.

The current AW protobuf has not added an idempotency field yet, so this is enforced at the SDK boundary without inventing a client-owned wire field. Reusing a key for a different start request returns ClientError::AlreadyExists.

routing_key: Option<String>

R-4 steered-start routing key. When set, the cluster steers this start to shard_for(routing_key)’s owner (forwarding there when the dialed node is not the owner). None keeps the default unsteered placement.

task_queue: Option<String>

Optional default task queue for this workflow’s activities. When set, the server records it durably on the start (the namespace × task_queue targeting story); None keeps the namespace’s default queue.

display_name: Option<String>

Optional operator-facing display name for the workflow this start creates (#211). When set, the server records it durably on the start as the aion.display_name search attribute; None starts it unnamed (it shows its bare UUID).

A LABEL over the UUID identity, never an address: no SDK call resolves a workflow by name. It is deliberately NOT part of the idempotency fingerprint — see StartOutcome::display_name_not_applied for what happens when a reused key carries a different name.

You name the run you are starting, but the label READS BACK per workflow: the recorded attribute carries no run id, so every reader folds it over the whole history, last write wins. A continue-as-new successor of this run inherits the name, and describing any run of the workflow returns whatever name was recorded most recently.

Trait Implementations

impl Clone for StartOptions

fn clone(&self) -> StartOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StartOptions

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

Formats the value using the given formatter.

impl Default for StartOptions

fn default() -> StartOptions

Returns the “default value” for a type.

impl Eq for StartOptions

impl PartialEq for StartOptions

fn eq(&self, other: &StartOptions) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for StartOptions