Permalink
Fetching contributors…
Cannot retrieve contributors at this time
470 lines (470 sloc) 24.1 KB
<Type Name="TopicDescription" FullName="Microsoft.ServiceBus.Messaging.TopicDescription">
<TypeSignature Language="C#" Value="public sealed class TopicDescription : Microsoft.ServiceBus.Messaging.EntityDescription" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit TopicDescription extends Microsoft.ServiceBus.Messaging.EntityDescription" />
<TypeSignature Language="DocId" Value="T:Microsoft.ServiceBus.Messaging.TopicDescription" />
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.ServiceBus.Messaging.EntityDescription</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName>System.Runtime.Serialization.DataContract(Name="TopicDescription", Namespace="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Represents a description of the topic.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TopicDescription (string path);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string path) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.TopicDescription.#ctor(System.String)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<Parameters>
<Parameter Name="path" Type="System.String" />
</Parameters>
<Docs>
<param name="path">The path of the topic relative to the service namespace base address.</param>
<summary>Initializes a new instance of the
<see cref="T:Microsoft.ServiceBus.Messaging.TopicDescription" /> class with the specified relative path.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AccessedAt">
<MemberSignature Language="C#" Value="public DateTime AccessedAt { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime AccessedAt" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.TopicDescription.AccessedAt" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the time and date at which a message was last sent to the topic.</summary>
<value>The time and date at which a message was last sent to the topic.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Authorization">
<MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.AuthorizationRules Authorization { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.ServiceBus.Messaging.AuthorizationRules Authorization" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.TopicDescription.Authorization" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.Messaging.AuthorizationRules</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the authorization rules for the description.</summary>
<value>The authorization rules for the description.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AutoDeleteOnIdle">
<MemberSignature Language="C#" Value="public TimeSpan AutoDeleteOnIdle { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan AutoDeleteOnIdle" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.TopicDescription.AutoDeleteOnIdle" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the
<see cref="T:System.TimeSpan" /> idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.</summary>
<value>The auto delete on idle time span for the topic.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AvailabilityStatus">
<MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.EntityAvailabilityStatus AvailabilityStatus { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.ServiceBus.Messaging.EntityAvailabilityStatus AvailabilityStatus" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.TopicDescription.AvailabilityStatus" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.Messaging.EntityAvailabilityStatus</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the status of the availability of this instance.</summary>
<value>The status of the availability of this instance.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreatedAt">
<MemberSignature Language="C#" Value="public DateTime CreatedAt { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime CreatedAt" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.TopicDescription.CreatedAt" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the time and date when the topic was created.</summary>
<value>The time and date when the topic was created.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DefaultMessageTimeToLive">
<MemberSignature Language="C#" Value="public TimeSpan DefaultMessageTimeToLive { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan DefaultMessageTimeToLive" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.TopicDescription.DefaultMessageTimeToLive" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>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
<see cref="P:Microsoft.ServiceBus.Messaging.BrokeredMessage.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.</summary>
<value>The default message time to live for a topic.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DuplicateDetectionHistoryTimeWindow">
<MemberSignature Language="C#" Value="public TimeSpan DuplicateDetectionHistoryTimeWindow { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan DuplicateDetectionHistoryTimeWindow" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.TopicDescription.DuplicateDetectionHistoryTimeWindow" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the <see cref="T:System.TimeSpan" /> structure that defines the duration of the duplicate detection history.</summary>
<value>The <see cref="T:System.TimeSpan" /> structure that defines the duration of the duplicate detection history.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EnableBatchedOperations">
<MemberSignature Language="C#" Value="public bool EnableBatchedOperations { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool EnableBatchedOperations" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.TopicDescription.EnableBatchedOperations" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that indicates whether server-side batched operations are enabled.</summary>
<value>true if the batched operations are enabled; otherwise, false.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EnableExpress">
<MemberSignature Language="C#" Value="public bool EnableExpress { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool EnableExpress" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.TopicDescription.EnableExpress" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>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.</summary>
<value>true if the Express Entities are enabled; otherwise, false.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EnableFilteringMessagesBeforePublishing">
<MemberSignature Language="C#" Value="public bool EnableFilteringMessagesBeforePublishing { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool EnableFilteringMessagesBeforePublishing" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.TopicDescription.EnableFilteringMessagesBeforePublishing" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets whether messages should be filtered before publishing.</summary>
<value>true if message filtering is enabled before publishing; otherwise, false.</value>
<remarks> This feature is recommended to be used only for development and testing purposes.
For example, when new Rules or Filters are being added to the topic, this feature can
be used to verify that the new filter expression is working as expected. Once tested
and working fine, the feature should be turned off in production. </remarks>
<exception cref="T:Microsoft.ServiceBus.Messaging.NoMatchingSubscriptionException">Thrown if the subscriptions do not match.</exception>
</Docs>
</Member>
<Member MemberName="EnablePartitioning">
<MemberSignature Language="C#" Value="public bool EnablePartitioning { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool EnablePartitioning" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.TopicDescription.EnablePartitioning" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>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.</summary>
<value>true to enable the topic to be partitioned across multiple message brokers; otherwise, false.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsAnonymousAccessible">
<MemberSignature Language="C#" Value="public bool IsAnonymousAccessible { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsAnonymousAccessible" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.TopicDescription.IsAnonymousAccessible" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets whether anonymous access is allowed.</summary>
<value>true if anonymous access is allowed; otherwise, false.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxSizeInMegabytes">
<MemberSignature Language="C#" Value="public long MaxSizeInMegabytes { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 MaxSizeInMegabytes" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.TopicDescription.MaxSizeInMegabytes" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the maximum size of the topic in megabytes, which is the size of memory allocated for the topic.</summary>
<value>The maximum size in megabytes.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MessageCountDetails">
<MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.MessageCountDetails MessageCountDetails { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.ServiceBus.Messaging.MessageCountDetails MessageCountDetails" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.TopicDescription.MessageCountDetails" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.Messaging.MessageCountDetails</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets message details about the topic.</summary>
<value>The
<see cref="T:Microsoft.ServiceBus.Messaging.MessageCountDetails" /> that contains the number of active messages, dead letters, scheduled messages, messages transferred to other queues, subscriptions, or topics, and the number of messages transferred to the dead letter queue.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MessageTimeToLiveDefaultValue">
<MemberSignature Language="C#" Value="public static readonly TimeSpan MessageTimeToLiveDefaultValue;" />
<MemberSignature Language="ILAsm" Value=".field public static initonly valuetype System.TimeSpan MessageTimeToLiveDefaultValue" />
<MemberSignature Language="DocId" Value="F:Microsoft.ServiceBus.Messaging.TopicDescription.MessageTimeToLiveDefaultValue" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
The message time to live default value
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Path">
<MemberSignature Language="C#" Value="public string Path { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Path" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.TopicDescription.Path" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the path of the topic.</summary>
<value>The path of the topic.</value>
<remarks>
This is a relative path to the <see cref="P:Microsoft.ServiceBus.NamespaceManager.Address" />.
</remarks>
</Docs>
</Member>
<Member MemberName="RequiresDuplicateDetection">
<MemberSignature Language="C#" Value="public bool RequiresDuplicateDetection { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool RequiresDuplicateDetection" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.TopicDescription.RequiresDuplicateDetection" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the value that indicates whether a topic requires duplication detection.</summary>
<value>true if a topic requires duplication detection; otherwise, false.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SizeInBytes">
<MemberSignature Language="C#" Value="public long SizeInBytes { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 SizeInBytes" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.TopicDescription.SizeInBytes" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the size of the topic in bytes.</summary>
<value>The size of the topic in bytes.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Status">
<MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.EntityStatus Status { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.ServiceBus.Messaging.EntityStatus Status" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.TopicDescription.Status" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.Messaging.EntityStatus</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the current status of the topic (enabled or
disabled). When an entity is disabled, that entity cannot send or receive messages.</summary>
<value>The status of the topic.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SubscriptionCount">
<MemberSignature Language="C#" Value="public int SubscriptionCount { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 SubscriptionCount" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.TopicDescription.SubscriptionCount" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets then number of subscriptions.</summary>
<value>An <see cref="T:System.Int32" /> that represents the number of subscriptions.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SupportOrdering">
<MemberSignature Language="C#" Value="public bool SupportOrdering { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool SupportOrdering" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.TopicDescription.SupportOrdering" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the support ordering method.</summary>
<value>The support ordering method.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UpdatedAt">
<MemberSignature Language="C#" Value="public DateTime UpdatedAt { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime UpdatedAt" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.TopicDescription.UpdatedAt" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the time and date when the topic was updated.</summary>
<value>The time and date when the topic was updated.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UserMetadata">
<MemberSignature Language="C#" Value="public string UserMetadata { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string UserMetadata" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.TopicDescription.UserMetadata" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the user metadata associated with the description.</summary>
<value>The user metadata associated with the description.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>