TopicDescription Class

Definition

Namespace:

Microsoft.ServiceBus.Messaging

Assembly:

Microsoft.ServiceBus.dll

Package:

WindowsAzure.ServiceBus v6.2.2

Represents a description of the topic.

[System.Runtime.Serialization.DataContract(Name="TopicDescription", Namespace="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")]
public sealed class TopicDescription : Microsoft.ServiceBus.Messaging.EntityDescription

[<System.Runtime.Serialization.DataContract(Name="TopicDescription", Namespace="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")>]
type TopicDescription = class
    inherit EntityDescription

Public NotInheritable Class TopicDescription
Inherits EntityDescription

Inheritance

Object

EntityDescription

TopicDescription

Attributes

DataContractAttribute

Constructors

TopicDescription(String)

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

Fields

MessageTimeToLiveDefaultValue

The message time to live default value

Properties

AccessedAt	Gets the time and date at which a message was last sent to the topic.
Authorization	Gets the authorization rules for the description.
AutoDeleteOnIdle	Gets or sets the TimeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
AvailabilityStatus	Gets the status of the availability of this instance.
CreatedAt	Gets the time and date when the topic was created.
DefaultMessageTimeToLive	Gets or sets the default message time to live value for a topic. This is the duration after which the message expires, starting from when the message is sent to the Service Bus. This is the default value used when TimeToLive 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.
DuplicateDetectionHistoryTimeWindow	Gets or sets the TimeSpan structure that defines the duration of the duplicate detection history.
EnableBatchedOperations	Gets or sets a value that indicates whether server-side batched operations are enabled.
EnableExpress	Gets or sets a value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.
EnableFilteringMessagesBeforePublishing	Gets or sets whether messages should be filtered before publishing.
EnablePartitioning	Gets or sets whether to enable the topic to be partitioned across multiple message brokers. An express topic holds a message in memory temporarily before writing it to persistent storage.
ExtensionData	Gets or sets the structure that contains extra data. (Inherited from EntityDescription)
IsAnonymousAccessible	Gets whether anonymous access is allowed.
IsReadOnly	Gets or sets a value that indicates whether the entity description is read-only. (Inherited from EntityDescription)
MaxSizeInMegabytes	Gets or sets the maximum size of the topic in megabytes, which is the size of memory allocated for the topic.
MessageCountDetails	Gets message details about the topic.
Path	Gets the path of the topic.
RequiresDuplicateDetection	Gets or sets the value that indicates whether a topic requires duplication detection.
SizeInBytes	Gets the size of the topic in bytes.
Status	Gets or sets the current status of the topic (enabled or disabled). When an entity is disabled, that entity cannot send or receive messages.
SubscriptionCount	Gets then number of subscriptions.
SupportOrdering	Gets or sets the support ordering method.
UpdatedAt	Gets the time and date when the topic was updated.
UserMetadata	Gets or sets the user metadata associated with the description.

Methods

ThrowIfReadOnly()

Throws an exception if the entity description is read-only. (Inherited from EntityDescription)