Class: RecordActivityTaskHeartbeatRequest
workflowservice.v1.RecordActivityTaskHeartbeatRequest
Represents a RecordActivityTaskHeartbeatRequest.
Properties
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
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
▸ create(properties?): RecordActivityTaskHeartbeatRequest & $Properties
Creates a new RecordActivityTaskHeartbeatRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
RecordActivityTaskHeartbeatRequest & $Properties
RecordActivityTaskHeartbeatRequest instance
▸ create(properties?): RecordActivityTaskHeartbeatRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
RecordActivityTaskHeartbeatRequest
decode
▸ decode(reader, length?): RecordActivityTaskHeartbeatRequest & $Properties
Decodes a RecordActivityTaskHeartbeatRequest 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
RecordActivityTaskHeartbeatRequest & $Properties
RecordActivityTaskHeartbeatRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): RecordActivityTaskHeartbeatRequest & $Properties
Decodes a RecordActivityTaskHeartbeatRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | 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
▸ encode(message, writer?): Writer
Encodes the specified RecordActivityTaskHeartbeatRequest message. Does not implicitly temporal.api.workflowservice.v1.RecordActivityTaskHeartbeatRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | RecordActivityTaskHeartbeatRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified RecordActivityTaskHeartbeatRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.RecordActivityTaskHeartbeatRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | RecordActivityTaskHeartbeatRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): RecordActivityTaskHeartbeatRequest
Creates a RecordActivityTaskHeartbeatRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
RecordActivityTaskHeartbeatRequest
RecordActivityTaskHeartbeatRequest
toObject
▸ toObject(message, options?): Object
Creates a plain object from a RecordActivityTaskHeartbeatRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | RecordActivityTaskHeartbeatRequest | RecordActivityTaskHeartbeatRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object