Skip to main content

Class: BatchOperationResetActivities

BatchOperationResetActivities sends activity reset requests in a batch. NOTE: keep in sync with temporal.api.workflowservice.v1.ResetActivityRequest

Properties​

activity?​

optional activity?: "type" | "matchAll"

The activities to reset. If match_all is set to true, all activities will be reset.

identity​

identity: string

The identity of the worker/client.

jitter?​

optional jitter?: $Properties | null

If set, the activity will start at a random time within the specified jitter duration, introducing variability to the start time.

keepPaused​

keepPaused: boolean

If activity is paused, it will remain paused after reset

matchAll?​

optional matchAll?: boolean | null

BatchOperationResetActivities matchAll.

resetAttempts​

resetAttempts: boolean

Setting this flag will also reset the number of attempts.

resetHeartbeat​

resetHeartbeat: boolean

Setting this flag will also reset the heartbeat details.

restoreOriginalOptions​

restoreOriginalOptions: boolean

If set, the activity options will be restored to the defaults. Default options are then options activity was created with. They are part of the first ActivityTaskScheduled event.

type?​

optional type?: string | null

BatchOperationResetActivities type.

Methods​

toJSON()​

toJSON(): object

Converts this BatchOperationResetActivities to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): BatchOperationResetActivities & $Shape

Creates a new BatchOperationResetActivities instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

BatchOperationResetActivities & $Shape

BatchOperationResetActivities instance

Call Signature​

static create(properties?): BatchOperationResetActivities

Creates a new BatchOperationResetActivities instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

BatchOperationResetActivities

BatchOperationResetActivities instance

decode()​

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

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

BatchOperationResetActivities & $Shape

BatchOperationResetActivities

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): BatchOperationResetActivities & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

BatchOperationResetActivities & $Shape

BatchOperationResetActivities

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

Parameters​

message​

$Properties

BatchOperationResetActivities message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

BatchOperationResetActivities message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): BatchOperationResetActivities

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

Parameters​

object​

Plain object

Returns​

BatchOperationResetActivities

BatchOperationResetActivities

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

BatchOperationResetActivities

BatchOperationResetActivities

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object