Skip to main content

Interface: IRespondQueryTaskCompletedRequest

workflowservice.v1.IRespondQueryTaskCompletedRequest

Properties of a RespondQueryTaskCompletedRequest.

Implemented by

Properties

completedType

Optional completedType: null | QueryResultType

RespondQueryTaskCompletedRequest completedType


errorMessage

Optional errorMessage: null | 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 | 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 query_result. Set when the query fails.


namespace

Optional namespace: null | string

RespondQueryTaskCompletedRequest namespace


queryResult

Optional queryResult: null | IPayloads

The result of the query. Mutually exclusive with error_message and failure. Set when the query succeeds.


taskToken

Optional taskToken: null | Uint8Array

RespondQueryTaskCompletedRequest taskToken