QueueDescription Class

Package:

com.microsoft.azure.servicebus.management

Maven Artifact:

com.microsoft.azure:azure-servicebus:3.6.7

• java.lang.Object
• • com.microsoft.azure.servicebus.management.UnknownPropertiesHolder
  • • com.microsoft.azure.servicebus.management.QueueDescription

public class QueueDescription
extends com.microsoft.azure.servicebus.management.UnknownPropertiesHolder

Represents the metadata description of the queue.

Constructor Summary

Constructor	Description
QueueDescription(String path)	Initializes a new instance of QueueDescription with the specified relative path.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
List<AuthorizationRule>	getAuthorizationRules()
Duration	getAutoDeleteOnIdle()
Duration	getDefaultMessageTimeToLive() Time-To-Live is the duration after which the message expires, starting from when the message is sent to Service Bus.
Duration	getDuplicationDetectionHistoryTimeWindow()
EntityStatus	getEntityStatus() Gets the status of the entity.
String	getForwardDeadLetteredMessagesTo()
String	getForwardTo()
Duration	getLockDuration() The amount of time that the message is locked by a given receiver so that no other receiver receives the same message.
int	getMaxDeliveryCount() The maximum delivery count of a message before it is dead-lettered.
long	getMaxSizeInMB()
String	getPath()
String	getUserMetadata()
int	hashCode()
boolean	isEnableBatchedOperations()
boolean	isEnableDeadLetteringOnMessageExpiration() Indicates whether this queue has dead letter support when a message expires.
boolean	isEnablePartitioning()
boolean	isRequiresDuplicateDetection() If enabled, duplicate messages having same getMessageId() and sent to queue within duration of #getDuplicationDetectionHistoryTimeWindow will be discarded.
boolean	isRequiresSession()
void	setAuthorizationRules(List<AuthorizationRule> authorizationRules)
void	setAutoDeleteOnIdle(Duration autoDeleteOnIdle)
void	setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
void	setDuplicationDetectionHistoryTimeWindow(Duration duplicationDetectionHistoryTimeWindow)
void	setEnableBatchedOperations(boolean enableBatchedOperations)
void	setEnableDeadLetteringOnMessageExpiration(boolean enableDeadLetteringOnMessageExpiration)
void	setEnablePartitioning(boolean enablePartitioning)
void	setEntityStatus(EntityStatus status)
void	setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)
void	setForwardTo(String forwardTo)
void	setLockDuration(Duration lockDuration) Sets The amount of time that the message is locked by a given receiver so that no other receiver receives the same message.
void	setMaxDeliveryCount(int maxDeliveryCount) The maximum delivery count of a message before it is dead-lettered.
void	setMaxSizeInMB(long maxSize)
void	setRequiresDuplicateDetection(boolean requiresDuplicateDetection)
void	setRequiresSession(boolean requiresSession)
void	setUserMetadata(String userMetadata)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

QueueDescription

public QueueDescription(String path)

Initializes a new instance of QueueDescription with the specified relative path.

Parameters:

path -

• Path of the topic. Max length is 260 chars. Cannot start or end with a slash. Cannot have restricted characters: '@','?','#','*'

Method Details

equals

public boolean equals(Object o)

Overrides:

QueueDescription.equals(Object o)

Parameters:

o

getAuthorizationRules

public List getAuthorizationRules()

Returns:

The AuthorizationRule on the queue to control user access at entity level.

getAutoDeleteOnIdle

public Duration getAutoDeleteOnIdle()

Returns:

The idle interval after which the queue is automatically deleted. Default value is MAX_DURATION

getDefaultMessageTimeToLive

public Duration getDefaultMessageTimeToLive()

Time-To-Live is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when getTimeToLive() is not set on a message itself. Messages older than their TimeToLive value will expire and no longer be retained in the message store. Subscribers will be unable to receive expired messages.

Returns:

The default time to live value for the messages. Default value is MAX_DURATION

getDuplicationDetectionHistoryTimeWindow

public Duration getDuplicationDetectionHistoryTimeWindow()

Returns:

The duration of duplicate detection history that is maintained by the service. The default value is 1 minute.

getEntityStatus

public EntityStatus getEntityStatus()

Gets the status of the entity. When an entity is disabled, that entity cannot send or receive messages.

Returns:

The current status of the queue (Enabled / Disabled). The default value is Enabled.

getForwardDeadLetteredMessagesTo

public String getForwardDeadLetteredMessagesTo()

Returns:

The path of the recipient entity to which all the dead-lettered messages of this queue are forwarded to. If set, user cannot manually receive dead-lettered messages from this queue. The destination entity must already exist.

getForwardTo

public String getForwardTo()

Returns:

The path of the recipient entity to which all the messages sent to the queue are forwarded to. If set, user cannot manually receive messages from this queue. The destination entity must be an already existing entity.

getLockDuration

public Duration getLockDuration()

The amount of time that the message is locked by a given receiver so that no other receiver receives the same message.

Returns:

The duration of a peek lock. Default value is 60 seconds.

getMaxDeliveryCount

public int getMaxDeliveryCount()

The maximum delivery count of a message before it is dead-lettered. The delivery count is increased when a message is received in PEEKLOCK mode and didn't complete the message before the message lock expired.

Returns:

Default value is 10.

getMaxSizeInMB

public long getMaxSizeInMB()

Returns:

the maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default value is 1024.

getPath

public String getPath()

Returns:

The path of the queue.

getUserMetadata

public String getUserMetadata()

Returns:

Custom metdata that user can associate with the description.

hashCode

public int hashCode()

Overrides:

QueueDescription.hashCode()

isEnableBatchedOperations

public boolean isEnableBatchedOperations()

Returns:

Indicates whether server-side batched operations are enabled. Defaults to true.

isEnableDeadLetteringOnMessageExpiration

public boolean isEnableDeadLetteringOnMessageExpiration()

Indicates whether this queue has dead letter support when a message expires.

Returns:

If true, the expired messages are moved to dead-letter sub-queue. Default value is false.

isEnablePartitioning

public boolean isEnablePartitioning()

Returns:

boolean indicating whether the queue is to be partitioned across multiple message brokers. Defaults to false

isRequiresDuplicateDetection

public boolean isRequiresDuplicateDetection()

If enabled, duplicate messages having same getMessageId() and sent to queue within duration of #getDuplicationDetectionHistoryTimeWindow will be discarded.

Returns:

value indicating if the queue requires guard against duplicate messages.

isRequiresSession

public boolean isRequiresSession()

Returns:

boolean that indicates whether the queue supports the concept of session. Sessionful-messages follow FIFO ordering.

setAuthorizationRules

public void setAuthorizationRules(List authorizationRules)

Parameters:

authorizationRules -

• The AuthorizationRule on the queue to control user access at entity level.

setAutoDeleteOnIdle

public void setAutoDeleteOnIdle(Duration autoDeleteOnIdle)

Parameters:

autoDeleteOnIdle -

• The idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.

setDefaultMessageTimeToLive

public void setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)

Parameters:

defaultMessageTimeToLive -

• The default message time to live value. Value cannot be lower than 1 second. See getDefaultMessageTimeToLive()

setDuplicationDetectionHistoryTimeWindow

public void setDuplicationDetectionHistoryTimeWindow(Duration duplicationDetectionHistoryTimeWindow)

Parameters:

duplicationDetectionHistoryTimeWindow -

• The duration of duplicate detection history that is maintained by the service. Max value is 1 day and minimum is 20 seconds.

setEnableBatchedOperations

public void setEnableBatchedOperations(boolean enableBatchedOperations)

Parameters:

enableBatchedOperations -

• Indicates whether server-side batched operations are enabled.

setEnableDeadLetteringOnMessageExpiration

public void setEnableDeadLetteringOnMessageExpiration(boolean enableDeadLetteringOnMessageExpiration)

Parameters:

enableDeadLetteringOnMessageExpiration -

• True if messages should be dead-lettered on expiration. See isEnableDeadLetteringOnMessageExpiration()

setEnablePartitioning

public void setEnablePartitioning(boolean enablePartitioning)

Parameters:

enablePartitioning -

• true if queue is to be partitioned across multiple message brokers.

setEntityStatus

public void setEntityStatus(EntityStatus status)

Parameters:

status -

• the status of the queue (Enabled / Disabled). When an entity is disabled, that entity cannot send or receive messages.

setForwardDeadLetteredMessagesTo

public void setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)

Parameters:

forwardDeadLetteredMessagesTo -

• The path of the recipient entity to which all the dead-lettered messages of this queue are forwarded to. If set, user cannot manually receive dead-lettered messages from this queue. The destination entity must already exist.

setForwardTo

public void setForwardTo(String forwardTo)

Parameters:

forwardTo -

• The path of the recipient entity to which all the messages sent to the queue are forwarded to. If set, user cannot manually receive messages from this queue. The destination entity must be an already existing entity.

setLockDuration

public void setLockDuration(Duration lockDuration)

Sets The amount of time that the message is locked by a given receiver so that no other receiver receives the same message.

Parameters:

lockDuration -

• The duration of a peek lock. Max value is 5 minutes.

setMaxDeliveryCount

public void setMaxDeliveryCount(int maxDeliveryCount)

The maximum delivery count of a message before it is dead-lettered. The delivery count is increased when a message is received in PEEKLOCK mode and didn't complete the message before the message lock expired.

Parameters:

maxDeliveryCount -

• Minimum value is 1.

setMaxSizeInMB

public void setMaxSizeInMB(long maxSize)

Parameters:

maxSize -

• Maximum size of the queue in megabytes, which is the size of memory allocated for the queue.

setRequiresDuplicateDetection

public void setRequiresDuplicateDetection(boolean requiresDuplicateDetection)

Parameters:

requiresDuplicateDetection -

• True if duplicate detection needs to be enabled. See also - isRequiresDuplicateDetection()

setRequiresSession

public void setRequiresSession(boolean requiresSession)

Parameters:

requiresSession -

• True if queue should support sessions.

setUserMetadata

public void setUserMetadata(String userMetadata)

Parameters:

userMetadata -

• Custom metdata that user can associate with the description. Cannot be null. Max length is 1024 chars