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] [arguments]
- --address
temporal address
Definition for the address command option.
Learn more - --codec-auth
temporal codec-auth
Definition for the codec-auth command option.
Learn more - --codec-endpoint
temporal codec-endpoint
Definition for the codec-endpoint command option.
Learn more - --color
temporal color
Definition for the color command option.
Learn more - --context-timeout
temporal context-timeout
Definition for the context-timeout command option.
Learn more - --env
temporal env
Definition for the env command option.
Learn more - --fields
temporal fields
Definition for the fields command option.
Learn more - --grpc-meta
temporal grpc-meta
Definition for the grpc-meta command option.
Learn more - --namespace
temporal namespace
Definition for the namespace command option.
Learn more - --output
temporal output
Definition for the output command option.
Learn more - --task-queue
temporal task-queue
Definition for the task-queue command option.
Learn more - --task-queue-type
temporal task-queue-type
Definition for the task-queue-type command option.
Learn more - --time-format
temporal time-format
Definition for the time-format command option.
Learn more - --tls-ca-path
temporal tls-ca-path
Definition for the tls-ca-path command option.
Learn more - --tls-cert-path
temporal tls-cert-path
Definition for the tls-cert-path command option.
Learn more - --tls-disable-host-verification
temporal tls-disable-host-verification
Definition for the tls-disable-host-verification command option.
Learn more - --tls-key-path
temporal tls-key-path
Definition for the tls-key-path command option.
Learn more - --tls-server-name
temporal tls-server-name
Definition for the tls-server-name command option.
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] [arguments]
- --address
temporal address
Definition for the address command option.
Learn more - --codec-auth
temporal codec-auth
Definition for the codec-auth command option.
Learn more - --codec-endpoint
temporal codec-endpoint
Definition for the codec-endpoint command option.
Learn more - --color
temporal color
Definition for the color command option.
Learn more - --context-timeout
temporal context-timeout
Definition for the context-timeout command option.
Learn more - --env
temporal env
Definition for the env command option.
Learn more - --grpc-meta
temporal grpc-meta
Definition for the grpc-meta command option.
Learn more - --namespace
temporal namespace
Definition for the namespace command option.
Learn more - --output
temporal output
Definition for the output command option.
Learn more - --task-queue
temporal task-queue
Definition for the task-queue command option.
Learn more - --tls-ca-path
temporal tls-ca-path
Definition for the tls-ca-path command option.
Learn more - --tls-cert-path
temporal tls-cert-path
Definition for the tls-cert-path command option.
Learn more - --tls-disable-host-verification
temporal tls-disable-host-verification
Definition for the tls-disable-host-verification command option.
Learn more - --tls-key-path
temporal tls-key-path
Definition for the tls-key-path command option.
Learn more - --tls-server-name
temporal tls-server-name
Definition for the tls-server-name command option.
Learn more