public final class CreateTopicOptions extends Object
Constructor and Description |
---|
CreateTopicOptions()
Creates an instance.
|
CreateTopicOptions(TopicProperties topic)
Initializes a new instance based on the specified
CreateTopicOptions 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.
|
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 |
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.
|
boolean |
isSupportOrdering()
Defines whether ordering needs to be maintained.
|
CreateTopicOptions |
setAutoDeleteOnIdle(Duration autoDeleteOnIdle)
Set the autoDeleteOnIdle property: ISO 8601 timeSpan idle interval after which the queue is automatically
deleted.
|
CreateTopicOptions |
setBatchedOperationsEnabled(boolean enableBatchedOperations)
Set the enableBatchedOperations property: Value that indicates whether server-side batched operations are
enabled.
|
CreateTopicOptions |
setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
Set the defaultMessageTimeToLive property: ISO 8601 default message timespan to live value.
|
CreateTopicOptions |
setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)
Set the duplicateDetectionHistoryTimeWindow property: ISO 8601 timeSpan structure that defines the duration of
the duplicate detection history.
|
CreateTopicOptions |
setDuplicateDetectionRequired(boolean requiresDuplicateDetection)
Set the requiresDuplicateDetection property: A value indicating if this queue requires duplicate detection.
|
CreateTopicOptions |
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.
|
CreateTopicOptions |
setMaxDeliveryCount(int maxDeliveryCount)
Set the maxDeliveryCount property: The maximum delivery count.
|
CreateTopicOptions |
setMaxSizeInMegabytes(long maxSizeInMegabytes)
Set the maxSizeInMegabytes property: The maximum size of the queue in megabytes, which is the size of memory
allocated for the queue.
|
CreateTopicOptions |
setOrderingSupported(boolean supportOrdering)
Defines whether ordering needs to be maintained.
|
CreateTopicOptions |
setPartitioningEnabled(boolean enablePartitioning)
Set the enablePartitioning property: A value that indicates whether the queue is to be partitioned across
multiple message brokers.
|
CreateTopicOptions |
setSessionRequired(boolean requiresSession)
Set the requiresSession property: A value that indicates whether the queue supports the concept of sessions.
|
CreateTopicOptions |
setStatus(EntityStatus status)
Set the status property: Status of a Service Bus resource.
|
CreateTopicOptions |
setUserMetadata(String userMetadata)
Set the userMetadata property: Custom metdata that user can associate with the description.
|
public CreateTopicOptions()
CreateTopicOptions.setAutoDeleteOnIdle(Duration)
is max duration value.CreateTopicOptions.setDefaultMessageTimeToLive(Duration)
is max duration value.CreateTopicOptions.setDuplicateDetectionHistoryTimeWindow(Duration)
is max duration value, but duplication
detection is disabled.CreateTopicOptions.setDuplicateDetectionRequired(boolean)
is false.CreateTopicOptions.setBatchedOperationsEnabled(boolean)
(boolean)} is true.CreateTopicOptions.setLockDuration(Duration)
is 1 minute.CreateTopicOptions.setMaxDeliveryCount(int)
is 10.CreateTopicOptions.setMaxSizeInMegabytes(long)
is 1024MB.CreateTopicOptions.setSessionRequired(boolean)
is false.CreateTopicOptions.setStatus(EntityStatus)
is EntityStatus.ACTIVE
.NullPointerException
- if topicName
is a null.IllegalArgumentException
- if topicName
is an empty string.public CreateTopicOptions(TopicProperties topic)
CreateTopicOptions
instance. This is useful for
creating a new topic based on the properties of an existing topicOptions.topic
- Existing topicOptions to create options with.public List<AuthorizationRule> getAuthorizationRules()
public Duration getAutoDeleteOnIdle()
public CreateTopicOptions setAutoDeleteOnIdle(Duration autoDeleteOnIdle)
autoDeleteOnIdle
- the autoDeleteOnIdle value to set.public Duration getDefaultMessageTimeToLive()
public CreateTopicOptions setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
defaultMessageTimeToLive
- the defaultMessageTimeToLive value to set.public Duration getDuplicateDetectionHistoryTimeWindow()
public CreateTopicOptions setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)
duplicateDetectionHistoryTimeWindow
- the duplicateDetectionHistoryTimeWindow value to set.public Boolean isBatchedOperationsEnabled()
public CreateTopicOptions setBatchedOperationsEnabled(boolean enableBatchedOperations)
enableBatchedOperations
- the enableBatchedOperations value to set.public Boolean isPartitioningEnabled()
public CreateTopicOptions setPartitioningEnabled(boolean enablePartitioning)
enablePartitioning
- the enablePartitioning value to set.public EntityStatus getStatus()
public CreateTopicOptions setStatus(EntityStatus status)
status
- the status value to set.public boolean isSupportOrdering()
public CreateTopicOptions setOrderingSupported(boolean supportOrdering)
supportOrdering
- true if ordering should be maintained; false otherwise.public Duration getLockDuration()
public CreateTopicOptions setLockDuration(Duration lockDuration)
lockDuration
- the lockDuration value to set.public int getMaxDeliveryCount()
public CreateTopicOptions setMaxDeliveryCount(int maxDeliveryCount)
maxDeliveryCount
- the maxDeliveryCount value to set.public long getMaxSizeInMegabytes()
public CreateTopicOptions setMaxSizeInMegabytes(long maxSizeInMegabytes)
maxSizeInMegabytes
- the maxSizeInMegabytes value to set.public Boolean isDuplicateDetectionRequired()
public CreateTopicOptions setDuplicateDetectionRequired(boolean requiresDuplicateDetection)
requiresDuplicateDetection
- the requiresDuplicateDetection value to set.public Boolean isSessionRequired()
public CreateTopicOptions setSessionRequired(boolean requiresSession)
requiresSession
- the requiresSession value to set.public String getUserMetadata()
public CreateTopicOptions setUserMetadata(String userMetadata)
userMetadata
- the userMetadata value to set.Copyright © 2021 Microsoft Corporation. All rights reserved.