Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

SubscriptionDescription Class

Represents a description of the subscription.

System.Object
  Microsoft.ServiceBus.Messaging.EntityDescription
    Microsoft.ServiceBus.Messaging.SubscriptionDescription

Namespace:  Microsoft.ServiceBus.Messaging
Assembly:  Microsoft.ServiceBus (in Microsoft.ServiceBus.dll)
C#
C++
F#
JScript
VB
Copy 
[DataContractAttribute(Name = "SubscriptionDescription", Namespace = "http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")]
public sealed class SubscriptionDescription : EntityDescription

The SubscriptionDescription type exposes the following members.

  Name Description
Public method SubscriptionDescription Initializes a new instance of the SubscriptionDescription class.
Top
  Name Description
Public property DefaultMessageTimeToLive Gets or sets the default message time to live value. 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 property EnableBatchedOperations Gets or sets a value that indicates whether the batched operations are enabled.
Public property EnableDeadLetteringOnFilterEvaluationExceptions Gets or sets the value that indicates if a subscription has dead letter support on Filter evaluation exceptions.
Public property EnableDeadLetteringOnMessageExpiration Gets or sets the value that indicates if a subscription has dead letter support when a message expires.
Public property ExtensionData Gets or sets the structure that contains extra data. (Inherited from EntityDescription.)
Public property IsReadOnly Gets or sets a value that indicates whether the entity description is read-only. (Inherited from EntityDescription.)
Public property LockDuration Gets or sets the lock duration time span for the subscription.
Public property MaxDeliveryCount Gets or sets the number of maximum deliveries.
Public property MessageCount Gets the number of messages.
Public property Name Gets the name of the subscription description.
Public property RequiresSession Gets or sets the value indicating if a subscription supports the concept of session.
Public property TopicPath Gets the path of the topic that this subscription description belongs to.
Top
  Name Description
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method ThrowIfReadOnly Throws an exception if the entity description is read-only. (Inherited from EntityDescription.)
Public method ToString (Inherited from Object.)
Top
  Name Description
Public field Static member MessageTimeToLiveDefaultValue Specifies the message time to live default value.
Top
Note Note

Entity names are case-insensitive; for example MYSUBSCRIPTION is the same as mysubscription. 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)