Class: ResetActivityRequest

workflowservice.v1.ResetActivityRequest

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

Implements

• IResetActivityRequest

Constructors

constructor

• new ResetActivityRequest(properties?): ResetActivityRequest

Constructs a new ResetActivityRequest.

Parameters

Name	Type	Description
properties?	IResetActivityRequest	Properties to set

Returns

ResetActivityRequest

Properties

activity

• Optional activity: "id" | "type" | "matchAll"

either activity id, activity type or update_all must be provided

---

execution

• Optional execution: null | IWorkflowExecution

Execution info of the workflow which scheduled this activity

Implementation of

IResetActivityRequest.execution

---

id

• Optional id: null | string

Only activity with this ID will be reset.

Implementation of

IResetActivityRequest.id

---

identity

• identity: string

The identity of the client who initiated this request.

Implementation of

IResetActivityRequest.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

IResetActivityRequest.jitter

---

keepPaused

• keepPaused: boolean

If activity is paused, it will remain paused after reset

Implementation of

IResetActivityRequest.keepPaused

---

matchAll

• Optional matchAll: null | boolean

Reset all running activities.

Implementation of

IResetActivityRequest.matchAll

---

namespace

• namespace: string

Namespace of the workflow which scheduled this activity.

Implementation of

IResetActivityRequest.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

IResetActivityRequest.resetHeartbeat

---

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

IResetActivityRequest.restoreOriginalOptions

---

type

• Optional type: null | string

Reset all running activities with of this type.

Implementation of

IResetActivityRequest.type

Methods

toJSON

▸ toJSON(): Object

Converts this ResetActivityRequest to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): ResetActivityRequest

Creates a new ResetActivityRequest instance using the specified properties.

Parameters

Name	Type	Description
properties?	IResetActivityRequest	Properties to set

Returns

ResetActivityRequest

ResetActivityRequest instance

---

decode

▸ decode(reader, length?): ResetActivityRequest

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

ResetActivityRequest

ResetActivityRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): ResetActivityRequest

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

Parameters

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

Returns

ResetActivityRequest

ResetActivityRequest

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

Parameters

Name	Type	Description
message	IResetActivityRequest	ResetActivityRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IResetActivityRequest	ResetActivityRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): ResetActivityRequest

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

ResetActivityRequest

ResetActivityRequest

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ResetActivityRequest

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

Parameters

Name	Type	Description
message	ResetActivityRequest	ResetActivityRequest
options?	IConversionOptions	Conversion options

Returns

Object

Plain object