Skip to main content

Interface: ScheduleSummary

Defined in: node_modules/@temporalio/client/lib/schedule-types.d.ts:137

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

Defined in: node_modules/@temporalio/client/lib/schedule-types.d.ts:149

The Action that will be taken.

info​

info: object

Defined in: node_modules/@temporalio/client/lib/schedule-types.d.ts:182

nextActionTimes​

nextActionTimes: Date[]

Next upcoming scheduled times of this Schedule

recentActions​

recentActions: ScheduleExecutionResult[]

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

memo?​

optional memo?: Record<string, unknown>

Defined in: node_modules/@temporalio/client/lib/schedule-types.d.ts:154

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

scheduleId​

scheduleId: string

Defined in: node_modules/@temporalio/client/lib/schedule-types.d.ts:141

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

searchAttributes?​

optional searchAttributes?: SearchAttributes

Defined in: node_modules/@temporalio/client/lib/schedule-types.d.ts:163

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.

Deprecated​

Use typedSearchAttributes instead.

spec?​

optional spec?: ScheduleSpecDescription

Defined in: node_modules/@temporalio/client/lib/schedule-types.d.ts:145

When will Actions be taken.

state​

state: object

Defined in: node_modules/@temporalio/client/lib/schedule-types.d.ts:171

note?​

optional 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​

paused: boolean

Whether Schedule is currently paused.

typedSearchAttributes?​

optional typedSearchAttributes?: TypedSearchAttributes

Defined in: node_modules/@temporalio/client/lib/schedule-types.d.ts:170

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.