tctl workflow reset
The tctl workflow reset
command resets a Workflow Execution by either eventId
or resetType
.
Resetting a Workflow allows the process to be resumed from a certain point without losing your parameters or Event History.
To run multiple Reset operations at once, see tctl workflow reset-batch
.
tctl workflow reset <modifiers>
The following modifiers control the behavior of the command.
--workflow_id
Specify a Workflow Id.
Aliases: --wid
, -w
Example
tctl workflow reset --workflow_id <id>
--run_id
Specify a Run Id.
Aliases: --rid
, -r
Example
tctl workflow reset --run_id <id>
--event_id
Specify the eventId
of any event after WorkflowTaskStarted
to which you want to reset.
Valid values are WorkflowTaskCompleted
, WorkflowTaskFailed
, and WorkflowTaskTimeout
.
Example
tctl workflow reset --event_id <id>
--reason
Specify a reason for resetting the Workflow Execution.
Example
tctl workflow reset --reason <string>
--reset_type
Specify the event type to which you want to reset.
Value | Description |
---|---|
FirstWorkflowTask | Reset to the beginning of the Event History. |
LastWorkflowTask | Reset to the end of the Event History. |
LastContinuedAsNew | Reset to the end of the Event History for the previous Run. |
BadBinary | Reset to the point where a bad binary was used. |
Example
tctl workflow reset --reset_type <value>
--reset_reapply_type
Specify the types of events to reapply after the reset point.
Valid values are All
, Signal
, and None
. The default is All
.
Example
tctl workflow reset --reset_reapply_type <value>
--reset_bad_binary_checksum
Specify the binary checksum when using --reset_type BadBinary
.
Example
tctl workflow reset --reset_bad_binary_checksum <value>