Class: RecordActivityTaskHeartbeatResponse
workflowservice.v1.RecordActivityTaskHeartbeatResponse
Represents a RecordActivityTaskHeartbeatResponse.
Implements
Constructors
constructor
• new RecordActivityTaskHeartbeatResponse(properties?): RecordActivityTaskHeartbeatResponse
Constructs a new RecordActivityTaskHeartbeatResponse.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRecordActivityTaskHeartbeatResponse | Properties to set |
Returns
RecordActivityTaskHeartbeatResponse
Properties
activityPaused
• activityPaused: boolean
Will be set to true if the activity is paused.
Implementation of
IRecordActivityTaskHeartbeatResponse.activityPaused
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.
Implementation of
IRecordActivityTaskHeartbeatResponse.cancelRequested
Methods
toJSON
▸ toJSON(): Object
Converts this RecordActivityTaskHeartbeatResponse to JSON.
Returns
Object
JSON object
create
▸ create(properties?): RecordActivityTaskHeartbeatResponse
Creates a new RecordActivityTaskHeartbeatResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRecordActivityTaskHeartbeatResponse | Properties to set |
Returns
RecordActivityTaskHeartbeatResponse
RecordActivityTaskHeartbeatResponse instance
decode
▸ decode(reader, length?): RecordActivityTaskHeartbeatResponse
Decodes a RecordActivityTaskHeartbeatResponse 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
RecordActivityTaskHeartbeatResponse
RecordActivityTaskHeartbeatResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): RecordActivityTaskHeartbeatResponse
Decodes a RecordActivityTaskHeartbeatResponse message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
RecordActivityTaskHeartbeatResponse
RecordActivityTaskHeartbeatResponse
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 RecordActivityTaskHeartbeatResponse message. Does not implicitly temporal.api.workflowservice.v1.RecordActivityTaskHeartbeatResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IRecordActivityTaskHeartbeatResponse | RecordActivityTaskHeartbeatResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified RecordActivityTaskHeartbeatResponse message, length delimited. Does not implicitly temporal.api.workflowservice.v1.RecordActivityTaskHeartbeatResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IRecordActivityTaskHeartbeatResponse | RecordActivityTaskHeartbeatResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): RecordActivityTaskHeartbeatResponse
Creates a RecordActivityTaskHeartbeatResponse message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
RecordActivityTaskHeartbeatResponse
RecordActivityTaskHeartbeatResponse
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for RecordActivityTaskHeartbeatResponse
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 RecordActivityTaskHeartbeatResponse message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | RecordActivityTaskHeartbeatResponse | RecordActivityTaskHeartbeatResponse |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object