Class: RecordActivityTaskHeartbeatByIdRequest

Represents a RecordActivityTaskHeartbeatByIdRequest.

Properties

activityId

activityId: string

Id of the activity we're heartbeating

---

details?

optional details?: $Properties | null

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()

Call Signature

static create(properties?): RecordActivityTaskHeartbeatByIdRequest & $Properties

Creates a new RecordActivityTaskHeartbeatByIdRequest instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

RecordActivityTaskHeartbeatByIdRequest & $Properties

RecordActivityTaskHeartbeatByIdRequest instance

Call Signature

static create(properties?): RecordActivityTaskHeartbeatByIdRequest

Creates a new RecordActivityTaskHeartbeatByIdRequest instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

RecordActivityTaskHeartbeatByIdRequest

RecordActivityTaskHeartbeatByIdRequest instance

---

decode()

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

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

RecordActivityTaskHeartbeatByIdRequest & $Properties

RecordActivityTaskHeartbeatByIdRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): RecordActivityTaskHeartbeatByIdRequest & $Properties

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

Parameters

reader

Uint8Array<ArrayBufferLike> | 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()

static encode(message, writer?): Writer

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

Parameters

message

$Properties

RecordActivityTaskHeartbeatByIdRequest message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

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

Parameters

message

$Properties

RecordActivityTaskHeartbeatByIdRequest message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): RecordActivityTaskHeartbeatByIdRequest

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

Parameters

object

Plain object

Returns

RecordActivityTaskHeartbeatByIdRequest

RecordActivityTaskHeartbeatByIdRequest

---

toObject()

static toObject(message, options?): object

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

Parameters

message

RecordActivityTaskHeartbeatByIdRequest

RecordActivityTaskHeartbeatByIdRequest

options?

IConversionOptions

Conversion options

Returns

object

Plain object