public final class CreateQueueOptions extends Object
Constructor and Description |
---|
CreateQueueOptions()
Creates an instance with the name of the queue.
|
CreateQueueOptions(QueueProperties queue)
Initializes a new instance based on the specified
QueueProperties instance. |
Modifier and Type | Method and Description |
---|---|
List<AuthorizationRule> |
getAuthorizationRules()
Gets the authorization rules to control user access at entity level.
|
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()
Get the maxSizeInMegabytes property: The maximum size of the queue in megabytes, which is the size of memory
allocated for 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.
|
CreateQueueOptions |
setAutoDeleteOnIdle(Duration autoDeleteOnIdle)
Set the autoDeleteOnIdle property: ISO 8601 timeSpan idle interval after which the queue is automatically
deleted.
|
CreateQueueOptions |
setBatchedOperationsEnabled(boolean enableBatchedOperations)
Set the enableBatchedOperations property: Value that indicates whether server-side batched operations are
enabled.
|
CreateQueueOptions |
setDeadLetteringOnMessageExpiration(boolean deadLetteringOnMessageExpiration)
Set the deadLetteringOnMessageExpiration property: A value that indicates whether this queue has dead letter
support when a message expires.
|
CreateQueueOptions |
setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
Set the defaultMessageTimeToLive property: ISO 8601 default message timespan to live value.
|
CreateQueueOptions |
setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)
Set the duplicateDetectionHistoryTimeWindow property: ISO 8601 timeSpan structure that defines the duration of
the duplicate detection history.
|
CreateQueueOptions |
setDuplicateDetectionRequired(boolean requiresDuplicateDetection)
Set the requiresDuplicateDetection property: A value indicating if this queue requires duplicate detection.
|
CreateQueueOptions |
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.
|
CreateQueueOptions |
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.
|
CreateQueueOptions |
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.
|
CreateQueueOptions |
setMaxDeliveryCount(int maxDeliveryCount)
Set the maxDeliveryCount property: The maximum delivery count.
|
CreateQueueOptions |
setMaxSizeInMegabytes(int maxSizeInMegabytes)
Set the maxSizeInMegabytes property: The maximum size of the queue in megabytes, which is the size of memory
allocated for the queue.
|
CreateQueueOptions |
setPartitioningEnabled(boolean enablePartitioning)
Set the enablePartitioning property: A value that indicates whether the queue is to be partitioned across
multiple message brokers.
|
CreateQueueOptions |
setSessionRequired(boolean requiresSession)
Set the requiresSession property: A value that indicates whether the queue supports the concept of sessions.
|
CreateQueueOptions |
setStatus(EntityStatus status)
Set the status property: Status of a Service Bus resource.
|
CreateQueueOptions |
setUserMetadata(String userMetadata)
Set the userMetadata property: Custom metdata that user can associate with the description.
|
public CreateQueueOptions()
CreateQueueOptions.setAutoDeleteOnIdle(Duration)
is max duration value.CreateQueueOptions.setDefaultMessageTimeToLive(Duration)
is max duration value.CreateQueueOptions.setDuplicateDetectionHistoryTimeWindow(Duration)
is max duration value, but duplication
detection is disabled.CreateQueueOptions.setDuplicateDetectionRequired(boolean)
is false.CreateQueueOptions.setBatchedOperationsEnabled(boolean)
is true.CreateQueueOptions.setLockDuration(Duration)
is 1 minute.CreateQueueOptions.setMaxDeliveryCount(int)
is 10.CreateQueueOptions.setMaxSizeInMegabytes(int)
is 1024MB.CreateQueueOptions.setSessionRequired(boolean)
is false.CreateQueueOptions.setStatus(EntityStatus)
is EntityStatus.ACTIVE
.NullPointerException
- if queueName
is a null.IllegalArgumentException
- if queueName
is an empty string.public CreateQueueOptions(QueueProperties queue)
QueueProperties
instance. This is useful for creating a
new queue based on the properties of an existing queue.queue
- Existing queue to create options with.public List<AuthorizationRule> getAuthorizationRules()
public Duration getAutoDeleteOnIdle()
public CreateQueueOptions setAutoDeleteOnIdle(Duration autoDeleteOnIdle)
autoDeleteOnIdle
- the autoDeleteOnIdle value to set.public Duration getDefaultMessageTimeToLive()
public CreateQueueOptions setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
defaultMessageTimeToLive
- the defaultMessageTimeToLive value to set.public boolean isDeadLetteringOnMessageExpiration()
public CreateQueueOptions setDeadLetteringOnMessageExpiration(boolean deadLetteringOnMessageExpiration)
deadLetteringOnMessageExpiration
- the deadLetteringOnMessageExpiration value to set.public Duration getDuplicateDetectionHistoryTimeWindow()
public CreateQueueOptions setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)
duplicateDetectionHistoryTimeWindow
- the duplicateDetectionHistoryTimeWindow value to set.public boolean isBatchedOperationsEnabled()
public CreateQueueOptions setBatchedOperationsEnabled(boolean enableBatchedOperations)
enableBatchedOperations
- the enableBatchedOperations value to set.public boolean isPartitioningEnabled()
public CreateQueueOptions setPartitioningEnabled(boolean enablePartitioning)
enablePartitioning
- the enablePartitioning value to set.public String getForwardTo()
public CreateQueueOptions setForwardTo(String forwardTo)
forwardTo
- the forwardTo value to set.public String getForwardDeadLetteredMessagesTo()
public CreateQueueOptions setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)
forwardDeadLetteredMessagesTo
- the forwardDeadLetteredMessagesTo value to set.public Duration getLockDuration()
public CreateQueueOptions setLockDuration(Duration lockDuration)
lockDuration
- the lockDuration value to set.public int getMaxDeliveryCount()
public CreateQueueOptions setMaxDeliveryCount(int maxDeliveryCount)
maxDeliveryCount
- the maxDeliveryCount value to set.public long getMaxSizeInMegabytes()
public CreateQueueOptions setMaxSizeInMegabytes(int maxSizeInMegabytes)
maxSizeInMegabytes
- the maxSizeInMegabytes value to set.public boolean isDuplicateDetectionRequired()
public CreateQueueOptions setDuplicateDetectionRequired(boolean requiresDuplicateDetection)
requiresDuplicateDetection
- the requiresDuplicateDetection value to set.public boolean isSessionRequired()
public CreateQueueOptions setSessionRequired(boolean requiresSession)
requiresSession
- the requiresSession value to set.public EntityStatus getStatus()
public CreateQueueOptions setStatus(EntityStatus status)
status
- the status value to set.public String getUserMetadata()
public CreateQueueOptions setUserMetadata(String userMetadata)
userMetadata
- the userMetadata value to set.Copyright © 2021 Microsoft Corporation. All rights reserved.