Skip to main content

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?: string | null

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?: $Properties | null

Resets to the first workflow task completed or started event.

lastWorkflowTask?​

optional lastWorkflowTask?: $Properties | null

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?: Long | null

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()​

Call Signature​

static create(properties?): ResetOptions & $Shape

Creates a new ResetOptions instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

ResetOptions & $Shape

ResetOptions instance

Call Signature​

static create(properties?): ResetOptions

Creates a new ResetOptions instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ResetOptions

ResetOptions instance

decode()​

static decode(reader, length?): ResetOptions & $Shape

Decodes a ResetOptions message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

ResetOptions & $Shape

ResetOptions

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ResetOptions & $Shape

Decodes a ResetOptions message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ResetOptions & $Shape

ResetOptions

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified ResetOptions message. Does not implicitly temporal.api.common.v1.ResetOptions.verify|verify messages.

Parameters​

message​

$Properties

ResetOptions message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified ResetOptions message, length delimited. Does not implicitly temporal.api.common.v1.ResetOptions.verify|verify messages.

Parameters​

message​

$Properties

ResetOptions message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ResetOptions

Creates a ResetOptions message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

ResetOptions

ResetOptions

toObject()​

static toObject(message, options?): object

Creates a plain object from a ResetOptions message. Also converts values to other types if specified.

Parameters​

message​

ResetOptions

ResetOptions

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object