nestjs-temporal-core
    Preparing search index...

    Interface ScheduleSummary

    A summary description of an existing Schedule, as returned by ScheduleClient.list.

    Note that schedule listing is eventual consistent; some returned properties may therefore be undefined or incorrect for some time after creating or modifying a schedule.

    interface ScheduleSummary {
        action?: ScheduleSummaryStartWorkflowAction;
        info: { nextActionTimes: Date[]; recentActions: ScheduleExecutionResult[] };
        memo?: Record<string, unknown>;
        scheduleId: string;
        searchAttributes?: SearchAttributes;
        spec?: ScheduleSpecDescription;
        state: { note?: string; paused: boolean };
        typedSearchAttributes?: TypedSearchAttributes;
    }
    Index
    action? info memo? scheduleId searchAttributes? spec? state typedSearchAttributes?
    action?: ScheduleSummaryStartWorkflowAction

    The Action that will be taken.

    info: { nextActionTimes: Date[]; recentActions: ScheduleExecutionResult[] }

    Type Declaration

    • nextActionTimes: Date[]

      Next upcoming scheduled times of this Schedule

    • recentActions: ScheduleExecutionResult[]

      Most recent actions started (including manual triggers), sorted from older start time to newer.

    memo?: Record<string, unknown>

    Additional non-indexed information attached to the Schedule. The values can be anything that is serializable by the DataConverter.

    scheduleId: string

    The Schedule Id. We recommend using a meaningful business identifier.

    searchAttributes?: SearchAttributes

    Additional indexed information attached to the Schedule. More info: https://docs.temporal.io/docs/typescript/search-attributes

    Values are always converted using JsonPayloadConverter, even when a custom Data Converter is provided.

    Use typedSearchAttributes instead.

    spec?: ScheduleSpecDescription

    When will Actions be taken.

    state: { note?: string; paused: boolean }

    Type Declaration

    • Optionalnote?: string

      Informative human-readable message with contextual notes, e.g. the reason a Schedule is paused. The system may overwrite this message on certain conditions, e.g. when pause-on-failure happens.

    • paused: boolean

      Whether Schedule is currently paused.

    typedSearchAttributes?: TypedSearchAttributes

    Additional indexed information attached to the Schedule. More info: https://docs.temporal.io/docs/typescript/search-attributes

    Values are always converted using JsonPayloadConverter, even when a custom Data Converter is provided.

    Settings
    Member Visibility

    On This Page
    Properties