Class: RecordActivityTaskHeartbeatRequest
workflowservice.v1.RecordActivityTaskHeartbeatRequest
Represents a RecordActivityTaskHeartbeatRequest.
Implements
Constructors
constructor
• new RecordActivityTaskHeartbeatRequest(properties?): RecordActivityTaskHeartbeatRequest
Constructs a new RecordActivityTaskHeartbeatRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRecordActivityTaskHeartbeatRequest | Properties to set |
Returns
RecordActivityTaskHeartbeatRequest
Properties
details
• Optional details: null | IPayloads
Arbitrary data, of which the most recent call is kept, to store for this activity
Implementation of
IRecordActivityTaskHeartbeatRequest.details
identity
• identity: string
The identity of the worker/client
Implementation of
IRecordActivityTaskHeartbeatRequest.identity
namespace
• namespace: string
RecordActivityTaskHeartbeatRequest namespace.
Implementation of
IRecordActivityTaskHeartbeatRequest.namespace
taskToken
• taskToken: Uint8Array
The task token as received in PollActivityTaskQueueResponse
Implementation of
IRecordActivityTaskHeartbeatRequest.taskToken
Methods
toJSON
▸ toJSON(): Object
Converts this RecordActivityTaskHeartbeatRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): RecordActivityTaskHeartbeatRequest
Creates a new RecordActivityTaskHeartbeatRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRecordActivityTaskHeartbeatRequest | Properties to set |
Returns
RecordActivityTaskHeartbeatRequest
RecordActivityTaskHeartbeatRequest instance
decode
▸ decode(reader, length?): RecordActivityTaskHeartbeatRequest
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
RecordActivityTaskHeartbeatRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): RecordActivityTaskHeartbeatRequest
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
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 | IRecordActivityTaskHeartbeatRequest | 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 | IRecordActivityTaskHeartbeatRequest | 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
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for RecordActivityTaskHeartbeatRequest
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
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