Class: ResetActivityExecutionRequest

Represents a ResetActivityExecutionRequest.

Properties

activityId

activityId: string

The ID of the activity to target.

---

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

---

namespace

namespace: string

Namespace of the workflow which scheduled this activity.

---

requestId

requestId: string

Used to de-dupe reset requests.

---

resetHeartbeat

resetHeartbeat: boolean

Reset persisted heartbeat details. Reset always resets the attempt counter. Passing this flag causes reset to additionally discard any persisted heartbeat details.

---

resourceId

resourceId: string

Resource ID for routing. Contains "workflow:{workflow_id}" for workflow activities or "activity:{activity_id}" for standalone activities.

---

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.

---

runId

runId: string

Run ID of the workflow or standalone activity. If empty, targets the latest run.

---

workflowId

workflowId: string

If provided, targets a workflow activity for the given workflow ID. If empty, targets a standalone activity.

Methods

toJSON()

toJSON(): object

Converts this ResetActivityExecutionRequest to JSON.

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): ResetActivityExecutionRequest & $Properties

Creates a new ResetActivityExecutionRequest instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

ResetActivityExecutionRequest & $Properties

ResetActivityExecutionRequest instance

Call Signature

static create(properties?): ResetActivityExecutionRequest

Creates a new ResetActivityExecutionRequest instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

ResetActivityExecutionRequest

ResetActivityExecutionRequest instance

---

decode()

static decode(reader, length?): ResetActivityExecutionRequest & $Properties

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

ResetActivityExecutionRequest & $Properties

ResetActivityExecutionRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): ResetActivityExecutionRequest & $Properties

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

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

ResetActivityExecutionRequest & $Properties

ResetActivityExecutionRequest

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

Parameters

message

$Properties

ResetActivityExecutionRequest message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

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

Parameters

message

$Properties

ResetActivityExecutionRequest message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): ResetActivityExecutionRequest

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

Parameters

object

Plain object

Returns

ResetActivityExecutionRequest

ResetActivityExecutionRequest

---

toObject()

static toObject(message, options?): object

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

Parameters

message

ResetActivityExecutionRequest

ResetActivityExecutionRequest

options?

IConversionOptions

Conversion options

Returns

object

Plain object