package asynq

Get desktop application:
View/edit binary Protocol Buffers messages

SchedulerEnqueueEvent holds information about an enqueue event by a scheduler.

• string task_id = 1

  ID of the task that was enqueued.

• optional google.protobuf.Timestamp enqueue_time = 2

  Time the task was enqueued.

SchedulerEntry holds information about a periodic task registered with a scheduler.

• string id = 1

  Identifier of the scheduler entry.

• string spec = 2

  Periodic schedule spec of the entry.

• string task_type = 3

  Task type of the periodic task.

• bytes task_payload = 4

  Task payload of the periodic task.

• repeated string enqueue_options = 5

  Options used to enqueue the periodic task.

• optional google.protobuf.Timestamp next_enqueue_time = 6

  Next time the task will be enqueued.

• optional google.protobuf.Timestamp prev_enqueue_time = 7

  Last time the task was enqueued. Zero time if task was never enqueued.

ServerInfo holds information about a running server.

• string host = 1

  Host machine the server is running on.

• int32 pid = 2

  PID of the server process.

• string server_id = 3

  Unique identifier for this server.

• int32 concurrency = 4

  Maximum number of concurrency this server will use.

• map<string, int32> queues = 5

  List of queue names with their priorities. The server will consume tasks from the queues and prioritize queues with higher priority numbers.

• bool strict_priority = 6

  If set, the server will always consume tasks from a queue with higher priority.

• string status = 7

  Status indicates the status of the server.

• optional google.protobuf.Timestamp start_time = 8

  Time this server was started.

• int32 active_worker_count = 9

  Number of workers currently processing tasks.

TaskMessage is the internal representation of a task with additional metadata fields. Next ID: 15

• string type = 1

  Type indicates the kind of the task to be performed.

• bytes payload = 2

  Payload holds data needed to process the task.

• string id = 3

  Unique identifier for the task.

• string queue = 4

  Name of the queue to which this task belongs.

• int32 retry = 5

  Max number of retries for this task.

• int32 retried = 6

  Number of times this task has been retried so far.

• string error_msg = 7

  Error message from the last failure.

• int64 last_failed_at = 11

  Time of last failure in Unix time, the number of seconds elapsed since January 1, 1970 UTC. Use zero to indicate no last failure.

• int64 timeout = 8

  Timeout specifies timeout in seconds. Use zero to indicate no timeout.

• int64 deadline = 9

  Deadline specifies the deadline for the task in Unix time, the number of seconds elapsed since January 1, 1970 UTC. Use zero to indicate no deadline.

• string unique_key = 10

  UniqueKey holds the redis key used for uniqueness lock for this task. Empty string indicates that no uniqueness lock was used.

• string group_key = 14

  GroupKey is a name of the group used for task aggregation. This field is optional and empty value means no aggregation for the task.

• int64 retention = 12

  Retention period specified in a number of seconds. The task will be stored in redis as a completed task until the TTL expires.

• int64 completed_at = 13

  Time when the task completed in success in Unix time, the number of seconds elapsed since January 1, 1970 UTC. This field is populated if result_ttl > 0 upon completion.

WorkerInfo holds information about a running worker.

• string host = 1

  Host matchine this worker is running on.

• int32 pid = 2

  PID of the process in which this worker is running.

• string server_id = 3

  ID of the server in which this worker is running.

• string task_id = 4

  ID of the task this worker is processing.

• string task_type = 5

  Type of the task this worker is processing.

• bytes task_payload = 6

  Payload of the task this worker is processing.

• string queue = 7

  Name of the queue the task the worker is processing belongs.

• optional google.protobuf.Timestamp start_time = 8

  Time this worker started processing the task.

• optional google.protobuf.Timestamp deadline = 9

  Deadline by which the worker needs to complete processing the task. If worker exceeds the deadline, the task will fail.