Interface: $Properties

Properties of a RespondQueryTaskCompletedRequest.

Extended by

• IRespondQueryTaskCompletedRequest

Properties

cause?

optional cause?: 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.

---

completedType?

optional completedType?: QueryResultType | null

RespondQueryTaskCompletedRequest completedType

---

errorMessage?

optional errorMessage?: 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.

---

failure?

optional failure?: $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.

---

namespace?

optional namespace?: string | null

RespondQueryTaskCompletedRequest namespace

---

pollerGroupId?

optional pollerGroupId?: string | null

Client must forward the poller_group_id received in PollWorkflowTaskQueueResponse for proper routing of the response.

---

queryResult?

optional queryResult?: $Properties | null

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

---

taskToken?

optional taskToken?: Uint8Array<ArrayBufferLike> | null

RespondQueryTaskCompletedRequest taskToken