Temporal CLI task-queue command reference
Task Queue commands allow operations to be performed on Task QueuesWhat is a Task Queue?
A Task Queue is a first-in, first-out queue that a Worker Process polls for Tasks.
Learn more.
describe
The temporal task-queue describe
command provides poller information for a given Task QueueWhat is a Task Queue?
A Task Queue is a first-in, first-out queue that a Worker Process polls for Tasks.
Learn more.
The ServerWhat is the Temporal Server?
The Temporal Server is a grouping of four horizontally scalable services.
Learn more records the last time of each poll request.
Should LastAccessTime
exceeds one minute, it's likely that the Worker is at capacity (all Workflow and Activity slots are full) or that the Worker has shut down.
In day-to-day conversations, the term Worker is used to denote both a Worker Program and a Worker Process. Temporal documentation aims to be explicit and differentiate between them.
Learn more are removed if 5 minutes have passed since the last poll request.
Use the options listed below to modify what this command returns.
Make sure to write the command as follows:
temporal task-queue describe [command options]
- --address
temporal address
The host and port for the Temporal Frontend Service.
Learn more - --codec-auth
temporal codec-auth
Sets the authorization header on requests to the Codec Server.
Learn more - --codec-endpoint
temporal codec-endpoint
Endpoint for a remote Codec Server.
Learn more - --color
temporal color
When to use color
Learn more - --context-timeout
temporal context-timeout
An optional timeout for the context of an RPC call.
Learn more - --env
temporal env
Name of the environment to read environmental variables from.
Learn more - --fields
temporal fields
Customize fields to print.
Learn more - --grpc-meta
temporal grpc-meta
Contains gRPC metadata to send with requests.
Learn more - --namespace
temporal namespace
Identifies a Namespace in the Temporal Workflow.
Learn more - --output
temporal output
format output as either table, json, card.
Learn more - --task-queue
temporal task-queue
Task Queue
Learn more - --task-queue-type
temporal task-queue-type
Task Queue type [workflow|activity].
Learn more - --time-format
temporal time-format
Format time as either relative, iso, raw.
Learn more - --tls-ca-path
temporal tls-ca-path
Path to server CA certificate.
Learn more - --tls-cert-path
temporal tls-cert-path
Path to x509 certificate.
Learn more - --tls-disable-host-verification
temporal tls-disable-host-verification
Disables TLS host name verification if already enabled.
Learn more - --tls-key-path
temporal tls-key-path
Path to private certificate key.
Learn more - --tls-server-name
temporal tls-server-name
Provides an override for the target TLS server name.
Learn more
list-partition
The temporal task-queue list-partition
command displays the partitions of a Task QueueWhat is a Task Queue?
A Task Queue is a first-in, first-out queue that a Worker Process polls for Tasks.
Learn more, along with the matching node they are assigned to.
Use the options listed below to change the command's behavior.
Make sure to write the command as follows:
temporal task-queue list-partition [command options]
- --address
temporal address
The host and port for the Temporal Frontend Service.
Learn more - --codec-auth
temporal codec-auth
Sets the authorization header on requests to the Codec Server.
Learn more - --codec-endpoint
temporal codec-endpoint
Endpoint for a remote Codec Server.
Learn more - --color
temporal color
When to use color
Learn more - --context-timeout
temporal context-timeout
An optional timeout for the context of an RPC call.
Learn more - --env
temporal env
Name of the environment to read environmental variables from.
Learn more - --grpc-meta
temporal grpc-meta
Contains gRPC metadata to send with requests.
Learn more - --namespace
temporal namespace
Identifies a Namespace in the Temporal Workflow.
Learn more - --output
temporal output
format output as either table, json, card.
Learn more - --task-queue
temporal task-queue
Task Queue
Learn more - --tls-ca-path
temporal tls-ca-path
Path to server CA certificate.
Learn more - --tls-cert-path
temporal tls-cert-path
Path to x509 certificate.
Learn more - --tls-disable-host-verification
temporal tls-disable-host-verification
Disables TLS host name verification if already enabled.
Learn more - --tls-key-path
temporal tls-key-path
Path to private certificate key.
Learn more - --tls-server-name
temporal tls-server-name
Provides an override for the target TLS server name.
Learn more