Class: WorkflowQueryResult
Answer to a WorkflowQuery
Properties
answer
• Optional answer: null | $Properties
Set when the query succeeds with the results.
Mutually exclusive with error_message and failure.
errorMessage
• errorMessage: string
Mutually exclusive with answer. Set when the query fails.
See also the newer failure field.
failure
• Optional failure: null | $Properties
The full reason for this query failure. This field is newer than error_message and can be encoded by the SDK's
failure converter to support E2E encryption of messages and stack traces.
Mutually exclusive with answer. Set when the query fails.
resultType
• resultType: QueryResultType
Did the query succeed or fail?
Methods
toJSON
▸ toJSON(): Object
Converts this WorkflowQueryResult to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkflowQueryResult & $Shape
Creates a new WorkflowQueryResult instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
WorkflowQueryResult instance
▸ create(properties?): WorkflowQueryResult
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): WorkflowQueryResult & $Shape
Decodes a WorkflowQueryResult 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
WorkflowQueryResult
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkflowQueryResult & $Shape
Decodes a WorkflowQueryResult message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkflowQueryResult
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 WorkflowQueryResult message. Does not implicitly temporal.api.query.v1.WorkflowQueryResult.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkflowQueryResult message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkflowQueryResult message, length delimited. Does not implicitly temporal.api.query.v1.WorkflowQueryResult.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkflowQueryResult message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkflowQueryResult
Creates a WorkflowQueryResult message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkflowQueryResult
toObject
▸ toObject(message, options?): Object
Creates a plain object from a WorkflowQueryResult message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkflowQueryResult | WorkflowQueryResult |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object