Class: PauseInfo
v1.PendingActivityInfo.PauseInfo
Represents a PauseInfo.
Properties
manual
• Optional manual: null | $Properties
activity was paused by the manual intervention
pauseTime
• Optional pauseTime: null | $Properties
The time when the activity was paused.
pausedBy
• Optional pausedBy: "manual" | "rule"
PauseInfo pausedBy.
rule
• Optional rule: null | $Properties
activity was paused by the rule
Methods
toJSON
▸ toJSON(): Object
Converts this PauseInfo to JSON.
Returns
Object
JSON object
create
▸ create(properties?): PauseInfo & $Shape
Creates a new PauseInfo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
PauseInfo instance
▸ create(properties?): PauseInfo
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): PauseInfo & $Shape
Decodes a PauseInfo 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
PauseInfo
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): PauseInfo & $Shape
Decodes a PauseInfo message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
PauseInfo
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 PauseInfo message. Does not implicitly temporal.api.workflow.v1.PendingActivityInfo.PauseInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | PauseInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified PauseInfo message, length delimited. Does not implicitly temporal.api.workflow.v1.PendingActivityInfo.PauseInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | PauseInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): PauseInfo
Creates a PauseInfo message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
PauseInfo
toObject
▸ toObject(message, options?): Object
Creates a plain object from a PauseInfo message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | PauseInfo | PauseInfo |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object