Skip to main content

Interface: IScheduleInfo

Properties of a ScheduleInfo.

Extends​

Properties​

actionCount?​

optional actionCount?: Long | null

Number of actions taken so far.

Inherited from​

$Properties.actionCount

bufferDropped?​

optional bufferDropped?: Long | null

Number of dropped actions due to buffer limit.

Inherited from​

$Properties.bufferDropped

bufferSize?​

optional bufferSize?: Long | null

Number of actions in the buffer. The buffer holds the actions that cannot be immediately triggered (due to the overlap policy). These actions can be a result of the normal schedule or a backfill.

Inherited from​

$Properties.bufferSize

createTime?​

optional createTime?: $Properties | null

Timestamps of schedule creation and last update.

Inherited from​

$Properties.createTime

futureActionTimes?​

optional futureActionTimes?: $Properties[] | null

Next ten scheduled action times.

Inherited from​

$Properties.futureActionTimes

invalidScheduleError?​

optional invalidScheduleError?: string | null

Deprecated.

Inherited from​

$Properties.invalidScheduleError

missedCatchupWindow?​

optional missedCatchupWindow?: Long | null

Number of times a scheduled action was skipped due to missing the catchup window.

Inherited from​

$Properties.missedCatchupWindow

overlapSkipped?​

optional overlapSkipped?: Long | null

Number of skipped actions due to overlap.

Inherited from​

$Properties.overlapSkipped

recentActions?​

optional recentActions?: $Properties[] | null

Most recent ten actual action times (including manual triggers).

Inherited from​

$Properties.recentActions

runningWorkflows?​

optional runningWorkflows?: $Properties[] | null

Currently-running workflows started by this schedule. (There might be more than one if the overlap policy allows overlaps.) Note that the run_ids in here are the original execution run ids as started by the schedule. If the workflows retried, did continue-as-new, or were reset, they might still be running but with a different run_id.

Inherited from​

$Properties.runningWorkflows

stateSizeBytes?​

optional stateSizeBytes?: Long | null

Size of the schedule's internal state (including payloads) in bytes.

Inherited from​

$Properties.stateSizeBytes

timeSkippingInfo?​

optional timeSkippingInfo?: $Properties | null

Information about time skipping for this schedule. If the schedule has never enabled time skipping, this will be unset.

Inherited from​

$Properties.timeSkippingInfo

updateTime?​

optional updateTime?: $Properties | null

ScheduleInfo updateTime

Inherited from​

$Properties.updateTime