Interface: IRespondQueryTaskCompletedRequest
Properties of a RespondQueryTaskCompletedRequest.
Extends
Properties
cause?
optionalcause?:WorkflowTaskFailedCause|null
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.
Inherited from
completedType?
optionalcompletedType?:QueryResultType|null
RespondQueryTaskCompletedRequest completedType
Inherited from
errorMessage?
optionalerrorMessage?:string|null
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.
Inherited from
failure?
optionalfailure?:$Properties|null
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.
Inherited from
namespace?
optionalnamespace?:string|null
RespondQueryTaskCompletedRequest namespace
Inherited from
pollerGroupId?
optionalpollerGroupId?:string|null
Client must forward the poller_group_id received in PollWorkflowTaskQueueResponse for proper routing of the response.
Inherited from
queryResult?
optionalqueryResult?:$Properties|null
The result of the query.
Mutually exclusive with error_message and failure. Set when the query succeeds.
Inherited from
taskToken?
optionaltaskToken?:Uint8Array<ArrayBufferLike> |null
RespondQueryTaskCompletedRequest taskToken