Class: PauseWorkflowExecutionRequest
workflowservice.v1.PauseWorkflowExecutionRequest
Request to pause a workflow execution.
Properties
identity
• identity: string
The identity of the client who initiated this request.
namespace
• namespace: string
Namespace of the workflow to pause.
reason
• reason: string
Reason to pause the workflow execution.
requestId
• requestId: string
A unique identifier for this pause request for idempotence. Typically UUIDv4.
runId
• runId: string
Run ID of the workflow execution to be paused. Optional. If not provided, the current run of the workflow will be paused.
workflowId
• workflowId: string
ID of the workflow execution to be paused. Required.
Methods
toJSON
▸ toJSON(): Object
Converts this PauseWorkflowExecutionRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): PauseWorkflowExecutionRequest & $Properties
Creates a new PauseWorkflowExecutionRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
PauseWorkflowExecutionRequest & $Properties
PauseWorkflowExecutionRequest instance
▸ create(properties?): PauseWorkflowExecutionRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): PauseWorkflowExecutionRequest & $Properties
Decodes a PauseWorkflowExecutionRequest 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
PauseWorkflowExecutionRequest & $Properties
PauseWorkflowExecutionRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): PauseWorkflowExecutionRequest & $Properties
Decodes a PauseWorkflowExecutionRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
PauseWorkflowExecutionRequest & $Properties
PauseWorkflowExecutionRequest
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 PauseWorkflowExecutionRequest message. Does not implicitly temporal.api.workflowservice.v1.PauseWorkflowExecutionRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | PauseWorkflowExecutionRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified PauseWorkflowExecutionRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.PauseWorkflowExecutionRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | PauseWorkflowExecutionRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): PauseWorkflowExecutionRequest
Creates a PauseWorkflowExecutionRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
PauseWorkflowExecutionRequest
toObject
▸ toObject(message, options?): Object
Creates a plain object from a PauseWorkflowExecutionRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | PauseWorkflowExecutionRequest | PauseWorkflowExecutionRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object