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