Skip to main content

Interface: IResetOptions

common.v1.IResetOptions

Properties of a ResetOptions.

Hierarchy​

Properties​

buildId​

• Optional buildId: null | string

Resets to the first workflow task processed by this build id. If the workflow was not processed by the build id, or the workflow task can't be determined, no reset will be performed. Note that by default, this reset is allowed to be to a prior run in a chain of continue-as-new.

Inherited from​

$Properties.buildId

currentRunOnly​

• Optional currentRunOnly: null | boolean

If true, limit the reset to only within the current run. (Applies to build_id targets and possibly others in the future.)

Inherited from​

$Properties.currentRunOnly

firstWorkflowTask​

• Optional firstWorkflowTask: null | $Properties

Resets to the first workflow task completed or started event.

Inherited from​

$Properties.firstWorkflowTask

lastWorkflowTask​

• Optional lastWorkflowTask: null | $Properties

Resets to the last workflow task completed or started event.

Inherited from​

$Properties.lastWorkflowTask

resetReapplyExcludeTypes​

• Optional resetReapplyExcludeTypes: null | ResetReapplyExcludeType[]

Event types not to be reapplied

Inherited from​

$Properties.resetReapplyExcludeTypes

resetReapplyType​

• Optional resetReapplyType: null | ResetReapplyType

Deprecated. Use options. Default: RESET_REAPPLY_TYPE_SIGNAL

Inherited from​

$Properties.resetReapplyType

target​

• Optional target: "firstWorkflowTask" | "lastWorkflowTask" | "workflowTaskId" | "buildId"

Which workflow task to reset to.

Inherited from​

$Properties.target

workflowTaskId​

• Optional workflowTaskId: null | Long

The id of a specific WORKFLOW_TASK_COMPLETED,WORKFLOW_TASK_TIMED_OUT, WORKFLOW_TASK_FAILED, or WORKFLOW_TASK_STARTED event to reset to. Note that this option doesn't make sense when used as part of a batch request.

Inherited from​

$Properties.workflowTaskId