Interface: ScheduleSummary

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

Properties

action

• Optional action: ScheduleSummaryStartWorkflowAction

The Action that will be taken.

---

info

• info: Object

Type declaration

Name	Type	Description
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

• 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

Name	Type	Description
note?	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.