Class: Response
An update protocol message indicating that a workflow execution update has completed with the contained outcome.
Implements
Constructors
constructor
• new Response(properties?): Response
Constructs a new Response.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IResponse | Properties to set |
Returns
Properties
meta
• Optional meta: null | IMeta
Response meta.
Implementation of
outcome
• Optional outcome: null | IOutcome
Response outcome.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this Response to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Response
Creates a new Response instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IResponse | Properties to set |
Returns
Response instance
decode
▸ decode(reader, length?): Response
Decodes a Response 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
Response
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Response
Decodes a Response message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Response
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 Response message. Does not implicitly temporal.api.update.v1.Response.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IResponse | Response message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Response message, length delimited. Does not implicitly temporal.api.update.v1.Response.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IResponse | Response message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Response
Creates a Response message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Response
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for Response
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 Response message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Response | Response |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object