Struct WorkflowStepDeclaration 

pub struct WorkflowStepDeclaration {
    pub name: String,
    pub display_name: Option<String>,
    pub retry_policy: Option<WorkflowRetryPolicyDeclaration>,
    pub timeout_ms: Option<u64>,
    pub compensation: Option<WorkflowCompensationDeclaration>,
}

Fields

name: String

display_name: Option<String>

retry_policy: Option<WorkflowRetryPolicyDeclaration>

Optional durable retry schedule. max_attempts includes the original attempt, while each delay schedules the following attempt.

timeout_ms: Option<u64>

Optional durable timeout applied independently to every attempt.

compensation: Option<WorkflowCompensationDeclaration>

Optional compensation for the completed business effect produced by this step. The explicit order is evaluated across all completed effects when compensation is selected; it is independent from completion time.

Implementations

impl WorkflowStepDeclaration

pub fn new(name: impl Into<String>) -> Self

pub fn with_display_name(self, display_name: impl Into<String>) -> Self

pub fn with_retry_policy( self, retry_policy: WorkflowRetryPolicyDeclaration, ) -> Self

pub const fn with_timeout_ms(self, timeout_ms: u64) -> Self

pub fn with_compensation( self, compensation: WorkflowCompensationDeclaration, ) -> Self

Trait Implementations

impl Clone for WorkflowStepDeclaration

fn clone(&self) -> WorkflowStepDeclaration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for WorkflowStepDeclaration

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for WorkflowStepDeclaration

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WorkflowStepDeclaration

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for WorkflowStepDeclaration

impl JsonSchema for WorkflowStepDeclaration

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for WorkflowStepDeclaration

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for WorkflowStepDeclaration

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 WorkflowStepDeclaration

impl ToSchema for WorkflowStepDeclaration

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.