Class: ScheduleListInfo
ScheduleListInfo is an abbreviated set of values from Schedule and ScheduleInfo that's returned in ListSchedules.
Properties
futureActionTimes
• futureActionTimes: $Properties[]
ScheduleListInfo futureActionTimes.
notes
• notes: string
From state:
paused
• paused: boolean
ScheduleListInfo paused.
recentActions
• recentActions: $Properties[]
From info (maybe fewer entries):
spec
• Optional spec: null | $Properties
From spec: Some fields are dropped from this copy of spec: timezone_data
stateSizeBytes
• stateSizeBytes: Long
Size of the schedule's internal state (including payloads) in bytes.
workflowType
• Optional workflowType: null | $Properties
From action: Action is a oneof field, but we need to encode this in JSON and oneof fields don't work well with JSON. If action is start_workflow, this is set:
Methods
toJSON
▸ toJSON(): Object
Converts this ScheduleListInfo to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ScheduleListInfo & $Properties
Creates a new ScheduleListInfo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
ScheduleListInfo & $Properties
ScheduleListInfo instance
▸ create(properties?): ScheduleListInfo
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): ScheduleListInfo & $Properties
Decodes a ScheduleListInfo 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
ScheduleListInfo & $Properties
ScheduleListInfo
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ScheduleListInfo & $Properties
Decodes a ScheduleListInfo message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ScheduleListInfo & $Properties
ScheduleListInfo
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 ScheduleListInfo message. Does not implicitly temporal.api.schedule.v1.ScheduleListInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ScheduleListInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ScheduleListInfo message, length delimited. Does not implicitly temporal.api.schedule.v1.ScheduleListInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ScheduleListInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ScheduleListInfo
Creates a ScheduleListInfo message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ScheduleListInfo
toObject
▸ toObject(message, options?): Object
Creates a plain object from a ScheduleListInfo message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ScheduleListInfo | ScheduleListInfo |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object