API Reference Zizq v#0.6.0

Copy Markdown View Source

Modules

Official Elixir client for the Zizq job queue.

Per-job retry backoff policy.

Batching configuration: fold an enqueue into an existing :ready job rather than creating a new one.

Serialization format used for request and response bodies.

JSON codec, built on Elixir's JSON module (OTP's :json underneath).

MessagePack codec, built on Msgpax. The default.

Validated configuration for a running Zizq client.

A named group of scheduled jobs.

One scheduled job within a cron group.

Job inputs to be enqueued.

The error returned by every Zizq function.

One page of a job's failed attempts, and where the next one is.

What a worker reported when an attempt at a job failed.

Filters shared by every endpoint that selects jobs.

A job record from the server.

Defines a kind of job: its name on the server, the enqueue options it defaults to, and what running it does.

One page of a job listing, and where the next one is.

Derives a stable key from a job's payload.

A composable job query that handles pagination internally.

How long a job stays on the server after reaching a terminal state.

Dispatches jobs to the module that defines them, by type.

Raised when a job's type matches no registered route.

A long-lived connection to /jobs/take, delivering jobs to an owner process as they arrive.

The :telemetry events this client emits.

Assert on what your code enqueued, and run job handlers directly, without a server.

Takes jobs from a queue and runs them.

Acknowledges completed work, batching successes into single requests.