Class: UpdateResponse
coresdk.workflow_commands.UpdateResponse
A reply to a DoUpdate job - lang must run the update's validator if told to, and then
immediately run the handler, if the update was accepted.
There must always be an accepted or rejected response immediately, in the same activation as this job, to indicate the result of the validator. Accepted for ran and accepted or skipped, or rejected for rejected.
Then, in the same or any subsequent activation, after the update handler has completed, respond with completed or rejected as appropriate for the result of the handler.
Properties
accepted
• Optional accepted: null | $Properties
Must be sent if the update's validator has passed (or lang was not asked to run it, and thus should be considered already-accepted, allowing lang to always send the same sequence on replay).
completed
• Optional completed: null | $Properties
Must be sent once the update handler completes successfully.
protocolInstanceId
• protocolInstanceId: string
The protocol message instance ID
rejected
• Optional rejected: null | $Properties
Must be sent if the update's validator does not pass, or after acceptance if the update handler fails.
response
• Optional response: "completed" | "accepted" | "rejected"
UpdateResponse response.
Methods
toJSON
▸ toJSON(): Object
Converts this UpdateResponse to JSON.
Returns
Object
JSON object
create
▸ create(properties?): UpdateResponse & $Shape
Creates a new UpdateResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
UpdateResponse instance
▸ create(properties?): UpdateResponse
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): UpdateResponse & $Shape
Decodes an UpdateResponse 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
UpdateResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): UpdateResponse & $Shape
Decodes an UpdateResponse message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
UpdateResponse
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 UpdateResponse message. Does not implicitly coresdk.workflow_commands.UpdateResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | UpdateResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified UpdateResponse message, length delimited. Does not implicitly coresdk.workflow_commands.UpdateResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | UpdateResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): UpdateResponse
Creates an UpdateResponse message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
UpdateResponse
toObject
▸ toObject(message, options?): Object
Creates a plain object from an UpdateResponse message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | UpdateResponse | UpdateResponse |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object