Skip to main content

Interface: ScheduleSummary

client.ScheduleSummary

A summary description of an existing Schedule, as returned by 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.

Properties

action

Optional action: ScheduleSummaryStartWorkflowAction

The Action that will be taken.


info

info: Object

Type declaration

NameTypeDescription
nextActionTimesDate[]Scheduled time of the next 10 executions of this Schedule
recentActionsScheduleExecutionResult[]Most recent 10 Actions started (including manual triggers), sorted from older start time to newer.

memo

Optional memo: Record<string, unknown>

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


scheduleId

scheduleId: string

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


searchAttributes

Optional 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.


spec

Optional spec: ScheduleSpecDescription

When will Actions be taken.


state

state: Object

Type declaration

NameTypeDescription
note?stringInformative 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.
pausedbooleanWhether Schedule is currently paused.