Class: WorkflowExecutionPausedEventAttributes
history.v1.WorkflowExecutionPausedEventAttributes
Attributes for an event marking that a workflow execution was paused.
Properties
identity
• identity: string
The identity of the client who paused the workflow execution.
reason
• reason: string
The reason for pausing the workflow execution.
requestId
• requestId: string
The request ID of the request that paused the workflow execution.
Methods
toJSON
▸ toJSON(): Object
Converts this WorkflowExecutionPausedEventAttributes to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkflowExecutionPausedEventAttributes & $Properties
Creates a new WorkflowExecutionPausedEventAttributes instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
WorkflowExecutionPausedEventAttributes & $Properties
WorkflowExecutionPausedEventAttributes instance
▸ create(properties?): WorkflowExecutionPausedEventAttributes
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
WorkflowExecutionPausedEventAttributes
decode
▸ decode(reader, length?): WorkflowExecutionPausedEventAttributes & $Properties
Decodes a WorkflowExecutionPausedEventAttributes 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
WorkflowExecutionPausedEventAttributes & $Properties
WorkflowExecutionPausedEventAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkflowExecutionPausedEventAttributes & $Properties
Decodes a WorkflowExecutionPausedEventAttributes message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkflowExecutionPausedEventAttributes & $Properties
WorkflowExecutionPausedEventAttributes
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 WorkflowExecutionPausedEventAttributes message. Does not implicitly temporal.api.history.v1.WorkflowExecutionPausedEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkflowExecutionPausedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkflowExecutionPausedEventAttributes message, length delimited. Does not implicitly temporal.api.history.v1.WorkflowExecutionPausedEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkflowExecutionPausedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkflowExecutionPausedEventAttributes
Creates a WorkflowExecutionPausedEventAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkflowExecutionPausedEventAttributes
WorkflowExecutionPausedEventAttributes
toObject
▸ toObject(message, options?): Object
Creates a plain object from a WorkflowExecutionPausedEventAttributes message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkflowExecutionPausedEventAttributes | WorkflowExecutionPausedEventAttributes |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object