TopicDescription Class

Package:

com.microsoft.azure.servicebus.management

Maven Artifact:

com.microsoft.azure:azure-servicebus:3.6.7

• java.lang.Object
• • com.microsoft.azure.servicebus.management.UnknownPropertiesHolder
  • • com.microsoft.azure.servicebus.management.TopicDescription

public class TopicDescription
extends com.microsoft.azure.servicebus.management.UnknownPropertiesHolder

Represents the metadata description of the topic.

Constructor Summary

Constructor	Description
TopicDescription(String path)	Initializes a new instance of TopicDescription with the specified relative path.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
List<AuthorizationRule>	getAuthorizationRules()
Duration	getAutoDeleteOnIdle()
Duration	getDefaultMessageTimeToLive() Time-To-live is the duration after which the message expires, starting from when the message is sent to Service Bus.
Duration	getDuplicationDetectionHistoryTimeWindow()
EntityStatus	getEntityStatus() Gets the status of the entity.
long	getMaxSizeInMB()
String	getPath()
String	getUserMetadata()
int	hashCode()
boolean	isEnableBatchedOperations()
boolean	isEnablePartitioning()
boolean	isRequiresDuplicateDetection() If enabled, duplicate messages having same getMessageId() and sent to queue within duration of #getDuplicationDetectionHistoryTimeWindow will be discarded.
boolean	isSupportOrdering()
void	setAuthorizationRules(List<AuthorizationRule> authorizationRules)
void	setAutoDeleteOnIdle(Duration autoDeleteOnIdle)
void	setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
void	setDuplicationDetectionHistoryTimeWindow(Duration duplicationDetectionHistoryTimeWindow)
void	setEnableBatchedOperations(boolean enableBatchedOperations)
void	setEnablePartitioning(boolean enablePartitioning)
void	setEntityStatus(EntityStatus status)
void	setMaxSizeInMB(long maxSize)
void	setRequiresDuplicateDetection(boolean requiresDuplicateDetection)
void	setSupportOrdering(boolean supportOrdering)
void	setUserMetadata(String userMetadata)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

TopicDescription

public TopicDescription(String path)

Initializes a new instance of TopicDescription with the specified relative path.

Parameters:

path -

• Path of the topic. Max length is 260 chars. Cannot start or end with a slash. Cannot have restricted characters: '@','?','#','*'

Method Details

equals

public boolean equals(Object o)

Overrides:

TopicDescription.equals(Object o)

Parameters:

o

getAuthorizationRules

public List getAuthorizationRules()

Returns:

The AuthorizationRule on the topic to control user access at entity level.

getAutoDeleteOnIdle

public Duration getAutoDeleteOnIdle()

Returns:

The idle interval after which the topic is automatically deleted. Default value is MAX_DURATION

getDefaultMessageTimeToLive

public Duration getDefaultMessageTimeToLive()

Time-To-live 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 getTimeToLive() is not set on a message itself. Messages older than their TimeToLive value will expire and no longer be retained in the message store. Subscribers will be unable to receive expired messages.

Returns:

The default time to live value for the messages. Default value is MAX_DURATION

getDuplicationDetectionHistoryTimeWindow

public Duration getDuplicationDetectionHistoryTimeWindow()

Returns:

The duration of duplicate detection history that is maintained by the service. The default value is 1 minute.

getEntityStatus

public EntityStatus getEntityStatus()

Gets the status of the entity. When an entity is disabled, that entity cannot send or receive messages.

Returns:

The current status of the topic (Enabled / Disabled). The default value is Enabled.

getMaxSizeInMB

public long getMaxSizeInMB()

Returns:

the maximum size of the topic in megabytes, which is the size of memory allocated for the topic. Default value is 1024.

getPath

public String getPath()

Returns:

the path of the topic.

getUserMetadata

public String getUserMetadata()

Returns:

• Custom metdata that user can associate with the description.

hashCode

public int hashCode()

Overrides:

TopicDescription.hashCode()

isEnableBatchedOperations

public boolean isEnableBatchedOperations()

Returns:

Indicates whether server-side batched operations are enabled. Defaults to true.

isEnablePartitioning

public boolean isEnablePartitioning()

Returns:

boolean indicating whether the topic is to be partitioned across multiple message brokers. Defaults to false

isRequiresDuplicateDetection

public boolean isRequiresDuplicateDetection()

If enabled, duplicate messages having same getMessageId() and sent to queue within duration of #getDuplicationDetectionHistoryTimeWindow will be discarded.

Returns:

value indicating if the queue requires guard against duplicate messages.

isSupportOrdering

public boolean isSupportOrdering()

Returns:

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

setAuthorizationRules

public void setAuthorizationRules(List authorizationRules)

Parameters:

authorizationRules -

• The AuthorizationRule on the topic to control user access at entity level.

setAutoDeleteOnIdle

public void setAutoDeleteOnIdle(Duration autoDeleteOnIdle)

Parameters:

autoDeleteOnIdle -

• The idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.

setDefaultMessageTimeToLive

public void setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)

Parameters:

defaultMessageTimeToLive -

• Sets the default message time to live value. Value cannot be lower than 1 second. See getDefaultMessageTimeToLive()

setDuplicationDetectionHistoryTimeWindow

public void setDuplicationDetectionHistoryTimeWindow(Duration duplicationDetectionHistoryTimeWindow)

Parameters:

duplicationDetectionHistoryTimeWindow -

• The duration of duplicate detection history that is maintained by the service. Max value is 1 day and minimum is 20 seconds.

setEnableBatchedOperations

public void setEnableBatchedOperations(boolean enableBatchedOperations)

Parameters:

enableBatchedOperations -

• Indicates whether server-side batched operations are enabled.

setEnablePartitioning

public void setEnablePartitioning(boolean enablePartitioning)

Parameters:

enablePartitioning -

• true if topic is to be partitioned across multiple message brokers.

setEntityStatus

public void setEntityStatus(EntityStatus status)

Parameters:

status -

• the status of the topic (Enabled / Disabled). When an entity is disabled, that entity cannot send or receive messages.

setMaxSizeInMB

public void setMaxSizeInMB(long maxSize)

Parameters:

maxSize -

• Sets the maximum size of the topic in megabytes, which is the size of memory allocated for the topic.

setRequiresDuplicateDetection

public void setRequiresDuplicateDetection(boolean requiresDuplicateDetection)

Parameters:

requiresDuplicateDetection -

• Set to true if duplicate detection needs to be enabled. See also - isRequiresDuplicateDetection()

setSupportOrdering

public void setSupportOrdering(boolean supportOrdering)

Parameters:

supportOrdering -

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

setUserMetadata

public void setUserMetadata(String userMetadata)

Parameters:

userMetadata -

• Custom metdata that user can associate with the description. Cannot be null. Max length is 1024 chars