Class: ResetWorkflowExecutionRequest

workflowservice.v1.ResetWorkflowExecutionRequest

Represents a ResetWorkflowExecutionRequest.

Implements

• IResetWorkflowExecutionRequest

Constructors

constructor

• new ResetWorkflowExecutionRequest(properties?): ResetWorkflowExecutionRequest

Constructs a new ResetWorkflowExecutionRequest.

Parameters

Name	Type	Description
properties?	IResetWorkflowExecutionRequest	Properties to set

Returns

ResetWorkflowExecutionRequest

Properties

namespace

• namespace: string

ResetWorkflowExecutionRequest namespace.

Implementation of

IResetWorkflowExecutionRequest.namespace

---

reason

• reason: string

ResetWorkflowExecutionRequest reason.

Implementation of

IResetWorkflowExecutionRequest.reason

---

requestId

• requestId: string

Used to de-dupe reset requests

Implementation of

IResetWorkflowExecutionRequest.requestId

---

resetReapplyExcludeTypes

• resetReapplyExcludeTypes: ResetReapplyExcludeType[]

Event types not to be reapplied

Implementation of

IResetWorkflowExecutionRequest.resetReapplyExcludeTypes

---

resetReapplyType

• resetReapplyType: ResetReapplyType

Event types to be reapplied (deprecated) Default: RESET_REAPPLY_TYPE_SIGNAL

Implementation of

IResetWorkflowExecutionRequest.resetReapplyType

---

workflowExecution

• Optional workflowExecution: null | IWorkflowExecution

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.

Implementation of

IResetWorkflowExecutionRequest.workflowExecution

---

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.

Implementation of

IResetWorkflowExecutionRequest.workflowTaskFinishEventId

Methods

toJSON

▸ toJSON(): Object

Converts this ResetWorkflowExecutionRequest to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): ResetWorkflowExecutionRequest

Creates a new ResetWorkflowExecutionRequest instance using the specified properties.

Parameters

Name	Type	Description
properties?	IResetWorkflowExecutionRequest	Properties to set

Returns

ResetWorkflowExecutionRequest

ResetWorkflowExecutionRequest instance

---

decode

▸ decode(reader, length?): ResetWorkflowExecutionRequest

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

ResetWorkflowExecutionRequest

ResetWorkflowExecutionRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): ResetWorkflowExecutionRequest

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

ResetWorkflowExecutionRequest

ResetWorkflowExecutionRequest

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 ResetWorkflowExecutionRequest message. Does not implicitly temporal.api.workflowservice.v1.ResetWorkflowExecutionRequest.verify|verify messages.

Parameters

Name	Type	Description
message	IResetWorkflowExecutionRequest	ResetWorkflowExecutionRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IResetWorkflowExecutionRequest	ResetWorkflowExecutionRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): ResetWorkflowExecutionRequest

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

ResetWorkflowExecutionRequest

ResetWorkflowExecutionRequest

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ResetWorkflowExecutionRequest

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	ResetWorkflowExecutionRequest	ResetWorkflowExecutionRequest
options?	IConversionOptions	Conversion options

Returns

Object

Plain object