Class: ScheduleState
Represents a ScheduleState.
Implements
Constructors
constructor
• new ScheduleState(properties?): ScheduleState
Constructs a new ScheduleState.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IScheduleState | Properties to set |
Returns
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
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
paused
• paused: boolean
If true, do not take any actions based on the schedule spec.
Implementation of
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
| Name | Type | Description |
|---|---|---|
properties? | IScheduleState | Properties to set |
Returns
ScheduleState instance
decode
▸ decode(reader, length?): ScheduleState
Decodes a ScheduleState message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
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
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
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
| Name | Type | Description |
|---|---|---|
message | IScheduleState | ScheduleState message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
message | IScheduleState | ScheduleState message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ScheduleState
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for ScheduleState
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your 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
| Name | Type | Description |
|---|---|---|
message | ScheduleState | ScheduleState |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object