Class: QueryWorkflowRequest
workflowservice.v1.QueryWorkflowRequest
Represents a QueryWorkflowRequest.
Implements
Constructors
constructor
• new QueryWorkflowRequest(properties?): QueryWorkflowRequest
Constructs a new QueryWorkflowRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IQueryWorkflowRequest | Properties to set |
Returns
Properties
execution
• Optional execution: null | IWorkflowExecution
QueryWorkflowRequest execution.
Implementation of
IQueryWorkflowRequest.execution
namespace
• namespace: string
QueryWorkflowRequest namespace.
Implementation of
IQueryWorkflowRequest.namespace
query
• Optional query: null | IWorkflowQuery
QueryWorkflowRequest query.
Implementation of
queryRejectCondition
• queryRejectCondition: QueryRejectCondition
QueryRejectCondition can used to reject the query if workflow state does not satisfy condition. Default: QUERY_REJECT_CONDITION_NONE.
Implementation of
IQueryWorkflowRequest.queryRejectCondition
Methods
toJSON
▸ toJSON(): Object
Converts this QueryWorkflowRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): QueryWorkflowRequest
Creates a new QueryWorkflowRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IQueryWorkflowRequest | Properties to set |
Returns
QueryWorkflowRequest instance
decode
▸ decode(reader, length?): QueryWorkflowRequest
Decodes a QueryWorkflowRequest 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
QueryWorkflowRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): QueryWorkflowRequest
Decodes a QueryWorkflowRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
QueryWorkflowRequest
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 QueryWorkflowRequest message. Does not implicitly temporal.api.workflowservice.v1.QueryWorkflowRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IQueryWorkflowRequest | QueryWorkflowRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified QueryWorkflowRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.QueryWorkflowRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IQueryWorkflowRequest | QueryWorkflowRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): QueryWorkflowRequest
Creates a QueryWorkflowRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
QueryWorkflowRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for QueryWorkflowRequest
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 QueryWorkflowRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | QueryWorkflowRequest | QueryWorkflowRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object