Class: ResetOptions
Describes where and how to reset a workflow, used for batch reset currently and may be used for single-workflow reset later.
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.
currentRunOnly
• currentRunOnly: boolean
If true, limit the reset to only within the current run. (Applies to build_id targets and possibly others in the future.)
firstWorkflowTask
• Optional firstWorkflowTask: null | $Properties
Resets to the first workflow task completed or started event.
lastWorkflowTask
• Optional lastWorkflowTask: null | $Properties
Resets to the last workflow task completed or started event.
resetReapplyExcludeTypes
• resetReapplyExcludeTypes: ResetReapplyExcludeType[]
Event types not to be reapplied
resetReapplyType
• resetReapplyType: ResetReapplyType
Deprecated. Use options.
Default: RESET_REAPPLY_TYPE_SIGNAL
target
• Optional target: "firstWorkflowTask" | "lastWorkflowTask" | "workflowTaskId" | "buildId"
Which workflow task to reset to.
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.
Methods
toJSON
▸ toJSON(): Object
Converts this ResetOptions to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ResetOptions & $Shape
Creates a new ResetOptions instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
ResetOptions instance
▸ create(properties?): ResetOptions
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): ResetOptions & $Shape
Decodes a ResetOptions 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
ResetOptions
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ResetOptions & $Shape
Decodes a ResetOptions message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ResetOptions
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 ResetOptions message. Does not implicitly temporal.api.common.v1.ResetOptions.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ResetOptions message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ResetOptions message, length delimited. Does not implicitly temporal.api.common.v1.ResetOptions.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ResetOptions message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ResetOptions
Creates a ResetOptions message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ResetOptions
toObject
▸ toObject(message, options?): Object
Creates a plain object from a ResetOptions message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ResetOptions | ResetOptions |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object