Struct FlowConfig 

pub struct FlowConfig { /* private fields */ }

Overrides runtime behavior for one Flow.

StartFlow and SubFlow always select pull Workers, even when no override is supplied. crate::Client::update_flow_config leaves the Worker target unset, preserving the active Flow target. Other omitted fields use server defaults for StartFlow, inherit the parent configuration for SubFlow, and retain the active Flow setting for updates. Pass a value to crate::StartFlowOptions::config_override for one execution or to crate::Client::update_flow_config for an active Flow.

Implementations

impl FlowConfig

pub fn new() -> Self

Creates a config with no overrides.

pub fn active_step_search_mode(self, value: ActiveStepSearchMode) -> Self

Controls which active Step types Dex places in the search index.

pub fn attribute_store_names(self, values: Vec<String>) -> Self

Selects server-configured Attribute Stores for opted-in Attribute writes.

Omitting this builder preserves the existing Flow setting. Passing an empty vector retains protocol presence and disables later synchronization. Each enabled Attribute write is projected to every selected store; an external store failure does not roll back the Flow Attribute write.

pub fn continue_as_new_threshold(self, value: u32) -> Self

Sets the event-count threshold that triggers Continue-As-New.

pub fn continue_as_new_page_size_bytes(self, value: u32) -> Self

Sets the maximum history page size, in bytes, carried into Continue-As-New.

pub fn step_durability(self, value: StepDurability) -> Self

Sets the default persistence durability for Step handler writes.

pub fn history_window_events(self, value: u32) -> Self

Sets how many of the newest history events the run keeps, approximately.

The run uses the kept events for history reads and Time Travel. Without this builder, the run uses the server’s history.windowEvents setting, which defaults to 10000. Raise it for a run that you inspect or travel back in often. Lower it for a run that writes many events and needs less disk.

Dex prunes the oldest events in chunks, and only between commands, so a run keeps slightly more or fewer events than the value. A command that changes the Flow but records no event counts as one event. The first event of the run is always kept, so a reset to the beginning of the run always works. History reads no longer return pruned events, and Time Travel targets only commands inside the window.

Set it at start through crate::StartFlowOptions::config_override, or change it on an active Flow with crate::Client::update_flow_config. A smaller value takes effect at the run’s next pruning. A larger value keeps more of the events recorded afterwards; pruned events never come back. Once set, the value can be changed but not cleared back to the server default: an update without this builder keeps the current value. A SubFlow inherits the value from its parent unless its own crate::SubFlowOptions::config_override sets it.

The value must be positive and at most the server’s history.maxWindowEvents setting, which defaults to 100000. StartFlow and UpdateFlowConfig return crate::SdkError::Service whose crate::ServiceError::code is InvalidArgument for zero or a value above that maximum. A value above i32::MAX fails locally with crate::SdkError::InvalidArgument before any request. A Step that starts a SubFlow with an invalid override is an invalid Worker response: the Step attempt fails and Dex retries it under the Step’s retry policy. Servers older than server-zd 0.1.21 ignore the value.

client.update_flow_config(
    "order-42",
    dex_sdk::FlowConfig::new().history_window_events(50_000),
)?;

Since 1.38.0.

Trait Implementations

impl Clone for FlowConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FlowConfig

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

Formats the value using the given formatter.

impl Default for FlowConfig

fn default() -> Self

Returns the “default value” for a type.