Struct StartWorkflowRequest 

pub struct StartWorkflowRequest {
    pub namespace: String,
    pub workflow_type: String,
    pub input: Option<Payload>,
    pub routing_key: Option<String>,
    pub task_queue: Option<String>,
    pub display_name: Option<String>,
}

Fields

namespace: String

workflow_type: String

input: Option<Payload>

routing_key: Option<String>

R-4 steered start: caller-chosen routing key. When set, the start is steered to shard_for(routing_key)’s owner (forwarded there if this node is not the owner). Empty/absent keeps the unsteered (R-1 remint) behaviour.

task_queue: Option<String>

Optional task queue this workflow defaults its activities to (the namespace x task_queue targeting story). When set, it is recorded durably on the start so it survives replay/failover. Empty/absent keeps the namespace’s default queue.

display_name: Option<String>

Optional operator-facing display name for the run (#211). A LABEL over the UUID identity, never an address: nothing resolves a workflow by name. When set, it is recorded durably (as the aion.display_name search attribute) in the same atomic append as the start. ABSENT (this optional field unset) starts the run unnamed; a PRESENT but blank (empty or whitespace-only) value is REFUSED with invalid_input rather than reinterpreted as unnamed, so leave the field unset to mean “no name” — do not send “”. This differs from routing_key and task_queue above, where empty does mean “not selected”.

Implementations

impl StartWorkflowRequest

pub fn routing_key(&self) -> &str

Returns the value of routing_key, or the default value if routing_key is unset.

pub fn task_queue(&self) -> &str

Returns the value of task_queue, or the default value if task_queue is unset.

pub fn display_name(&self) -> &str

Returns the value of display_name, or the default value if display_name is unset.

Trait Implementations

impl Clone for StartWorkflowRequest

fn clone(&self) -> StartWorkflowRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StartWorkflowRequest

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

Formats the value using the given formatter.

impl Default for StartWorkflowRequest

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StartWorkflowRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for StartWorkflowRequest

impl Hash for StartWorkflowRequest

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for StartWorkflowRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for StartWorkflowRequest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for StartWorkflowRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StartWorkflowRequest