Skip to main content

Class: ResetActivityRequest

NOTE: keep in sync with temporal.api.batch.v1.BatchOperationResetActivities Deprecated. Use ResetActivityExecutionRequest.

Properties​

activity?​

optional activity?: "id" | "type" | "matchAll"

either activity id, activity type or update_all must be provided

execution?​

optional execution?: $Properties | null

Execution info of the workflow which scheduled this activity

id?​

optional id?: string | null

Only activity with this ID will be reset.

identity​

identity: string

The identity of the client who initiated this request.

jitter?​

optional jitter?: $Properties | null

If set, and activity is in backoff, the activity will start at a random time within the specified jitter duration. (unless it is paused and keep_paused is set)

keepPaused​

keepPaused: boolean

If activity is paused, it will remain paused after reset

matchAll?​

optional matchAll?: boolean | null

Reset all running activities.

namespace​

namespace: string

Namespace of the workflow which scheduled this activity.

resetHeartbeat​

resetHeartbeat: boolean

Indicates that activity should reset heartbeat details. This flag will be applied only to the new instance of the activity.

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 schedule event.

type?​

optional type?: string | null

Reset all running activities with of this type.

Methods​

toJSON()​

toJSON(): object

Converts this ResetActivityRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ResetActivityRequest & $Shape

Creates a new ResetActivityRequest instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

ResetActivityRequest & $Shape

ResetActivityRequest instance

Call Signature​

static create(properties?): ResetActivityRequest

Creates a new ResetActivityRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ResetActivityRequest

ResetActivityRequest instance

decode()​

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

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

ResetActivityRequest & $Shape

ResetActivityRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ResetActivityRequest & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ResetActivityRequest & $Shape

ResetActivityRequest

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

Parameters​

message​

$Properties

ResetActivityRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

ResetActivityRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ResetActivityRequest

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

Parameters​

object​

Plain object

Returns​

ResetActivityRequest

ResetActivityRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ResetActivityRequest

ResetActivityRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object