Class: ScheduleInfo
Represents a ScheduleInfo.
Properties
actionCount
• actionCount: Long
Number of actions taken so far.
bufferDropped
• bufferDropped: Long
Number of dropped actions due to buffer limit.
bufferSize
• bufferSize: Long
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.
createTime
• Optional createTime: null | $Properties
Timestamps of schedule creation and last update.
futureActionTimes
• futureActionTimes: $Properties[]
Next ten scheduled action times.
invalidScheduleError
• invalidScheduleError: string
Deprecated.
missedCatchupWindow
• missedCatchupWindow: Long
Number of times a scheduled action was skipped due to missing the catchup window.
overlapSkipped
• overlapSkipped: Long
Number of skipped actions due to overlap.
recentActions
• recentActions: $Properties[]
Most recent ten actual action times (including manual triggers).
runningWorkflows
• runningWorkflows: $Properties[]
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.
stateSizeBytes
• stateSizeBytes: Long
Size of the schedule's internal state (including payloads) in bytes.
updateTime
• Optional updateTime: null | $Properties
ScheduleInfo updateTime.
Methods
toJSON
▸ toJSON(): Object
Converts this ScheduleInfo to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ScheduleInfo & $Properties
Creates a new ScheduleInfo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
ScheduleInfo instance
▸ create(properties?): ScheduleInfo
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): ScheduleInfo & $Properties
Decodes a ScheduleInfo 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
ScheduleInfo
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ScheduleInfo & $Properties
Decodes a ScheduleInfo message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ScheduleInfo
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 ScheduleInfo message. Does not implicitly temporal.api.schedule.v1.ScheduleInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ScheduleInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ScheduleInfo message, length delimited. Does not implicitly temporal.api.schedule.v1.ScheduleInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ScheduleInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ScheduleInfo
Creates a ScheduleInfo message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ScheduleInfo
toObject
▸ toObject(message, options?): Object
Creates a plain object from a ScheduleInfo message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ScheduleInfo | ScheduleInfo |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object