nestjs-temporal-core
    Preparing search index...

    Interface StandaloneActivityOptionsExperimental

    Options used by ActivityClient.start.

    Standalone Activities are experimental. APIs may be subject to change.

    interface StandaloneActivityOptions {
        args?: any[] | readonly any[];
        heartbeatTimeout?: Duration;
        id: string;
        idConflictPolicy?: ActivityIdConflictPolicy;
        idReusePolicy?: ActivityIdReusePolicy;
        priority?: Priority;
        retry?: RetryPolicy;
        scheduleToCloseTimeout?: Duration;
        scheduleToStartTimeout?: Duration;
        startDelay?: Duration;
        startToCloseTimeout?: Duration;
        summary?: string;
        taskQueue: string;
        typedSearchAttributes?: TypedSearchAttributes | SearchAttributePair[];
    }
    Index
    args? heartbeatTimeout? id idConflictPolicy? idReusePolicy? priority? retry? scheduleToCloseTimeout? scheduleToStartTimeout? startDelay? startToCloseTimeout? summary? taskQueue typedSearchAttributes?
    args?: any[] | readonly any[]

    Input arguments to pass to the activity.

    heartbeatTimeout?: Duration

    If set, specifies maximum time between successful heartbeats.

    id: string

    Activity ID of the started activity. It's recommended to use a meaningful business ID.

    idConflictPolicy?: ActivityIdConflictPolicy

    Specifies behavior if there's a running activity with the same ID. Note that there can only be one running Activity for each Activity ID.

    idReusePolicy?: ActivityIdReusePolicy

    Specifies behavior if there's a closed activity with the same ID.

    priority?: Priority

    Priority to use when starting this activity.

    retry?: RetryPolicy

    Controls how Activity is retried. If not set, the server will assign default retry policy.

    scheduleToCloseTimeout?: Duration

    If set, specifies maximum time for a single execution attempt. This timeout is retryable.

    Note: it is required to set at least one of startToCloseTimeout and scheduleToCloseTimeout.

    scheduleToStartTimeout?: Duration

    If set, specifies maximum time the activity can wait in the task queue before being picked up by a worker. This timeout is non-retryable.

    startDelay?: Duration

    Time to wait before dispatching the first activity task. This delay is not applied to retry attempts.

    startToCloseTimeout?: Duration

    Is set, specifies total time the activity is allowed to run, including retries.

    Note: it is required to set at least one of startToCloseTimeout and scheduleToCloseTimeout.

    summary?: string

    A single-line fixed summary for this activity execution that may appear in UI/CLI. This can be in single-line Temporal markdown format.

    taskQueue: string

    Task queue to run this activity on.

    typedSearchAttributes?: TypedSearchAttributes | SearchAttributePair[]

    Search attributes for the activity.

    Settings
    Member Visibility

    On This Page
    Properties