CreateTopicOptions Class

Package:

com.azure.messaging.servicebus.administration.models

Maven Artifact:

com.azure:azure-messaging-servicebus:7.17.5

• java.lang.Object
• • com.azure.messaging.servicebus.administration.models.CreateTopicOptions

public final class CreateTopicOptions

Represents the set of options that can be specified for the creation of a topic.

Constructor Summary

Constructor	Description
CreateTopicOptions()	Creates an instance.
CreateTopicOptions(TopicProperties topic)	Initializes a new instance based on the specified CreateTopicOptions instance.

Method Summary

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	getMaxMessageSizeInKilobytes() Get the maxMessageSizeInKilobytes property: The maximum size of a message in kilobytes.
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	setMaxMessageSizeInKilobytes(long maxMessageSizeInKilobytes) Set the maxMessageSizeInKilobytes property: Represents the default maximum message size (in kilobytes) Option only available in premium tier.
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.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CreateTopicOptions

public CreateTopicOptions()

Creates an instance. Default values for the topic are populated. The properties populated with defaults are:

• setAutoDeleteOnIdle(Duration autoDeleteOnIdle) is max duration value.
• setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive) is max duration value.
• setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow) is max duration value, but duplication detection is disabled.
• setDuplicateDetectionRequired(boolean requiresDuplicateDetection) is false.
• setBatchedOperationsEnabled(boolean enableBatchedOperations) (boolean)} is true.
• setLockDuration(Duration lockDuration) is 1 minute.
• setMaxDeliveryCount(int maxDeliveryCount) is 10.
• setMaxSizeInMegabytes(long maxSizeInMegabytes) is 1024MB.
• setSessionRequired(boolean requiresSession) is false.
• setStatus(EntityStatus status) is ACTIVE.

CreateTopicOptions

public CreateTopicOptions(TopicProperties topic)

Initializes a new instance based on the specified CreateTopicOptions instance. This is useful for creating a new topic based on the properties of an existing topicOptions.

Parameters:

topic - Existing topicOptions to create options with.

Method Details

getAuthorizationRules

public List 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.

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.

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.

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.

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.

getMaxMessageSizeInKilobytes

public long getMaxMessageSizeInKilobytes()

Get the maxMessageSizeInKilobytes property: The maximum size of a message in kilobytes.

Returns:

the maxMessageSizeInKilobytes value.

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.

getStatus

public EntityStatus getStatus()

Get the status property: Status of a Service Bus resource.

Returns:

the status value.

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.

isBatchedOperationsEnabled

public Boolean isBatchedOperationsEnabled()

Get the enableBatchedOperations property: Value that indicates whether server-side batched operations are enabled.

Returns:

the enableBatchedOperations value.

isDuplicateDetectionRequired

public Boolean isDuplicateDetectionRequired()

Get the requiresDuplicateDetection property: A value indicating if this queue requires duplicate detection.

Returns:

the requiresDuplicateDetection value.

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.

isSessionRequired

public Boolean isSessionRequired()

Get the requiresSession property: A value that indicates whether the queue supports the concept of sessions.

Returns:

the requiresSession value.

isSupportOrdering

public boolean isSupportOrdering()

Defines whether ordering needs to be maintained. If true, messages sent to topic will be forwarded to the subscription in order.

Returns:

true if ordering should be maintained; false otherwise.

setAutoDeleteOnIdle

public CreateTopicOptions 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 CreateTopicOptions object itself.

setBatchedOperationsEnabled

public CreateTopicOptions 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 CreateTopicOptions object itself.

setDefaultMessageTimeToLive

public CreateTopicOptions 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 CreateTopicOptions object itself.

setDuplicateDetectionHistoryTimeWindow

public CreateTopicOptions 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 CreateTopicOptions object itself.

setDuplicateDetectionRequired

public CreateTopicOptions 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 CreateTopicOptions object itself.

setLockDuration

public 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. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.

Parameters:

lockDuration - the lockDuration value to set.

Returns:

the CreateTopicOptions object itself.

setMaxDeliveryCount

public CreateTopicOptions 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 CreateTopicOptions object itself.

setMaxMessageSizeInKilobytes

public CreateTopicOptions setMaxMessageSizeInKilobytes(long maxMessageSizeInKilobytes)

Set the maxMessageSizeInKilobytes property: Represents the default maximum message size (in kilobytes) Option only available in premium tier. Default maximum in Standard tier is 256 KB, and 1 MB in premium tier. Larger message sizes are available in preview. Please see more info

Parameters:

maxMessageSizeInKilobytes - the maxMessageSizeInKilobytes value to set.

Returns:

the CreateTopicOptions object itself.

setMaxSizeInMegabytes

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

Parameters:

maxSizeInMegabytes - the maxSizeInMegabytes value to set.

Returns:

the CreateTopicOptions object itself.

setOrderingSupported

public CreateTopicOptions setOrderingSupported(boolean supportOrdering)

Defines whether ordering needs to be maintained. If true, messages sent to topic will be forwarded to the subscription in order.

Parameters:

supportOrdering - true if ordering should be maintained; false otherwise.

Returns:

the CreateTopicOptions object itself.

setPartitioningEnabled

public CreateTopicOptions 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 CreateTopicOptions object itself.

setSessionRequired

public CreateTopicOptions 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 CreateTopicOptions object itself.

setStatus

public CreateTopicOptions setStatus(EntityStatus status)

Set the status property: Status of a Service Bus resource.

Parameters:

status - the status value to set.

Returns:

the CreateTopicOptions object itself.

setUserMetadata

public CreateTopicOptions 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 CreateTopicOptions object itself.