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

QueueDescription Class

Represents the metadata description of the queue.

System.Object
  Microsoft.ServiceBus.Messaging.EntityDescription
    Microsoft.ServiceBus.Messaging.QueueDescription

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

The QueueDescription type exposes the following members.

  Name Description
Public method QueueDescription Initializes a new instance of the QueueDescription class with the specified relative path.
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 DuplicateDetectionHistoryTimeWindow Gets or sets the TimeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
Public property EnableBatchedOperations Gets or sets a value that indicates whether server-side batched operations are enabled.
Public property EnableDeadLetteringOnMessageExpiration Gets or sets a value that indicates whether this queue 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 duration of a peek lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.
Public property MaxDeliveryCount Gets or sets the maximum delivery count. A message is automatically deadlettered after this number of deliveries.
Public property MaxSizeInMegabytes Gets or sets the maximum size in megabytes, which is the size of memory allocated for the queue.
Public property MessageCount Gets the number of messages in the queue.
Public property Path Gets the name of the queue.
Public property RequiresDuplicateDetection Gets or sets the value indicating if this queue requires duplicate detection.
Public property RequiresSession Gets or sets a value that indicates whether the queue supports the concept of session.
Public property SizeInBytes Gets the size of the queue in bytes.
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 MYQUEUE is the same as myqueue. 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)