Dex TypeScript SDK 1.35.0
    Preparing search index...

    Interface StepOptions

    Configures timeouts, retries, durability, locks, and failure routing for a Step.

    interface StepOptions {
        executeDurability?: StepDurability;
        executeFailure?: ExecuteFailure;
        executeLoadAttributeMapInstances?: readonly AttributeMapLoad[];
        executeLoadAttributeMaps?: readonly AttributeMap<unknown>[];
        executeLoadChannelMapInstances?: readonly ChannelMapLoad[];
        executeLoadChannelMaps?: readonly ChannelMap<unknown>[];
        executeLoadChannels?: readonly Channel<unknown>[];
        executeLockAttributes?: readonly AttributeLock[];
        executeMethodTimeoutMs?: number;
        executeRetry?: RetryPolicy;
        heartbeatTimeoutMs?: number;
        waitForDurability?: StepDurability;
        waitForFailure?: WaitForFailurePolicy;
        waitForLoadAttributeMapInstances?: readonly AttributeMapLoad[];
        waitForLoadAttributeMaps?: readonly AttributeMap<unknown>[];
        waitForLoadChannelMapInstances?: readonly ChannelMapLoad[];
        waitForLoadChannelMaps?: readonly ChannelMap<unknown>[];
        waitForLoadChannels?: readonly Channel<unknown>[];
        waitForLockAttributes?: readonly AttributeLock[];
        waitForMethodTimeoutMs?: number;
        waitForRetry?: RetryPolicy;
    }
    Index

    Properties

    executeDurability? executeFailure? executeLoadAttributeMapInstances? executeLoadAttributeMaps? executeLoadChannelMapInstances? executeLoadChannelMaps? executeLoadChannels? executeLockAttributes? executeMethodTimeoutMs? executeRetry? heartbeatTimeoutMs? waitForDurability? waitForFailure? waitForLoadAttributeMapInstances? waitForLoadAttributeMaps? waitForLoadChannelMapInstances? waitForLoadChannelMaps? waitForLoadChannels? waitForLockAttributes? waitForMethodTimeoutMs? waitForRetry?

    Properties

    executeDurability?: StepDurability

    Execute durability override; otherwise uses Flow configuration, then sync.

    executeFailure?: ExecuteFailure

    Fallback routing after exhausted execute retries.

    executeLoadAttributeMapInstances?: readonly AttributeMapLoad[]

    Exact AttributeMap instances loaded for execute.

    executeLoadAttributeMaps?: readonly AttributeMap<unknown>[]

    AttributeMap definitions whose complete contents are loaded for execute.

    executeLoadChannelMapInstances?: readonly ChannelMapLoad[]

    Exact ChannelMap instances whose pending messages are loaded for execute.

    executeLoadChannelMaps?: readonly ChannelMap<unknown>[]

    ChannelMap definitions whose complete pending contents are loaded for execute.

    executeLoadChannels?: readonly Channel<unknown>[]

    Channels whose pending messages are loaded for execute.

    executeLockAttributes?: readonly AttributeLock[]

    Attribute locks held during execute.

    executeMethodTimeoutMs?: number

    Regular execute attempt limit in milliseconds; defaults to two hours.

    executeRetry?: RetryPolicy

    Optional retry policy for execute.

    heartbeatTimeoutMs?: number

    Regular heartbeat timeout in milliseconds; requires whole seconds and defaults to one minute.

    waitForDurability?: StepDurability

    WaitFor durability override; otherwise uses Flow configuration, then sync.

    waitForFailure?: WaitForFailurePolicy

    Behavior after all waitFor attempts fail.

    waitForLoadAttributeMapInstances?: readonly AttributeMapLoad[]

    Exact AttributeMap instances loaded for waitFor.

    waitForLoadAttributeMaps?: readonly AttributeMap<unknown>[]

    AttributeMap definitions whose complete contents are loaded for waitFor.

    waitForLoadChannelMapInstances?: readonly ChannelMapLoad[]

    Exact ChannelMap instances whose pending messages are loaded for waitFor.

    waitForLoadChannelMaps?: readonly ChannelMap<unknown>[]

    ChannelMap definitions whose complete pending contents are loaded for waitFor.

    waitForLoadChannels?: readonly Channel<unknown>[]

    Channels whose pending messages are loaded for waitFor.

    waitForLockAttributes?: readonly AttributeLock[]

    Attribute locks held during waitFor.

    waitForMethodTimeoutMs?: number

    Regular waitFor attempt limit in milliseconds; defaults to two hours.

    waitForRetry?: RetryPolicy

    Optional retry policy for waitFor.

    Settings

    Member Visibility

    On This Page

    Properties