QueueDescription Class

Definition

Namespace:

Microsoft.ServiceBus.Messaging

Assembly:

Microsoft.ServiceBus.dll

Package:

WindowsAzure.ServiceBus v6.2.2

Represents the metadata description of the queue.

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

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

Public NotInheritable Class QueueDescription
Inherits EntityDescription

Inheritance

Object

EntityDescription

QueueDescription

Attributes

DataContractAttribute

Constructors

QueueDescription(String)

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

Fields

MessageTimeToLiveDefaultValue

The message time to live default value in bytes

Properties

AccessedAt	Gets the last time a message was sent, or the last time there was a receive request to this queue.
Authorization	Gets the AuthorizationRules.
AutoDeleteOnIdle	Gets or sets the TimeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.
AvailabilityStatus	Gets the entity availability status for the queue.
CreatedAt	Gets the exact time the message was created.
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 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.A message can have a lower TimeToLive value than that specified here, but by default TimeToLive is set to MaxValue. Therefore, this property becomes the default time to live value applied to messages.
DuplicateDetectionHistoryTimeWindow	Gets or sets the TimeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
EnableBatchedOperations	Gets or sets a value that indicates whether server-side batched operations are enabled.
EnableDeadLetteringOnMessageExpiration	Gets or sets a value that indicates whether this queue has dead letter support when a message expires.
EnableExpress	Gets or sets a value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage.
EnablePartitioning	Gets or sets a value that indicates whether the queue to be partitioned across multiple message brokers is enabled.
ExtensionData	Gets or sets the structure that contains extra data. (Inherited from EntityDescription)
ForwardDeadLetteredMessagesTo	Gets or sets the path to the recipient to which the dead lettered message is forwarded.
ForwardTo	Gets or sets the path to the recipient to which the message is forwarded.
IsAnonymousAccessible	Gets or sets a value that indicates whether the message is anonymous accessible.
IsReadOnly	Gets or sets a value that indicates whether the entity description is read-only. (Inherited from EntityDescription)
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.
MaxDeliveryCount	Gets or sets the maximum delivery count. A message is automatically deadlettered after this number of deliveries.
MaxSizeInMegabytes	Gets or sets the maximum size of the queue in megabytes, which is the size of memory allocated for the queue.
MessageCount	Gets the number of messages in the queue.
MessageCountDetails	Gets message details for a queue.
Path	Gets or sets the name of the queue.
RequiresDuplicateDetection	Gets or sets the value indicating if this queue requires duplicate detection.
RequiresSession	Gets or sets a value that indicates whether the queue supports the concept of session.
SizeInBytes	Gets the size of the queue in bytes.
Status	Gets or sets the current status of the queue (enabled or disabled). When an entity is disabled, that entity cannot send or receive messages.
SupportOrdering	Gets or sets a value that indicates whether the queue supports ordering.
UpdatedAt	Gets the exact time the message has been updated.
UserMetadata	Gets or sets the user metadata.

Methods

ThrowIfReadOnly()

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