Class: ResetActivityExecutionRequest

workflowservice.v1.ResetActivityExecutionRequest

Represents a ResetActivityExecutionRequest.

Implements

• IResetActivityExecutionRequest

Constructors

constructor

• new ResetActivityExecutionRequest(properties?): ResetActivityExecutionRequest

Constructs a new ResetActivityExecutionRequest.

Parameters

Name	Type	Description
properties?	IResetActivityExecutionRequest	Properties to set

Returns

ResetActivityExecutionRequest

Properties

activityId

• activityId: string

The ID of the activity to target.

Implementation of

IResetActivityExecutionRequest.activityId

---

identity

• identity: string

The identity of the client who initiated this request.

Implementation of

IResetActivityExecutionRequest.identity

---

jitter

• Optional jitter: null | IDuration

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)

Implementation of

IResetActivityExecutionRequest.jitter

---

keepPaused

• keepPaused: boolean

If activity is paused, it will remain paused after reset

Implementation of

IResetActivityExecutionRequest.keepPaused

---

namespace

• namespace: string

Namespace of the workflow which scheduled this activity.

Implementation of

IResetActivityExecutionRequest.namespace

---

resetHeartbeat

• resetHeartbeat: boolean

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

Implementation of

IResetActivityExecutionRequest.resetHeartbeat

---

resourceId

• resourceId: string

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

Implementation of

IResetActivityExecutionRequest.resourceId

---

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.

Implementation of

IResetActivityExecutionRequest.restoreOriginalOptions

---

runId

• runId: string

Run ID of the workflow or standalone activity.

Implementation of

IResetActivityExecutionRequest.runId

---

workflowId

• workflowId: string

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

Implementation of

IResetActivityExecutionRequest.workflowId

Methods

toJSON

▸ toJSON(): Object

Converts this ResetActivityExecutionRequest to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): ResetActivityExecutionRequest

Creates a new ResetActivityExecutionRequest instance using the specified properties.

Parameters

Name	Type	Description
properties?	IResetActivityExecutionRequest	Properties to set

Returns

ResetActivityExecutionRequest

ResetActivityExecutionRequest instance

---

decode

▸ decode(reader, length?): ResetActivityExecutionRequest

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

ResetActivityExecutionRequest

ResetActivityExecutionRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): ResetActivityExecutionRequest

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

Parameters

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

Returns

ResetActivityExecutionRequest

ResetActivityExecutionRequest

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

Parameters

Name	Type	Description
message	IResetActivityExecutionRequest	ResetActivityExecutionRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IResetActivityExecutionRequest	ResetActivityExecutionRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): ResetActivityExecutionRequest

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

ResetActivityExecutionRequest

ResetActivityExecutionRequest

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ResetActivityExecutionRequest

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 ResetActivityExecutionRequest message. Also converts values to other types if specified.

Parameters

Name	Type	Description
message	ResetActivityExecutionRequest	ResetActivityExecutionRequest
options?	IConversionOptions	Conversion options

Returns

Object

Plain object