fn create(queue_name: unknown)
Create Queue
| Argument | Type | Required | Description |
|---|
| queue_name | unknown | yes | |
fn get(queue_id: string)
Get Queue
| Argument | Type | Required | Description |
|---|
| queue_id | string | yes | |
fn update(queue_id: string, consumers?: array, consumers_total_count?: number, created_on?: string, modified_on?: string, producers?: array, producers_total_count?: number, queue_name?: unknown, settings?: unknown)
Update Queue
| Argument | Type | Required | Description |
|---|
| queue_id | string | yes | |
| consumers? | array | no | |
| consumers_total_count? | number | no | |
| created_on? | string | no | |
| modified_on? | string | no | |
| producers? | array | no | |
| producers_total_count? | number | no | |
| queue_name? | unknown | no | |
| settings? | unknown | no | |
fn update_partial(queue_id: string, consumers?: array, consumers_total_count?: number, created_on?: string, modified_on?: string, producers?: array, producers_total_count?: number, queue_name?: unknown, settings?: unknown)
Update Queue
| Argument | Type | Required | Description |
|---|
| queue_id | string | yes | |
| consumers? | array | no | |
| consumers_total_count? | number | no | |
| created_on? | string | no | |
| modified_on? | string | no | |
| producers? | array | no | |
| producers_total_count? | number | no | |
| queue_name? | unknown | no | |
| settings? | unknown | no | |
fn delete(queue_id: string)
Delete Queue
| Argument | Type | Required | Description |
|---|
| queue_id | string | yes | |
fn list_consumers(queue_id: string)
List Queue Consumers
| Argument | Type | Required | Description |
|---|
| queue_id | string | yes | |
fn create_consumer(queue_id: string)
Create a Queue Consumer
| Argument | Type | Required | Description |
|---|
| queue_id | string | yes | |
fn get_consumer(consumer_id: string, queue_id: string)
Get Queue Consumer
| Argument | Type | Required | Description |
|---|
| consumer_id | string | yes | |
| queue_id | string | yes | |
fn update_consumer(consumer_id: string, queue_id: string)
Update Queue Consumer
| Argument | Type | Required | Description |
|---|
| consumer_id | string | yes | |
| queue_id | string | yes | |
fn delete_consumer(consumer_id: string, queue_id: string)
Delete Queue Consumer
| Argument | Type | Required | Description |
|---|
| consumer_id | string | yes | |
| queue_id | string | yes | |
fn create_queues_push_message(queue_id: string, delay_seconds?: number)
Push Message
| Argument | Type | Required | Description |
|---|
| queue_id | string | yes | |
| delay_seconds? | number | no | The number of seconds to wait for attempting to deliver this message to consu... |
fn create_queues_ack_messages(queue_id: string, acks?: array, retries?: array)
Acknowledge + Retry Queue Messages
| Argument | Type | Required | Description |
|---|
| queue_id | string | yes | |
| acks? | array | no | |
| retries? | array | no | |
fn create_queues_push_messages(queue_id: string, delay_seconds?: number, messages?: array)
Push Message Batch
| Argument | Type | Required | Description |
|---|
| queue_id | string | yes | |
| delay_seconds? | number | no | The number of seconds to wait for attempting to deliver this batch to consumers |
| messages? | array | no | |
fn create_queues_preview_messages(queue_id: string, batch_size?: unknown)
Preview Queue Messages
| Argument | Type | Required | Description |
|---|
| queue_id | string | yes | |
| batch_size? | unknown | no | |
fn create_queues_ack_preview_messages(queue_id: string, acks?: array, retries?: array)
Delete Previewed Queue Messages
| Argument | Type | Required | Description |
|---|
| queue_id | string | yes | |
| acks? | array | no | |
| retries? | array | no | |
fn create_queues_pull_messages(queue_id: string, batch_size?: unknown, visibility_timeout_ms?: unknown)
Pull Queue Messages
| Argument | Type | Required | Description |
|---|
| queue_id | string | yes | |
| batch_size? | unknown | no | |
| visibility_timeout_ms? | unknown | no | |
fn get_metrics(queue_id: string)
Get Queue Metrics
| Argument | Type | Required | Description |
|---|
| queue_id | string | yes | |
fn create_queues_purge(queue_id: string, delete_messages_permanently?: boolean)
Purge Queue
| Argument | Type | Required | Description |
|---|
| queue_id | string | yes | |
| delete_messages_permanently? | boolean | no | Confimation that all messages will be deleted permanently. |
Resources
list(infinite)— List Queues
create(infinite)— Create Queue
get(infinite)— Get Queue
update(infinite)— Update Queue
partial(infinite)— Update Queue
consumers(infinite)— List Queue Consumers
consumer(infinite)— Create a Queue Consumer
queues_push_message(infinite)— Push Message
queues_ack_messages(infinite)— Acknowledge + Retry Queue Messages
queues_push_messages(infinite)— Push Message Batch
queues_preview_messages(infinite)— Preview Queue Messages
queues_ack_preview_messages(infinite)— Delete Previewed Queue Messages
queues_pull_messages(infinite)— Pull Queue Messages
metrics(infinite)— Get Queue Metrics
queues_purge(infinite)— Purge Queue