Skip to main content

Class: BatchOperationReset

BatchOperationReset sends reset requests to batch workflows. Keep the parameter in sync with temporal.api.workflowservice.v1.ResetWorkflowExecutionRequest.

Properties​

identity​

identity: string

The identity of the worker/client.

options?​

optional options?: $Properties | null

Describes what to reset to and how. If set, reset_type and reset_reapply_type are ignored.

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

resetReapplyType​

resetReapplyType: ResetReapplyType

Deprecated. Use options.

resetType​

resetType: ResetType

Deprecated. Use options.

Methods​

toJSON()​

toJSON(): object

Converts this BatchOperationReset to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): BatchOperationReset & $Shape

Creates a new BatchOperationReset instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

BatchOperationReset & $Shape

BatchOperationReset instance

Call Signature​

static create(properties?): BatchOperationReset

Creates a new BatchOperationReset instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

BatchOperationReset

BatchOperationReset instance

decode()​

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

Decodes a BatchOperationReset 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​

BatchOperationReset & $Shape

BatchOperationReset

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): BatchOperationReset & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

BatchOperationReset & $Shape

BatchOperationReset

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

Parameters​

message​

$Properties

BatchOperationReset message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

BatchOperationReset message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): BatchOperationReset

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

Parameters​

object​

Plain object

Returns​

BatchOperationReset

BatchOperationReset

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

BatchOperationReset

BatchOperationReset

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object