CreateQueueOptions (Azure SDK for Java Reference Documentation)

java.lang.Object
- com.azure.messaging.servicebus.administration.models.CreateQueueOptions

```
public final class CreateQueueOptions
extends Object
```
Represents the set of options that can be specified for the creation of a queue.

See Also:

ServiceBusAdministrationAsyncClient.createQueue(String, CreateQueueOptions), ServiceBusAdministrationClient.createQueue(String, CreateQueueOptions)

Constructor Summary

Constructors
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.

Method Summary

All Methods Instance Methods Concrete Methods
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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CreateQueueOptions
```
public CreateQueueOptions()
```
    Creates an instance with the name of the queue. Default values for the queue are populated. The properties populated with defaults are:
    - 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.
    Throws:
    
    NullPointerException - if queueName is a null.
    
    IllegalArgumentException - if queueName is an empty string.
  - CreateQueueOptions
```
public CreateQueueOptions(QueueProperties queue)
```
    Initializes a new instance based on the specified QueueProperties instance. This is useful for creating a new queue based on the properties of an existing queue.
    
    Parameters:
    
    queue - Existing queue to create options with.
- Method Detail
  - getAuthorizationRules
```
public List<AuthorizationRule> getAuthorizationRules()
```
    Gets the authorization rules to control user access at entity level.
    
    Returns:
    
    The authorization rules to control user access at entity level.
  - getAutoDeleteOnIdle
```
public Duration getAutoDeleteOnIdle()
```
    Get the autoDeleteOnIdle property: ISO 8601 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.
    
    Returns:
    
    the autoDeleteOnIdle value.
  - setAutoDeleteOnIdle
```
public CreateQueueOptions setAutoDeleteOnIdle(Duration autoDeleteOnIdle)
```
    Set the autoDeleteOnIdle property: ISO 8601 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.
    
    Parameters:
    
    autoDeleteOnIdle - the autoDeleteOnIdle value to set.
    
    Returns:
    
    the CreateQueueOptions object itself.
  - getDefaultMessageTimeToLive
```
public Duration getDefaultMessageTimeToLive()
```
    Get the defaultMessageTimeToLive property: ISO 8601 default message timespan to live value. This 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 TimeToLive is not set on a message itself.
    
    Returns:
    
    the defaultMessageTimeToLive value.
  - setDefaultMessageTimeToLive
```
public CreateQueueOptions setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
```
    Set the defaultMessageTimeToLive property: ISO 8601 default message timespan to live value. This 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 TimeToLive is not set on a message itself.
    
    Parameters:
    
    defaultMessageTimeToLive - the defaultMessageTimeToLive value to set.
    
    Returns:
    
    the CreateQueueOptions object itself.
  - isDeadLetteringOnMessageExpiration
```
public boolean isDeadLetteringOnMessageExpiration()
```
    Get the deadLetteringOnMessageExpiration property: A value that indicates whether this queue has dead letter support when a message expires.
    
    Returns:
    
    the deadLetteringOnMessageExpiration value.
  - setDeadLetteringOnMessageExpiration
```
public CreateQueueOptions setDeadLetteringOnMessageExpiration(boolean deadLetteringOnMessageExpiration)
```
    Set the deadLetteringOnMessageExpiration property: A value that indicates whether this queue has dead letter support when a message expires.
    
    Parameters:
    
    deadLetteringOnMessageExpiration - the deadLetteringOnMessageExpiration value to set.
    
    Returns:
    
    the CreateQueueOptions object itself.
  - getDuplicateDetectionHistoryTimeWindow
```
public Duration getDuplicateDetectionHistoryTimeWindow()
```
    Get the duplicateDetectionHistoryTimeWindow property: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
    
    Returns:
    
    the duplicateDetectionHistoryTimeWindow value.
  - setDuplicateDetectionHistoryTimeWindow
```
public CreateQueueOptions setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)
```
    Set the duplicateDetectionHistoryTimeWindow property: ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
    
    Parameters:
    
    duplicateDetectionHistoryTimeWindow - the duplicateDetectionHistoryTimeWindow value to set.
    
    Returns:
    
    the CreateQueueOptions object itself.
  - isBatchedOperationsEnabled
```
public boolean isBatchedOperationsEnabled()
```
    Get the enableBatchedOperations property: Value that indicates whether server-side batched operations are enabled.
    
    Returns:
    
    the enableBatchedOperations value.
  - setBatchedOperationsEnabled
```
public CreateQueueOptions setBatchedOperationsEnabled(boolean enableBatchedOperations)
```
    Set the enableBatchedOperations property: Value that indicates whether server-side batched operations are enabled.
    
    Parameters:
    
    enableBatchedOperations - the enableBatchedOperations value to set.
    
    Returns:
    
    the CreateQueueOptions object itself.
  - isPartitioningEnabled
```
public boolean isPartitioningEnabled()
```
    Get the enablePartitioning property: A value that indicates whether the queue is to be partitioned across multiple message brokers.
    
    Returns:
    
    the enablePartitioning value.
  - setPartitioningEnabled
```
public CreateQueueOptions setPartitioningEnabled(boolean enablePartitioning)
```
    Set the enablePartitioning property: A value that indicates whether the queue is to be partitioned across multiple message brokers.
    
    Parameters:
    
    enablePartitioning - the enablePartitioning value to set.
    
    Returns:
    
    the CreateQueueOptions object itself.
  - getForwardTo
```
public String getForwardTo()
```
    Get the forwardTo property: The name of the recipient entity to which all the messages sent to the queue are forwarded to.
    
    Returns:
    
    the forwardTo value.
  - setForwardTo
```
public 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.
    
    Parameters:
    
    forwardTo - the forwardTo value to set.
    
    Returns:
    
    the CreateQueueOptions object itself.
  - getForwardDeadLetteredMessagesTo
```
public 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.
    
    Returns:
    
    the forwardDeadLetteredMessagesTo value.
  - setForwardDeadLetteredMessagesTo
```
public 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.
    
    Parameters:
    
    forwardDeadLetteredMessagesTo - the forwardDeadLetteredMessagesTo value to set.
    
    Returns:
    
    the CreateQueueOptions object itself.
  - getLockDuration
```
public 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. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.
    
    Returns:
    
    the lockDuration value.
  - setLockDuration
```
public 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. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.
    
    Parameters:
    
    lockDuration - the lockDuration value to set.
    
    Returns:
    
    the CreateQueueOptions object itself.
  - getMaxDeliveryCount
```
public int getMaxDeliveryCount()
```
    Get the maxDeliveryCount property: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. Default value is 10.
    
    Returns:
    
    the maxDeliveryCount value.
  - setMaxDeliveryCount
```
public CreateQueueOptions setMaxDeliveryCount(int maxDeliveryCount)
```
    Set the maxDeliveryCount property: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. Default value is 10.
    
    Parameters:
    
    maxDeliveryCount - the maxDeliveryCount value to set.
    
    Returns:
    
    the CreateQueueOptions object itself.
  - getMaxSizeInMegabytes
```
public long getMaxSizeInMegabytes()
```
    Get the maxSizeInMegabytes property: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue.
    
    Returns:
    
    the maxSizeInMegabytes value.
  - setMaxSizeInMegabytes
```
public 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.
    
    Parameters:
    
    maxSizeInMegabytes - the maxSizeInMegabytes value to set.
    
    Returns:
    
    the CreateQueueOptions object itself.
  - isDuplicateDetectionRequired
```
public boolean isDuplicateDetectionRequired()
```
    Get the requiresDuplicateDetection property: A value indicating if this queue requires duplicate detection.
    
    Returns:
    
    the requiresDuplicateDetection value.
  - setDuplicateDetectionRequired
```
public CreateQueueOptions setDuplicateDetectionRequired(boolean requiresDuplicateDetection)
```
    Set the requiresDuplicateDetection property: A value indicating if this queue requires duplicate detection.
    
    Parameters:
    
    requiresDuplicateDetection - the requiresDuplicateDetection value to set.
    
    Returns:
    
    the CreateQueueOptions object itself.
  - isSessionRequired
```
public boolean isSessionRequired()
```
    Get the requiresSession property: A value that indicates whether the queue supports the concept of sessions.
    
    Returns:
    
    the requiresSession value.
  - setSessionRequired
```
public CreateQueueOptions setSessionRequired(boolean requiresSession)
```
    Set the requiresSession property: A value that indicates whether the queue supports the concept of sessions.
    
    Parameters:
    
    requiresSession - the requiresSession value to set.
    
    Returns:
    
    the CreateQueueOptions object itself.
  - getStatus
```
public EntityStatus getStatus()
```
    Get the status property: Status of a Service Bus resource.
    
    Returns:
    
    the status value.
  - setStatus
```
public CreateQueueOptions setStatus(EntityStatus status)
```
    Set the status property: Status of a Service Bus resource.
    
    Parameters:
    
    status - the status value to set.
    
    Returns:
    
    the CreateQueueOptions object itself.
  - getUserMetadata
```
public String getUserMetadata()
```
    Get the userMetadata property: Custom metdata that user can associate with the description. Max length is 1024 chars.
    
    Returns:
    
    the userMetadata value.
  - setUserMetadata
```
public CreateQueueOptions setUserMetadata(String userMetadata)
```
    Set the userMetadata property: Custom metdata that user can associate with the description. Max length is 1024 chars.
    
    Parameters:
    
    userMetadata - the userMetadata value to set.
    
    Returns:
    
    the CreateQueueOptions object itself.

Visit the Azure for Java Developers site for more Java documentation, including quick starts, tutorials, and code samples.

Class CreateQueueOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CreateQueueOptions

CreateQueueOptions

Method Detail

getAuthorizationRules

getAutoDeleteOnIdle

setAutoDeleteOnIdle

getDefaultMessageTimeToLive

setDefaultMessageTimeToLive

isDeadLetteringOnMessageExpiration

setDeadLetteringOnMessageExpiration

getDuplicateDetectionHistoryTimeWindow

setDuplicateDetectionHistoryTimeWindow

isBatchedOperationsEnabled

setBatchedOperationsEnabled

isPartitioningEnabled

setPartitioningEnabled

getForwardTo

setForwardTo

getForwardDeadLetteredMessagesTo

setForwardDeadLetteredMessagesTo

getLockDuration

setLockDuration

getMaxDeliveryCount

setMaxDeliveryCount

getMaxSizeInMegabytes

setMaxSizeInMegabytes

isDuplicateDetectionRequired

setDuplicateDetectionRequired

isSessionRequired

setSessionRequired

getStatus

setStatus

getUserMetadata

setUserMetadata