com.azure.messaging.servicebus.models

Enum SubQueue

java.lang.Object

java.lang.Enum<SubQueue>

com.azure.messaging.servicebus.models.SubQueue

All Implemented Interfaces:

Serializable, Comparable<SubQueue>

public enum SubQueue
extends Enum<SubQueue>

Azure Service Bus queues and subscriptions provide a secondary sub-queue, called a dead-letter queue (DLQ). The dead-letter queue doesn't need to be explicitly created and can't be deleted or otherwise managed independent of the main entity.

See Also:

ServiceBusClientBuilder.ServiceBusReceiverClientBuilder.subQueue(SubQueue), Dead-letter Queues

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEAD_LETTER_QUEUE Connect to a queue or subscription's dead-letter queue.
NONE Connect to the default entity (directly to the queue or subscription)
TRANSFER_DEAD_LETTER_QUEUE Connect to a queue or subscription's transfer dead-letter queue.

Method Summary

Modifier and Type	Method and Description
static SubQueue	valueOf(String name) Returns the enum constant of this type with the specified name.
static SubQueue[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final SubQueue NONE

Connect to the default entity (directly to the queue or subscription)

DEAD_LETTER_QUEUE

public static final SubQueue DEAD_LETTER_QUEUE

Connect to a queue or subscription's dead-letter queue. This is builder for creating ServiceBusReceiverClient and ServiceBusReceiverAsyncClient to consume dead-letter messages from Service Bus entity.

TRANSFER_DEAD_LETTER_QUEUE

public static final SubQueue TRANSFER_DEAD_LETTER_QUEUE

Connect to a queue or subscription's transfer dead-letter queue. This is builder for creating ServiceBusReceiverClient and ServiceBusReceiverAsyncClient to consume transfer dead-letter messages from Service Bus entity.

Method Detail

values

public static SubQueue[] values()

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SubQueue valueOf(String name)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null