Class: RecordActivityTaskHeartbeatByIdRequest

workflowservice.v1.RecordActivityTaskHeartbeatByIdRequest

Represents a RecordActivityTaskHeartbeatByIdRequest.

Properties

activityId

• activityId: string

Id of the activity we're heartbeating

---

details

• Optional details: null | $Properties

Arbitrary data, of which the most recent call is kept, to store for this activity

---

identity

• identity: string

The identity of the worker/client

---

namespace

• namespace: string

Namespace of the workflow which scheduled this activity

---

resourceId

• resourceId: string

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

---

runId

• runId: string

For a workflow activity - the run ID of the workflow which scheduled this activity. For a standalone activity - the run ID of the activity.

---

workflowId

• workflowId: string

Id of the workflow which scheduled this activity, leave empty to target a standalone activity

Methods

toJSON

▸ toJSON(): Object

Converts this RecordActivityTaskHeartbeatByIdRequest to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): RecordActivityTaskHeartbeatByIdRequest & $Properties

Creates a new RecordActivityTaskHeartbeatByIdRequest instance using the specified properties.

Parameters

Name	Type	Description
properties?	$Properties	Properties to set

Returns

RecordActivityTaskHeartbeatByIdRequest & $Properties

RecordActivityTaskHeartbeatByIdRequest instance

▸ create(properties?): RecordActivityTaskHeartbeatByIdRequest

Parameters

Name	Type
properties?	$Properties

Returns

RecordActivityTaskHeartbeatByIdRequest

---

decode

▸ decode(reader, length?): RecordActivityTaskHeartbeatByIdRequest & $Properties

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

RecordActivityTaskHeartbeatByIdRequest & $Properties

RecordActivityTaskHeartbeatByIdRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): RecordActivityTaskHeartbeatByIdRequest & $Properties

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

Parameters

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

Returns

RecordActivityTaskHeartbeatByIdRequest & $Properties

RecordActivityTaskHeartbeatByIdRequest

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

Parameters

Name	Type	Description
message	$Properties	RecordActivityTaskHeartbeatByIdRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	$Properties	RecordActivityTaskHeartbeatByIdRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): RecordActivityTaskHeartbeatByIdRequest

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

RecordActivityTaskHeartbeatByIdRequest

RecordActivityTaskHeartbeatByIdRequest

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	RecordActivityTaskHeartbeatByIdRequest	RecordActivityTaskHeartbeatByIdRequest
options?	IConversionOptions	Conversion options

Returns

Object

Plain object