consumers

Creates, updates, deletes, gets or lists a consumers resource.

Overview

Name	consumers
Type	Resource
Id	cloudflare.queues.consumers

Fields

The following fields are returned by SELECT queries:

get

Get Queue Consumer response.

Name	Datatype	Description
consumer_id	string	A Resource identifier. (example: 023e105f4ecef8ad9ca31a8372d0c353)
queue_name	string	(example: example-queue)
script_name	string	Name of a Worker (example: my-consumer-worker)
created_on	string (date-time)
dead_letter_queue	string	Name of the dead letter queue, or empty string if not configured
settings	object
type	string	(worker)

list

All consumers attached to this Queue

Name	Datatype	Description
consumer_id	string	A Resource identifier. (example: 023e105f4ecef8ad9ca31a8372d0c353)
queue_name	string	(example: example-queue)
script_name	string	Name of a Worker (example: my-consumer-worker)
created_on	string (date-time)
dead_letter_queue	string	Name of the dead letter queue, or empty string if not configured
settings	object
type	string	(worker)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	consumer_id, queue_id, account_id		Fetches the consumer for a queue by consumer id
list	select	queue_id, account_id		Returns the consumers for a Queue
create	insert	queue_id, account_id, type		Creates a new consumer for a Queue
update	replace	consumer_id, queue_id, account_id, type		Updates the consumer for a queue, or creates one if it does not exist.
delete	delete	consumer_id, queue_id, account_id		Deletes the consumer for a queue.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_id	string	The Cloudflare account ID.
consumer_id	string
queue_id	string	The Cloudflare Queue ID.

SELECT examples

get

Fetches the consumer for a queue by consumer id

SELECT
consumer_id,
queue_name,
script_name,
created_on,
dead_letter_queue,
settings,
type
FROM cloudflare.queues.consumers
WHERE consumer_id = '{{ consumer_id }}' -- required
AND queue_id = '{{ queue_id }}' -- required
AND account_id = '{{ account_id }}' -- required
;

list

Returns the consumers for a Queue

SELECT
consumer_id,
queue_name,
script_name,
created_on,
dead_letter_queue,
settings,
type
FROM cloudflare.queues.consumers
WHERE queue_id = '{{ queue_id }}' -- required
AND account_id = '{{ account_id }}' -- required
;

INSERT examples

create

Creates a new consumer for a Queue

INSERT INTO cloudflare.queues.consumers (
dead_letter_queue,
script_name,
settings,
type,
queue_id,
account_id
)
SELECT 
'{{ dead_letter_queue }}',
'{{ script_name }}',
'{{ settings }}',
'{{ type }}' /* required */,
'{{ queue_id }}',
'{{ account_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: consumers
props:
  - name: queue_id
    value: "{{ queue_id }}"
    description: Required parameter for the consumers resource.
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the consumers resource.
  - name: dead_letter_queue
    value: "{{ dead_letter_queue }}"
  - name: script_name
    value: "{{ script_name }}"
    description: |
      Name of a Worker
  - name: settings
    value:
      batch_size: {{ batch_size }}
      max_concurrency: {{ max_concurrency }}
      max_retries: {{ max_retries }}
      max_wait_time_ms: {{ max_wait_time_ms }}
      retry_delay: {{ retry_delay }}
  - name: type
    value: "{{ type }}"
    valid_values: ['worker']

REPLACE examples

update

Updates the consumer for a queue, or creates one if it does not exist.

REPLACE cloudflare.queues.consumers
SET 
dead_letter_queue = '{{ dead_letter_queue }}',
script_name = '{{ script_name }}',
settings = '{{ settings }}',
type = '{{ type }}'
WHERE 
consumer_id = '{{ consumer_id }}' --required
AND queue_id = '{{ queue_id }}' --required
AND account_id = '{{ account_id }}' --required
AND type = '{{ type }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

Deletes the consumer for a queue.

DELETE FROM cloudflare.queues.consumers
WHERE consumer_id = '{{ consumer_id }}' --required
AND queue_id = '{{ queue_id }}' --required
AND account_id = '{{ account_id }}' --required
;