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

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

Call Signature

static create(properties?): ResetWorkflowExecutionRequest & $Shape

Creates a new ResetWorkflowExecutionRequest instance using the specified properties.

Parameters

properties?

$Shape

Properties to set

Returns

ResetWorkflowExecutionRequest & $Shape

ResetWorkflowExecutionRequest instance

Call Signature

static create(properties?): ResetWorkflowExecutionRequest

Creates a new ResetWorkflowExecutionRequest instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

ResetWorkflowExecutionRequest

ResetWorkflowExecutionRequest instance

---

decode()

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

Decodes a ResetWorkflowExecutionRequest 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

ResetWorkflowExecutionRequest & $Shape

ResetWorkflowExecutionRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): ResetWorkflowExecutionRequest & $Shape

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

Parameters

reader

Uint8Array<ArrayBufferLike> | 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()

static encode(message, writer?): Writer

Encodes the specified ResetWorkflowExecutionRequest message. Does not implicitly temporal.api.workflowservice.v1.ResetWorkflowExecutionRequest.verify|verify messages.

Parameters

message

$Properties

ResetWorkflowExecutionRequest message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

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

Parameters

message

$Properties

ResetWorkflowExecutionRequest message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): ResetWorkflowExecutionRequest

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

Parameters

object

Plain object

Returns

ResetWorkflowExecutionRequest

ResetWorkflowExecutionRequest

---

toObject()

static toObject(message, options?): object

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

Parameters

message

ResetWorkflowExecutionRequest

ResetWorkflowExecutionRequest

options?

IConversionOptions

Conversion options

Returns

object

Plain object