public final class QueueProperties extends Object
Modifier and Type | Method and Description |
---|---|
List<AuthorizationRule> |
getAuthorizationRules()
Get the authorizationRules property: Authorization rules for resource.
|
Duration |
getAutoDeleteOnIdle()
Get the autoDeleteOnIdle property: ISO 8601 timeSpan idle interval after which the queue is automatically
deleted.
|
Duration |
getDefaultMessageTimeToLive()
Get the defaultMessageTimeToLive property: ISO 8601 default message timespan to live value.
|
Duration |
getDuplicateDetectionHistoryTimeWindow()
Get the duplicateDetectionHistoryTimeWindow property: ISO 8601 timeSpan structure that defines the duration of
the duplicate detection history.
|
String |
getForwardDeadLetteredMessagesTo()
Get the forwardDeadLetteredMessagesTo property: The name of the recipient entity to which all the dead-lettered
messages of this queue are forwarded to.
|
String |
getForwardTo()
Get the forwardTo property: The name of the recipient entity to which all the messages sent to the queue are
forwarded to.
|
Duration |
getLockDuration()
Get the lockDuration property: ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the
message is locked for other receivers.
|
int |
getMaxDeliveryCount()
Get the maxDeliveryCount property: The maximum delivery count.
|
long |
getMaxSizeInMegabytes()
Gets the maximum size of the queue in megabytes, which is the size of memory allocated for the queue.
|
String |
getName()
Gets the name of the queue.
|
EntityStatus |
getStatus()
Get the status property: Status of a Service Bus resource.
|
String |
getUserMetadata()
Get the userMetadata property: Custom metdata that user can associate with the description.
|
boolean |
isBatchedOperationsEnabled()
Get the enableBatchedOperations property: Value that indicates whether server-side batched operations are
enabled.
|
boolean |
isDeadLetteringOnMessageExpiration()
Get the deadLetteringOnMessageExpiration property: A value that indicates whether this queue has dead letter
support when a message expires.
|
boolean |
isDuplicateDetectionRequired()
Get the requiresDuplicateDetection property: A value indicating if this queue requires duplicate detection.
|
boolean |
isPartitioningEnabled()
Get the enablePartitioning property: A value that indicates whether the queue is to be partitioned across
multiple message brokers.
|
boolean |
isSessionRequired()
Get the requiresSession property: A value that indicates whether the queue supports the concept of sessions.
|
QueueProperties |
setAutoDeleteOnIdle(Duration autoDeleteOnIdle)
Set the autoDeleteOnIdle property: ISO 8601 timeSpan idle interval after which the queue is automatically
deleted.
|
QueueProperties |
setBatchedOperationsEnabled(boolean enableBatchedOperations)
Set the enableBatchedOperations property: Value that indicates whether server-side batched operations are
enabled.
|
QueueProperties |
setDeadLetteringOnMessageExpiration(boolean deadLetteringOnMessageExpiration)
Set the deadLetteringOnMessageExpiration property: A value that indicates whether this queue has dead letter
support when a message expires.
|
QueueProperties |
setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
Set the defaultMessageTimeToLive property: ISO 8601 default message timespan to live value.
|
QueueProperties |
setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)
Set the duplicateDetectionHistoryTimeWindow property: ISO 8601 timeSpan structure that defines the duration of
the duplicate detection history.
|
QueueProperties |
setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)
Set the forwardDeadLetteredMessagesTo property: The name of the recipient entity to which all the dead-lettered
messages of this queue are forwarded to.
|
QueueProperties |
setForwardTo(String forwardTo)
Set the forwardTo property: The name of the recipient entity to which all the messages sent to the queue are
forwarded to.
|
QueueProperties |
setLockDuration(Duration lockDuration)
Set the lockDuration property: ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the
message is locked for other receivers.
|
QueueProperties |
setMaxDeliveryCount(Integer maxDeliveryCount)
Sets the maximum delivery count.
|
QueueProperties |
setMaxSizeInMegabytes(Integer maxSizeInMegabytes)
Set the maxSizeInMegabytes property: The maximum size of the queue in megabytes, which is the size of memory
allocated for the queue.
|
QueueProperties |
setStatus(EntityStatus status)
Set the status property: Status of a Service Bus resource.
|
QueueProperties |
setUserMetadata(String userMetadata)
Set the userMetadata property: Custom metdata that user can associate with the description.
|
public String getName()
public Duration getAutoDeleteOnIdle()
public QueueProperties setAutoDeleteOnIdle(Duration autoDeleteOnIdle)
autoDeleteOnIdle
- the autoDeleteOnIdle value to set.QueueProperties
object itself.public List<AuthorizationRule> getAuthorizationRules()
public Duration getDefaultMessageTimeToLive()
public QueueProperties setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
defaultMessageTimeToLive
- the defaultMessageTimeToLive value to set.QueueProperties
object itself.public boolean isDeadLetteringOnMessageExpiration()
public QueueProperties setDeadLetteringOnMessageExpiration(boolean deadLetteringOnMessageExpiration)
deadLetteringOnMessageExpiration
- the deadLetteringOnMessageExpiration value to set.QueueProperties
object itself.public Duration getDuplicateDetectionHistoryTimeWindow()
public QueueProperties setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)
duplicateDetectionHistoryTimeWindow
- the duplicateDetectionHistoryTimeWindow value to set.QueueProperties
object itself.public boolean isBatchedOperationsEnabled()
public QueueProperties setBatchedOperationsEnabled(boolean enableBatchedOperations)
enableBatchedOperations
- the enableBatchedOperations value to set.QueueProperties
object itself.public boolean isPartitioningEnabled()
public String getForwardTo()
public QueueProperties setForwardTo(String forwardTo)
forwardTo
- the forwardTo value to set.QueueProperties
object itself.public String getForwardDeadLetteredMessagesTo()
public QueueProperties setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)
forwardDeadLetteredMessagesTo
- the forwardDeadLetteredMessagesTo value to set.QueueProperties
object itself.public Duration getLockDuration()
public QueueProperties setLockDuration(Duration lockDuration)
lockDuration
- the lockDuration value to set.QueueProperties
object itself.public int getMaxDeliveryCount()
public QueueProperties setMaxDeliveryCount(Integer maxDeliveryCount)
maxDeliveryCount
- the maxDeliveryCount value to set.QueueProperties
object itself.public long getMaxSizeInMegabytes()
public QueueProperties setMaxSizeInMegabytes(Integer maxSizeInMegabytes)
maxSizeInMegabytes
- the maxSizeInMegabytes value to set.QueueProperties
object itself.public boolean isDuplicateDetectionRequired()
public boolean isSessionRequired()
public EntityStatus getStatus()
public QueueProperties setStatus(EntityStatus status)
status
- the status value to set.QueueProperties
object itself.public String getUserMetadata()
public QueueProperties setUserMetadata(String userMetadata)
userMetadata
- the userMetadata value to set.QueueProperties
object itself.Copyright © 2021 Microsoft Corporation. All rights reserved.