Class: ResetActivityByIdRequest

workflowservice.v1.ResetActivityByIdRequest

Represents a ResetActivityByIdRequest.

Implements

• IResetActivityByIdRequest

Constructors

constructor

• new ResetActivityByIdRequest(properties?): ResetActivityByIdRequest

Constructs a new ResetActivityByIdRequest.

Parameters

Name	Type	Description
properties?	IResetActivityByIdRequest	Properties to set

Returns

ResetActivityByIdRequest

Properties

activityId

• activityId: string

ID of the activity we're updating.

Implementation of

IResetActivityByIdRequest.activityId

---

identity

• identity: string

The identity of the client who initiated this request.

Implementation of

IResetActivityByIdRequest.identity

---

namespace

• namespace: string

Namespace of the workflow which scheduled this activity.

Implementation of

IResetActivityByIdRequest.namespace

---

noWait

• noWait: boolean

Indicates that activity should be scheduled immediately. If this flag doesn't set, and activity currently running - temporal will wait until activity is completed.

Implementation of

IResetActivityByIdRequest.noWait

---

requestId

• requestId: string

Used to de-dupe requests.

Implementation of

IResetActivityByIdRequest.requestId

---

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

IResetActivityByIdRequest.resetHeartbeat

---

runId

• runId: string

Run ID of the workflow which scheduled this activity. If empty - latest workflow is used.

Implementation of

IResetActivityByIdRequest.runId

---

workflowId

• workflowId: string

ID of the workflow which scheduled this activity.

Implementation of

IResetActivityByIdRequest.workflowId

Methods

toJSON

▸ toJSON(): Object

Converts this ResetActivityByIdRequest to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): ResetActivityByIdRequest

Creates a new ResetActivityByIdRequest instance using the specified properties.

Parameters

Name	Type	Description
properties?	IResetActivityByIdRequest	Properties to set

Returns

ResetActivityByIdRequest

ResetActivityByIdRequest instance

---

decode

▸ decode(reader, length?): ResetActivityByIdRequest

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

ResetActivityByIdRequest

ResetActivityByIdRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): ResetActivityByIdRequest

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

Parameters

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

Returns

ResetActivityByIdRequest

ResetActivityByIdRequest

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

Parameters

Name	Type	Description
message	IResetActivityByIdRequest	ResetActivityByIdRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IResetActivityByIdRequest	ResetActivityByIdRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): ResetActivityByIdRequest

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

ResetActivityByIdRequest

ResetActivityByIdRequest

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ResetActivityByIdRequest

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

Parameters

Name	Type	Description
message	ResetActivityByIdRequest	ResetActivityByIdRequest
options?	IConversionOptions	Conversion options

Returns

Object

Plain object