Temporal Query
CertifiedQuery a running Temporal workflow
Temporal Query
Query a running Temporal workflow
Sends a named query to a workflow and returns the result as a JSON string. The task fails if the workflow is not found or the query handler returns an error.
type: io.kestra.plugin.temporal.workflow.QueryExamples
Query the current status of an order workflow.
id: query_order_status
namespace: company.team
tasks:
- id: query
type: io.kestra.plugin.temporal.workflow.Query
endpoint: "localhost:7233"
workflowId: "order-{{ inputs.orderId }}"
queryType: "getStatus"
Properties
endpoint *string
Temporal server endpoint
Host and port of the Temporal frontend service in host: port format.
For Temporal Cloud, use the gRPC endpoint for your namespace,
e.g. <namespace>.tmprl.cloud: 7233.
queryType *string
Query type name
Must match a registered @QueryMethod on the workflow.
workflowId *string
Workflow ID
The ID of the workflow execution to query.
apiKey string
API key for Bearer token authentication
Used with Temporal Cloud. Sent as Authorization: Bearer <apiKey> on every
gRPC call; TLS is enabled automatically when this property is set.
Mutually exclusive with mTLS properties.
args array
Query arguments
List of JSON-encoded argument strings, one per query parameter.
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150caCert string
PEM-encoded CA certificate
Verifies the server certificate. Can be used alone for one-way TLS
with a custom CA, or together with clientCert/clientKey for mTLS.
clientCert string
PEM-encoded client certificate
Used in mTLS mode. Must be provided together with clientKey.
clientKey string
PEM-encoded client private key
Used in mTLS mode. Must be provided together with clientCert.
namespace string
Temporal namespace
Defaults to default. For Temporal Cloud, typically <namespace>.<accountId>.
runId string
Run ID
Optional. When omitted, targets the latest open run of the given workflow ID.
Outputs
result string
Query result
JSON-encoded result returned by the workflow query handler.
