Cloudflare::API::Queues

NAME

Cloudflare::API::Queues - manage queues and their consumers

SYNOPSIS

my $queues=$api->queues()->list_queues();
my $consumers=$api->queues()->list_consumers($queue_id);

DESCRIPTION

These methods use the account ID configured on Cloudflare::API. They manage queue resources and consumers, including Worker consumers; they do not push or pull messages.

METHODS

list_queues(%query) — List every queue using named query filters and return one flat array reference. Cloudflare currently returns this endpoint in one response.
list_queues_page(%query) — Return a lazy HTTP::API::Core::Pagination object. It currently completes after Cloudflare's single response.
list_queues_page_response(%query) — Make one list request and return the complete decoded Cloudflare response hash.
get_queue($id, %options) — Retrieve a queue by ID and return its result.
create_queue(\%body, %options) — POST a queue definition, normally including queue_name, and return its result.
update_queue($id, \%body, %options) — PATCH a queue and return its result.
delete_queue($id, %options) — DELETE a queue and return the endpoint's result, possibly undef for an empty body.
list_consumers($queue_id, %query) — List every consumer for one queue using named query filters and return one flat array reference. Cloudflare currently returns this endpoint in one response.
list_consumers_page($queue_id, %query) — Return a lazy HTTP::API::Core::Pagination object. It currently completes after Cloudflare's single response.
list_consumers_page_response($queue_id, %query) — Make one list request and return the complete decoded Cloudflare response hash.
create_consumer($queue_id, \%body, %options) — POST a consumer definition and return its result.
delete_consumer($queue_id, $consumer_id, %options) — DELETE a consumer and return the endpoint's result, possibly undef for an empty body.

Non-list JSON methods accept full_response => 1. IDs are percent-encoded. Create and update bodies must be hash references.

ERRORS

Missing account context, invalid IDs or bodies, HTTP and transport failures, and Cloudflare response failures cause exceptions as described in Cloudflare::API.

AUTHOR

Andrew Speer andrew.speer@isolutions.com.au