SALES: 1-800-867-1380
This topic has not yet been rated - Rate this topic

TopicDescription Class

Represents a description of the topic.

System.Object
  Microsoft.ServiceBus.Messaging.EntityDescription
    Microsoft.ServiceBus.Messaging.TopicDescription

Namespace:  Microsoft.ServiceBus.Messaging
Assembly:  Microsoft.ServiceBus (in Microsoft.ServiceBus.dll)
[DataContractAttribute(Name = "TopicDescription", Namespace = "http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")]
public sealed class TopicDescription : EntityDescription

The TopicDescription type exposes the following members.

  NameDescription
Public methodTopicDescriptionInitializes a new instance of the TopicDescription class with the specified relative path.
Top
  NameDescription
Public propertyAccessedAtGets the time and date at which a message was last sent to the topic.
Public propertyAuthorizationGets the authorization rules for the description.
Public propertyAutoDeleteOnIdleGets or sets the TimeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
Public propertyAvailabilityStatusGets the status of the availability of this instance.
Public propertyCreatedAtGets the time and date when the topic was created.
Public propertyDefaultMessageTimeToLiveGets 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.
Public propertyDuplicateDetectionHistoryTimeWindowGets or sets the TimeSpan structure that defines the duration of the duplicate detection history.
Public propertyEnableBatchedOperationsGets or sets a value that indicates whether server-side batched operations are enabled.
Public propertyEnableFilteringMessagesBeforePublishingGets or sets whether messages should be filtered before publishing.
Public propertyEnablePartitioningEnables the topic to be partitioned across multiple message brokers.
Public propertyExtensionDataGets or sets the structure that contains extra data. (Inherited from EntityDescription.)
Public propertyIsAnonymousAccessibleGets whether anonymous access is allowed.
Public propertyIsReadOnlyGets or sets a value that indicates whether the entity description is read-only. (Inherited from EntityDescription.)
Public propertyMaxSizeInMegabytesGets or sets the maximum size of the topic in megabytes, which is the size of memory allocated for the topic.
Public propertyMessageCountDetailsGets message details about the topic.
Public propertyPathGets the path of the topic.
Public propertyRequiresDuplicateDetectionGets or sets the value that indicates whether a topic requires duplication detection.
Public propertySizeInBytesGets the size of the topic in bytes.
Public propertyStatusGets or sets the current status of the topic (enabled or disabled). When an entity is disabled, that entity cannot send or receive messages.
Public propertySubscriptionCountGets then number of subscriptions.
Public propertySupportOrderingGets or sets the support ordering.
Public propertyUpdatedAtGets the time and date when the topic was updated.
Public propertyUserMetadataGets or sets the user metadata associated with the description.
Top
  NameDescription
Public methodEquals (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodToString (Inherited from Object.)
Top
  NameDescription
Public fieldStatic memberMessageTimeToLiveDefaultValueSpecifies the message time to live default value.
Top
NoteNote

Entity names are case-insensitive; for example MYTOPIC is the same as my topic. Therefore, you should use IgnoreCase in any comparison of entity names.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.