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