Skip to main content

Class: ScheduleState

schedule.v1.ScheduleState

Represents a ScheduleState.

Implements​

Constructors​

constructor​

β€’ new ScheduleState(properties?): ScheduleState

Constructs a new ScheduleState.

Parameters​

NameTypeDescription
properties?IScheduleStateProperties to set

Returns​

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

Implementation of​

IScheduleState.limitedActions


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.

Implementation of​

IScheduleState.notes


paused​

β€’ paused: boolean

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

Implementation of​

IScheduleState.paused


remainingActions​

β€’ remainingActions: Long

ScheduleState remainingActions.

Implementation of​

IScheduleState.remainingActions

Methods​

toJSON​

β–Έ toJSON(): Object

Converts this ScheduleState to JSON.

Returns​

Object

JSON object


create​

β–Έ create(properties?): ScheduleState

Creates a new ScheduleState instance using the specified properties.

Parameters​

NameTypeDescription
properties?IScheduleStateProperties to set

Returns​

ScheduleState

ScheduleState instance


decode​

β–Έ decode(reader, length?): ScheduleState

Decodes a ScheduleState message from the specified reader or buffer.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns​

ScheduleState

ScheduleState

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

β–Έ decodeDelimited(reader): ScheduleState

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

ScheduleState

ScheduleState

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


encode​

β–Έ encode(message, writer?): Writer

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

Parameters​

NameTypeDescription
messageIScheduleStateScheduleState message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

β–Έ encodeDelimited(message, writer?): Writer

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

Parameters​

NameTypeDescription
messageIScheduleStateScheduleState message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

β–Έ fromObject(object): ScheduleState

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

ScheduleState

ScheduleState


getTypeUrl​

β–Έ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ScheduleState

Parameters​

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns​

string

The default type url


toObject​

β–Έ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageScheduleStateScheduleState
options?IConversionOptionsConversion options

Returns​

Object

Plain object