Skip to main content

Class: ScheduleState

Represents a ScheduleState.

Properties​

limitedActions​

limitedActions: boolean

If limited_actions is true, decrement remaining_actions after each action, and do not take any more scheduled actions if remaining_actions is zero. Actions may still be taken by explicit request (i.e. trigger immediately or backfill). Skipped actions (due to overlap policy) do not count against remaining actions. If a schedule has no more remaining actions, then the schedule will be subject to automatic deletion (after several days).

notes​

notes: 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

If true, do not take any actions based on the schedule spec.

remainingActions​

remainingActions: Long

ScheduleState remainingActions.

Methods​

toJSON()​

toJSON(): object

Converts this ScheduleState to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ScheduleState & $Properties

Creates a new ScheduleState instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ScheduleState & $Properties

ScheduleState instance

Call Signature​

static create(properties?): ScheduleState

Creates a new ScheduleState instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ScheduleState

ScheduleState instance

decode()​

static decode(reader, length?): ScheduleState & $Properties

Decodes a ScheduleState message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

ScheduleState & $Properties

ScheduleState

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ScheduleState & $Properties

Decodes a ScheduleState message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ScheduleState & $Properties

ScheduleState

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified ScheduleState message. Does not implicitly temporal.api.schedule.v1.ScheduleState.verify|verify messages.

Parameters​

message​

$Properties

ScheduleState message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified ScheduleState message, length delimited. Does not implicitly temporal.api.schedule.v1.ScheduleState.verify|verify messages.

Parameters​

message​

$Properties

ScheduleState message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ScheduleState

Creates a ScheduleState message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

ScheduleState

ScheduleState

toObject()​

static toObject(message, options?): object

Creates a plain object from a ScheduleState message. Also converts values to other types if specified.

Parameters​

message​

ScheduleState

ScheduleState

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object