Class: WorkflowQueryResult
Answer to a WorkflowQuery
Implements
Constructors
constructor
• new WorkflowQueryResult(properties?): WorkflowQueryResult
Constructs a new WorkflowQueryResult.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkflowQueryResult | Properties to set |
Returns
Properties
answer
• Optional answer: null | IPayloads
Set when the query succeeds with the results.
Mutually exclusive with error_message and failure.
Implementation of
errorMessage
• errorMessage: string
Mutually exclusive with answer. Set when the query fails.
See also the newer failure field.
Implementation of
IWorkflowQueryResult.errorMessage
failure
• Optional failure: null | IFailure
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.
Implementation of
resultType
• resultType: QueryResultType
Did the query succeed or fail?
Implementation of
IWorkflowQueryResult.resultType
Methods
toJSON
▸ toJSON(): Object
Converts this WorkflowQueryResult to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkflowQueryResult
Creates a new WorkflowQueryResult instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkflowQueryResult | Properties to set |
Returns
WorkflowQueryResult instance
decode
▸ decode(reader, length?): WorkflowQueryResult
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
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 | IWorkflowQueryResult | 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 | IWorkflowQueryResult | 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
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for WorkflowQueryResult
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 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