Class: RespondQueryTaskCompletedRequest
workflowservice.v1.RespondQueryTaskCompletedRequest
Represents a RespondQueryTaskCompletedRequest.
Properties
cause
• cause: WorkflowTaskFailedCause
Why did the task fail? It's important to note that many of the variants in this enum cannot apply to worker responses. See the type's doc for more.
completedType
• completedType: QueryResultType
RespondQueryTaskCompletedRequest completedType.
errorMessage
• errorMessage: string
A plain error message that must be set if completed_type is QUERY_RESULT_TYPE_FAILED.
SDKs should also fill in the more complete failure field to provide the full context and
support encryption of failure information.
error_message will be duplicated if the failure field is present to support callers
that pre-date the addition of that field, regardless of whether or not a custom failure
converter is used.
Mutually exclusive with query_result. Set when the query fails.
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 query_result. Set when the query fails.
namespace
• namespace: string
RespondQueryTaskCompletedRequest namespace.
pollerGroupId
• pollerGroupId: string
Client must forward the poller_group_id received in PollWorkflowTaskQueueResponse for proper routing of the response.
queryResult
• Optional queryResult: null | $Properties
The result of the query.
Mutually exclusive with error_message and failure. Set when the query succeeds.
taskToken
• taskToken: Uint8Array
RespondQueryTaskCompletedRequest taskToken.
Methods
toJSON
▸ toJSON(): Object
Converts this RespondQueryTaskCompletedRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): RespondQueryTaskCompletedRequest & $Shape
Creates a new RespondQueryTaskCompletedRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
RespondQueryTaskCompletedRequest & $Shape
RespondQueryTaskCompletedRequest instance
▸ create(properties?): RespondQueryTaskCompletedRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
RespondQueryTaskCompletedRequest
decode
▸ decode(reader, length?): RespondQueryTaskCompletedRequest & $Shape
Decodes a RespondQueryTaskCompletedRequest 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
RespondQueryTaskCompletedRequest & $Shape
RespondQueryTaskCompletedRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): RespondQueryTaskCompletedRequest & $Shape
Decodes a RespondQueryTaskCompletedRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
RespondQueryTaskCompletedRequest & $Shape
RespondQueryTaskCompletedRequest
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 RespondQueryTaskCompletedRequest message. Does not implicitly temporal.api.workflowservice.v1.RespondQueryTaskCompletedRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | RespondQueryTaskCompletedRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified RespondQueryTaskCompletedRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.RespondQueryTaskCompletedRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | RespondQueryTaskCompletedRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): RespondQueryTaskCompletedRequest
Creates a RespondQueryTaskCompletedRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
RespondQueryTaskCompletedRequest
RespondQueryTaskCompletedRequest
toObject
▸ toObject(message, options?): Object
Creates a plain object from a RespondQueryTaskCompletedRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | RespondQueryTaskCompletedRequest | RespondQueryTaskCompletedRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object