SALES: 1-800-867-1380

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)

[DataContractAttribute(Name = L"QueueDescription", Namespace = L"http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")]
public ref class QueueDescription sealed : public EntityDescription

The QueueDescription type exposes the following members.

  NameDescription
Public methodQueueDescriptionInitializes a new instance of the QueueDescription class with the specified relative path.
Top

  NameDescription
Public propertyAccessedAtGets the last time a message was sent, or the last time there was a receive request to this queue.
Public propertyAuthorizationGets the AuthorizationRules.
Public propertyAutoDeleteOnIdleGets or sets the TimeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.
Public propertyAvailabilityStatusGets the entity availability status for the queue.
Public propertyCreatedAtGets the exact time the message was created.
Public propertyDefaultMessageTimeToLiveGets 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.
Public propertyDuplicateDetectionHistoryTimeWindowGets or sets the TimeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
Public propertyEnableBatchedOperationsGets or sets a value that indicates whether server-side batched operations are enabled.
Public propertyEnableDeadLetteringOnMessageExpirationGets or sets a value that indicates whether this queue has dead letter support when a message expires.
Public propertyEnableExpressGets or sets whether to enable the queue to be partitioned across multiple message brokers. An express queue holds a message in memory temporarily before writing it to persistent storage.
Public propertyEnablePartitioningGets or sets a value that indicates whether the queue to be partitioned across multiple message brokers is enabled.
Public propertyExtensionDataGets or sets the structure that contains extra data. (Inherited from EntityDescription.)
Public propertyForwardDeadLetteredMessagesToGets or sets the path to the recipient to which the dead lettered message is forwarded.
Public propertyForwardToGets or sets the path to the recipient to which the message is forwarded.
Public propertyIsAnonymousAccessibleGets or sets a value that indicates whether the message is anonymous accessible.
Public propertyIsReadOnlyGets or sets a value that indicates whether the entity description is read-only. (Inherited from EntityDescription.)
Public propertyLockDurationGets 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 propertyMaxDeliveryCountGets or sets the maximum delivery count. A message is automatically deadlettered after this number of deliveries.
Public propertyMaxSizeInMegabytesGets or sets the maximum size of the queue in megabytes, which is the size of memory allocated for the queue.
Public propertyMessageCountGets the number of messages in the queue.
Public propertyMessageCountDetailsGets message details for a queue.
Public propertyPathGets or sets the name of the queue.
Public propertyRequiresDuplicateDetectionGets or sets the value indicating if this queue requires duplicate detection.
Public propertyRequiresSessionGets or sets a value that indicates whether the queue supports the concept of session.
Public propertySizeInBytesGets the size of the queue in bytes.
Public propertyStatusGets or sets the current status of the queue (enabled or disabled). When an entity is disabled, that entity cannot send or receive messages.
Public propertySupportOrderingGets or sets a value that indicates whether the queue supports ordering.
Public propertyUpdatedAtGets the exact time the message has been updated.
Public propertyUserMetadataGets or sets the user metadata.
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 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.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft