Skip to main content

Class: RecordActivityTaskHeartbeatResponse

Represents a RecordActivityTaskHeartbeatResponse.

Properties​

activityPaused​

activityPaused: boolean

Will be set to true if the activity is paused.


activityReset​

activityReset: boolean

Will be set to true if the activity was reset. Applies only to the current run.


cancelRequested​

cancelRequested: boolean

Will be set to true if the activity has been asked to cancel itself. The SDK should then notify the activity of cancellation if it is still running.

Methods​

toJSON()​

toJSON(): object

Converts this RecordActivityTaskHeartbeatResponse to JSON.

Returns​

object

JSON object


create()​

Call Signature​

static create(properties?): RecordActivityTaskHeartbeatResponse & $Properties

Creates a new RecordActivityTaskHeartbeatResponse instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

RecordActivityTaskHeartbeatResponse & $Properties

RecordActivityTaskHeartbeatResponse instance

Call Signature​

static create(properties?): RecordActivityTaskHeartbeatResponse

Creates a new RecordActivityTaskHeartbeatResponse instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

RecordActivityTaskHeartbeatResponse

RecordActivityTaskHeartbeatResponse instance


decode()​

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

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

RecordActivityTaskHeartbeatResponse & $Properties

RecordActivityTaskHeartbeatResponse

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing


decodeDelimited()​

static decodeDelimited(reader): RecordActivityTaskHeartbeatResponse & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

RecordActivityTaskHeartbeatResponse & $Properties

RecordActivityTaskHeartbeatResponse

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

Parameters​

message​

$Properties

RecordActivityTaskHeartbeatResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

RecordActivityTaskHeartbeatResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


fromObject()​

static fromObject(object): RecordActivityTaskHeartbeatResponse

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

Parameters​

object​

Plain object

Returns​

RecordActivityTaskHeartbeatResponse

RecordActivityTaskHeartbeatResponse


toObject()​

static toObject(message, options?): object

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

Parameters​

message​

RecordActivityTaskHeartbeatResponse

RecordActivityTaskHeartbeatResponse

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object