Class: WorkflowQuery
See https://docs.temporal.io/docs/concepts/queries/
Implements
Constructors
constructor
• new WorkflowQuery(properties?): WorkflowQuery
Constructs a new WorkflowQuery.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkflowQuery | Properties to set |
Returns
Properties
header
• Optional header: null | IHeader
Headers that were passed by the caller of the query and copied by temporal server into the workflow task.
Implementation of
queryArgs
• Optional queryArgs: null | IPayloads
Serialized arguments that will be provided to the query handler.
Implementation of
queryType
• queryType: string
The workflow-author-defined identifier of the query. Typically a function name.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this WorkflowQuery to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkflowQuery
Creates a new WorkflowQuery instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkflowQuery | Properties to set |
Returns
WorkflowQuery instance
decode
▸ decode(reader, length?): WorkflowQuery
Decodes a WorkflowQuery 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
WorkflowQuery
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkflowQuery
Decodes a WorkflowQuery message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkflowQuery
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 WorkflowQuery message. Does not implicitly temporal.api.query.v1.WorkflowQuery.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkflowQuery | WorkflowQuery message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkflowQuery message, length delimited. Does not implicitly temporal.api.query.v1.WorkflowQuery.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkflowQuery | WorkflowQuery message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkflowQuery
Creates a WorkflowQuery message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkflowQuery
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for WorkflowQuery
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 WorkflowQuery message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkflowQuery | WorkflowQuery |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object