Skip to content

Commit

Permalink
Fix, regen docs for queue arguments
Browse files Browse the repository at this point in the history
  • Loading branch information
calini committed Jan 27, 2025
1 parent f6dae12 commit 80e74c5
Show file tree
Hide file tree
Showing 2 changed files with 93 additions and 11 deletions.
50 changes: 50 additions & 0 deletions docs/modules/components/pages/inputs/amqp_0_9.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,54 @@ Whether the declared queue will auto-delete.
Optional arguments specific to the server's implementation of the queue that can be sent for queue types which require extra parameters.
== Arguments
- x-queue-type
Is used to declare quorum and stream queues. Accepted values are: 'classic' (default), 'quorum', 'stream', 'drop-head', 'reject-publish' and 'reject-publish-dlx'.
- x-max-length
Maximum number of messages, is a non-negative integer value.
- x-max-length-bytes
Maximum number of messages, is a non-negative integer value.
- x-overflow
Sets overflow behaviour. Possible values are: 'drop-head' (default), 'reject-publish', 'reject-publish-dlx'.
- x-message-ttl
TTL period in milliseconds. Must be a string representation of the number.
- x-expires
Expiration policy, describes the expiration period in milliseconds. Must be a positive integer.
- x-max-age
Controls the retention of a stream. Must be a strin, valid units: (Y, M, D, h, m, s) e.g. '7D' for a week.
- x-stream-max-segment-size-bytes
Controls the size of the segment files on disk (default 500000000). Must be a positive integer.
- x-queue-version
declares the Classic Queue version to use. Expects an integer, either 1 or 2.
- x-consumer-timeout
Integer specified in milliseconds.
- x-single-active-consumer
Enables Single Active Consumer, Expects a Boolean.
See https://github.com/rabbitmq/amqp091-go/blob/b3d409fe92c34bea04d8123a136384c85e8dc431/types.go#L282-L362 for more information on available arguments.
*Type*: `object`
Expand All @@ -185,6 +233,8 @@ Optional arguments specific to the server's implementation of the queue that can
# Examples
arguments:
x-max-length: 1000
x-max-length-bytes: 4096
x-queue-type: quorum
```
Expand Down
54 changes: 43 additions & 11 deletions internal/impl/amqp09/input.go
Original file line number Diff line number Diff line change
Expand Up @@ -87,17 +87,49 @@ Optional arguments specific to the server's implementation of the queue that can
== Arguments
- "x-queue-type" - Is used to declare quorum and stream queues. Accepted values are: 'classic' (default), 'quorum', 'stream', 'drop-head', 'reject-publish' and 'reject-publish-dlx'.
- "x-max-length" - Maximum number of messages, is a non-negative integer value.
- "x-max-length-bytes" - Maximum number of messages, is a non-negative integer value.
- "x-overflow" - Sets overflow behaviour. Possible values are: 'drop-head' (default), 'reject-publish', 'reject-publish-dlx'.
- "x-message-ttl" - TTL period in milliseconds. Must be a string representation of the number.
- "x-expires" - Expiration policy, describes the expiration period in milliseconds. Must be a positive integer.
- "x-max-age" - Controls the retention of a stream. Must be a strin, valid units: (Y, M, D, h, m, s) e.g. '7D' for a week.
- "x-stream-max-segment-size-bytes" - Controls the size of the segment files on disk (default 500000000). Must be a positive integer.
- "x-queue-version" - declares the Classic Queue version to use. Expects an integer, either 1 or 2.
- "x-consumer-timeout" - Integer specified in milliseconds.
- "x-single-active-consumer" - Enables Single Active Consumer, Expects a Boolean.
- x-queue-type
Is used to declare quorum and stream queues. Accepted values are: 'classic' (default), 'quorum', 'stream', 'drop-head', 'reject-publish' and 'reject-publish-dlx'.
- x-max-length
Maximum number of messages, is a non-negative integer value.
- x-max-length-bytes
Maximum number of messages, is a non-negative integer value.
- x-overflow
Sets overflow behaviour. Possible values are: 'drop-head' (default), 'reject-publish', 'reject-publish-dlx'.
- x-message-ttl
TTL period in milliseconds. Must be a string representation of the number.
- x-expires
Expiration policy, describes the expiration period in milliseconds. Must be a positive integer.
- x-max-age
Controls the retention of a stream. Must be a strin, valid units: (Y, M, D, h, m, s) e.g. '7D' for a week.
- x-stream-max-segment-size-bytes
Controls the size of the segment files on disk (default 500000000). Must be a positive integer.
- x-queue-version
declares the Classic Queue version to use. Expects an integer, either 1 or 2.
- x-consumer-timeout
Integer specified in milliseconds.
- x-single-active-consumer
Enables Single Active Consumer, Expects a Boolean.
See https://github.com/rabbitmq/amqp091-go/blob/b3d409fe92c34bea04d8123a136384c85e8dc431/types.go#L282-L362 for more information on available arguments.`).
Advanced().
Expand Down

0 comments on commit 80e74c5

Please sign in to comment.