Skip to main content

Class: RecordActivityTaskHeartbeatRequest

Represents a RecordActivityTaskHeartbeatRequest.

Properties​

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

RecordActivityTaskHeartbeatRequest namespace.

resourceId​

resourceId: string

Resource ID for routing. Contains the workflow ID or activity ID for standalone activities.

taskToken​

taskToken: Uint8Array

The task token as received in PollActivityTaskQueueResponse

Methods​

toJSON()​

toJSON(): object

Converts this RecordActivityTaskHeartbeatRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): RecordActivityTaskHeartbeatRequest & $Properties

Creates a new RecordActivityTaskHeartbeatRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

RecordActivityTaskHeartbeatRequest & $Properties

RecordActivityTaskHeartbeatRequest instance

Call Signature​

static create(properties?): RecordActivityTaskHeartbeatRequest

Creates a new RecordActivityTaskHeartbeatRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

RecordActivityTaskHeartbeatRequest

RecordActivityTaskHeartbeatRequest instance

decode()​

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

Decodes a RecordActivityTaskHeartbeatRequest 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​

RecordActivityTaskHeartbeatRequest & $Properties

RecordActivityTaskHeartbeatRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): RecordActivityTaskHeartbeatRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

RecordActivityTaskHeartbeatRequest & $Properties

RecordActivityTaskHeartbeatRequest

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

Parameters​

message​

$Properties

RecordActivityTaskHeartbeatRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

RecordActivityTaskHeartbeatRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): RecordActivityTaskHeartbeatRequest

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

Parameters​

object​

Plain object

Returns​

RecordActivityTaskHeartbeatRequest

RecordActivityTaskHeartbeatRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

RecordActivityTaskHeartbeatRequest

RecordActivityTaskHeartbeatRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object