QueueDescription Class
- java.
lang. Object - com.
microsoft. azure. servicebus. management. QueueDescription
- com.
public class QueueDescription
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<Authorization |
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. 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. |
Duration | getDuplicationDetectionHistoryTimeWindow() |
Entity |
getEntityStatus()
Gets the status of the entity. When an entity is disabled, that entity cannot send or receive messages. |
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. The delivery count is increased when a message is received in PEEKLOCK mode and didn't complete the message before the message lock expired. |
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. The delivery count is increased when a message is received in PEEKLOCK mode and didn't complete the message before the message lock expired. |
void | setMaxSizeInMB(long maxSize) |
void | setRequiresDuplicateDetection(boolean requiresDuplicateDetection) |
void | setRequiresSession(boolean requiresSession) |
void | setUserMetadata(String userMetadata) |
Constructor Details
QueueDescription
public QueueDescription(String path)
Initializes a new instance of QueueDescription with the specified relative path.
Parameters:
Method Details
equals
public boolean equals(Object o)
Parameters:
getAuthorizationRules
public List
Returns:
getAutoDeleteOnIdle
public Duration getAutoDeleteOnIdle()
Returns:
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:
getDuplicationDetectionHistoryTimeWindow
public Duration getDuplicationDetectionHistoryTimeWindow()
Returns:
getEntityStatus
public EntityStatus getEntityStatus()
Gets the status of the entity. When an entity is disabled, that entity cannot send or receive messages.
Returns:
getForwardDeadLetteredMessagesTo
public String getForwardDeadLetteredMessagesTo()
Returns:
getForwardTo
public String getForwardTo()
Returns:
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:
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:
getMaxSizeInMB
public long getMaxSizeInMB()
Returns:
getPath
public String getPath()
Returns:
getUserMetadata
public String getUserMetadata()
Returns:
hashCode
public int hashCode()
isEnableBatchedOperations
public boolean isEnableBatchedOperations()
Returns:
isEnableDeadLetteringOnMessageExpiration
public boolean isEnableDeadLetteringOnMessageExpiration()
Indicates whether this queue has dead letter support when a message expires.
Returns:
isEnablePartitioning
public boolean isEnablePartitioning()
Returns:
isRequiresDuplicateDetection
public boolean isRequiresDuplicateDetection()
If enabled, duplicate messages having same getMessageId() and sent to queue within duration of getDuplicationDetectionHistoryTimeWindow() will be discarded.
Returns:
isRequiresSession
public boolean isRequiresSession()
Returns:
setAuthorizationRules
public void setAuthorizationRules(List
Parameters:
setAutoDeleteOnIdle
public void setAutoDeleteOnIdle(Duration autoDeleteOnIdle)
Parameters:
setDefaultMessageTimeToLive
public void setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
Parameters:
setDuplicationDetectionHistoryTimeWindow
public void setDuplicationDetectionHistoryTimeWindow(Duration duplicationDetectionHistoryTimeWindow)
Parameters:
setEnableBatchedOperations
public void setEnableBatchedOperations(boolean enableBatchedOperations)
Parameters:
setEnableDeadLetteringOnMessageExpiration
public void setEnableDeadLetteringOnMessageExpiration(boolean enableDeadLetteringOnMessageExpiration)
Parameters:
setEnablePartitioning
public void setEnablePartitioning(boolean enablePartitioning)
Parameters:
setEntityStatus
public void setEntityStatus(EntityStatus status)
Parameters:
setForwardDeadLetteredMessagesTo
public void setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)
Parameters:
setForwardTo
public void setForwardTo(String forwardTo)
Parameters:
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:
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:
setMaxSizeInMB
public void setMaxSizeInMB(long maxSize)
Parameters:
setRequiresDuplicateDetection
public void setRequiresDuplicateDetection(boolean requiresDuplicateDetection)
Parameters:
setRequiresSession
public void setRequiresSession(boolean requiresSession)
Parameters:
setUserMetadata
public void setUserMetadata(String userMetadata)
Parameters:
Applies to
Azure SDK for Java