Interface Management.QueueSpecification

Enclosing interface:

Management

public static interface Management.QueueSpecification

Specification to create a queue.

See Also:

• Queues

Method Summary

Modifier and Type	Method	Description
Management.QueueSpecification	argument(String key, Object value)	Set a queue argument.
Management.QueueSpecification	arguments(Map<String,Object> arguments)	Set the queue arguments.
Management.QueueSpecification	autoDelete(boolean autoDelete)	Whether the queue get automatically deleted when its last consumer unsubscribes.
Management.ClassicQueueSpecification	classic()	Set the type to Management.QueueType.CLASSIC and return classic-queue-specific specification.
Management.QueueSpecification	deadLetterExchange(String dlx)	The dead letter exchange.
Management.QueueSpecification	deadLetterRoutingKey(String dlrk)	The dead letter routing key.
Management.QueueInfo	declare()	Declare the queue.
Management.QueueSpecification	exclusive(boolean exclusive)	Whether the queue is exclusive or not.
Management.QueueSpecification	expires(Duration expiration)	Set TTL for a queue.
Management.QueueSpecification	leaderLocator(Management.QueueLeaderLocator locator)	Leader-locator strategy (replica placement) for the queue.
Management.QueueSpecification	maxLength(long maxLength)	Maximum length for a queue.
Management.QueueSpecification	maxLengthBytes(ByteCapacity maxLengthBytes)	Maximum length in bytes for a queue.
Management.QueueSpecification	messageTtl(Duration ttl)	Set the message TTL for the queue.
Management.QueueSpecification	name(String name)	The name of the queue.
Management.QueueSpecification	overflowStrategy(Management.OverflowStrategy overflow)	The overflow strategy.
Management.QueueSpecification	overflowStrategy(String overflow)	The overflow strategy (as a string).
Management.QuorumQueueSpecification	quorum()	Set the type to Management.QueueType.QUORUM and return quorum-queue-specific specification.
Management.QueueSpecification	singleActiveConsumer(boolean singleActiveConsumer)	Activate "single active consumer" on the queue.
Management.StreamSpecification	stream()	Set the type to Management.QueueType.STREAM and return stream-specific specification.
Management.QueueSpecification	type(Management.QueueType type)	The type of the queue.

Method Details

name

Management.QueueSpecification name(String name)

The name of the queue.

The library will generate a random name if no name is specified.

Parameters:

name - name

Returns:

the queue specification

exclusive

Management.QueueSpecification exclusive(boolean exclusive)

Whether the queue is exclusive or not.

Parameters:

exclusive - exclusive flag

Returns:

the queue specification

See Also:

• Queue Properties

autoDelete

Management.QueueSpecification autoDelete(boolean autoDelete)

Whether the queue get automatically deleted when its last consumer unsubscribes.

Parameters:

autoDelete - auto-delete flag

Returns:

the queue specification

See Also:

• Queue Properties

type

Management.QueueSpecification type(Management.QueueType type)

The type of the queue.

Parameters:

type - queue type

Returns:

the queue specification

See Also:

• Queue Arguments

deadLetterExchange

Management.QueueSpecification deadLetterExchange(String dlx)

The dead letter exchange.

Parameters:

dlx - dead letter exchange

Returns:

the queue specification

See Also:

• Dead Letter Exchange

deadLetterRoutingKey

Management.QueueSpecification deadLetterRoutingKey(String dlrk)

The dead letter routing key.

Parameters:

dlrk - dead letter exchange

Returns:

the queue specification

See Also:

• Dead Letter Exchange

overflowStrategy

Management.QueueSpecification overflowStrategy(String overflow)

The overflow strategy (as a string).

Parameters:

overflow - the overflow strategy

Returns:

the queue specification

See Also:

• TTL and Length Limit

overflowStrategy

Management.QueueSpecification overflowStrategy(Management.OverflowStrategy overflow)

The overflow strategy.

Parameters:

overflow - overflow strategy

Returns:

the queue specification

See Also:

• TTL and Length Limit
• Overflow Behavior

expires

Management.QueueSpecification expires(Duration expiration)

Set TTL for a queue.

Parameters:

expiration - expiration

Returns:

the queue specification

See Also:

• Queue TTL

maxLength

Management.QueueSpecification maxLength(long maxLength)

Maximum length for a queue.

Parameters:

maxLength - maximum length

Returns:

the queue specification

See Also:

• Queue Length Limit

maxLengthBytes

Management.QueueSpecification maxLengthBytes(ByteCapacity maxLengthBytes)

Maximum length in bytes for a queue.

Parameters:

maxLengthBytes - maximum length in bytes

Returns:

the queue specification

See Also:

• Queue Length Limit

singleActiveConsumer

Management.QueueSpecification singleActiveConsumer(boolean singleActiveConsumer)

Activate "single active consumer" on the queue.

Parameters:

singleActiveConsumer - activation flag

Returns:

the queue specification

See Also:

• Single Active Consumer

messageTtl

Management.QueueSpecification messageTtl(Duration ttl)

Set the message TTL for the queue.

Parameters:

ttl - message TTL

Returns:

the queue specification

See Also:

• Message TTL for Queues

leaderLocator

Management.QueueSpecification leaderLocator(Management.QueueLeaderLocator locator)

Leader-locator strategy (replica placement) for the queue.

Parameters:

locator - locator strategy

Returns:

the queue specification

See Also:

• Replica Placement

quorum

Management.QuorumQueueSpecification quorum()

Set the type to Management.QueueType.QUORUM and return quorum-queue-specific specification.

Returns:

quorum queue specification

See Also:

• Quorum Queues

classic

Management.ClassicQueueSpecification classic()

Set the type to Management.QueueType.CLASSIC and return classic-queue-specific specification.

Returns:

classic queue specification

See Also:

• Classic Queues

stream

Management.StreamSpecification stream()

Set the type to Management.QueueType.STREAM and return stream-specific specification.

Returns:

stream specification

See Also:

• Streams

argument

Management.QueueSpecification argument(String key,
 Object value)

Set a queue argument.

Parameters:

key - argument name

value - argument value

Returns:

the queue specification

See Also:

• Queue Arguments

arguments

Management.QueueSpecification arguments(Map<String,Object> arguments)

Set the queue arguments.

The argument map will replace any existing arguments.

Parameters:

arguments - arguments

Returns:

the queue specification

declare

Management.QueueInfo declare()

Declare the queue.

Returns:

information on the queue