Class: ResetWorkflowExecutionRequest
workflowservice.v1.ResetWorkflowExecutionRequest
Represents a ResetWorkflowExecutionRequest.
Properties
identity
• identity: string
The identity of the worker/client
namespace
• namespace: string
ResetWorkflowExecutionRequest namespace.
postResetOperations
• postResetOperations: $Properties[]
Operations to perform after the workflow has been reset. These operations will be applied to the new run of the workflow execution in the order they are provided. All operations are applied to the workflow before the first new workflow task is generated
reason
• reason: string
ResetWorkflowExecutionRequest reason.
requestId
• requestId: string
Used to de-dupe reset requests
resetReapplyExcludeTypes
• resetReapplyExcludeTypes: ResetReapplyExcludeType[]
Event types not to be reapplied
resetReapplyType
• resetReapplyType: ResetReapplyType
Deprecated. Use options.
Default: RESET_REAPPLY_TYPE_SIGNAL
workflowExecution
• Optional workflowExecution: null | $Properties
The workflow to reset. If this contains a run ID then the workflow will be reset back to the provided event ID in that run. Otherwise it will be reset to the provided event ID in the current run. In all cases the current run will be terminated and a new run started.
workflowTaskFinishEventId
• workflowTaskFinishEventId: Long
The id of a WORKFLOW_TASK_COMPLETED,WORKFLOW_TASK_TIMED_OUT, WORKFLOW_TASK_FAILED, or
WORKFLOW_TASK_STARTED event to reset to.
Methods
toJSON
▸ toJSON(): Object
Converts this ResetWorkflowExecutionRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ResetWorkflowExecutionRequest & $Shape
Creates a new ResetWorkflowExecutionRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
ResetWorkflowExecutionRequest & $Shape
ResetWorkflowExecutionRequest instance
▸ create(properties?): ResetWorkflowExecutionRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): ResetWorkflowExecutionRequest & $Shape
Decodes a ResetWorkflowExecutionRequest 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
ResetWorkflowExecutionRequest & $Shape
ResetWorkflowExecutionRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ResetWorkflowExecutionRequest & $Shape
Decodes a ResetWorkflowExecutionRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ResetWorkflowExecutionRequest & $Shape
ResetWorkflowExecutionRequest
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 ResetWorkflowExecutionRequest message. Does not implicitly temporal.api.workflowservice.v1.ResetWorkflowExecutionRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ResetWorkflowExecutionRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ResetWorkflowExecutionRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.ResetWorkflowExecutionRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ResetWorkflowExecutionRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ResetWorkflowExecutionRequest
Creates a ResetWorkflowExecutionRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ResetWorkflowExecutionRequest
toObject
▸ toObject(message, options?): Object
Creates a plain object from a ResetWorkflowExecutionRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ResetWorkflowExecutionRequest | ResetWorkflowExecutionRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object