Struct LocalActivityOptions 

#[non_exhaustive]
pub struct LocalActivityOptions {
    pub activity_id: Option<String>,
    pub retry_policy: RetryPolicy,
    pub attempt: Option<u32>,
    pub original_schedule_time: Option<Timestamp>,
    pub timer_backoff_threshold: Option<Duration>,
    pub cancel_type: ActivityCancellationType,
    pub cancellation_token: Option<WorkflowCancellationToken>,
    pub schedule_to_close_timeout: Option<Duration>,
    pub schedule_to_start_timeout: Option<Duration>,
    pub start_to_close_timeout: Option<Duration>,
    pub summary: Option<String>,
    /* private fields */
}

Options for scheduling a local activity

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

activity_id: Option<String>

Identifier to use for tracking the activity in Workflow history. The activityId can be accessed by the activity function. Does not need to be unique.

If None use the context’s sequence number

retry_policy: RetryPolicy

Retry policy

attempt: Option<u32>

Override attempt number rather than using 1. Ideally we would not expose this in a released Rust SDK, but it’s needed for test.

original_schedule_time: Option<Timestamp>

Override schedule time when doing timer backoff. Ideally we would not expose this in a released Rust SDK, but it’s needed for test.

timer_backoff_threshold: Option<Duration>

Retry backoffs over this amount will use a timer rather than a local retry

cancel_type: ActivityCancellationType

How the activity will cancel

cancellation_token: Option<WorkflowCancellationToken>

Cancellation token for this local activity. None inherits workflow cancellation.

schedule_to_close_timeout: Option<Duration>

Indicates how long the caller is willing to wait for local activity completion. Limits how long retries will be attempted. When not specified defaults to the workflow execution timeout (which may be unset).

schedule_to_start_timeout: Option<Duration>

Limits time the local activity can idle internally before being executed. That can happen if the worker is currently at max concurrent local activity executions. This timeout is always non retryable as all a retry would achieve is to put it back into the same queue. Defaults to schedule_to_close_timeout if not specified and that is set. Must be <= schedule_to_close_timeout when set, if not, it will be clamped down.

start_to_close_timeout: Option<Duration>

Maximum time the local activity is allowed to execute after the task is dispatched. This timeout is always retryable. Either or both of schedule_to_close_timeout and this must be specified. If set, this must be <= schedule_to_close_timeout, if not, it will be clamped down.

summary: Option<String>

Single-line summary for this activity that will appear in UI/CLI.

Implementations

impl LocalActivityOptions

pub fn builder() -> LocalActivityOptionsBuilder

Create an instance of LocalActivityOptions using the builder syntax

Trait Implementations

impl Clone for LocalActivityOptions

fn clone(&self) -> LocalActivityOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LocalActivityOptions

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

Formats the value using the given formatter.

impl Default for LocalActivityOptions

fn default() -> LocalActivityOptions

Returns the “default value” for a type.