SALES: 1-800-867-1380

QueueDescription Class

 

Represents the metadata description of the queue.

Namespace:   Microsoft.ServiceBus.Messaging
Assembly:  Microsoft.ServiceBus (in Microsoft.ServiceBus.dll)

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

No code example is currently available or this language may not be supported.

NameDescription
System_CAPS_pubmethodQueueDescription(String)

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

NameDescription
System_CAPS_pubpropertyAccessedAt

Gets the last time a message was sent, or the last time there was a receive request to this queue.

System_CAPS_pubpropertyAuthorization
System_CAPS_pubpropertyAutoDeleteOnIdle

Gets or sets the TimeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.

System_CAPS_pubpropertyAvailabilityStatus

Gets the entity availability status for the queue.

System_CAPS_pubpropertyCreatedAt

Gets the exact time the message was created.

System_CAPS_pubpropertyDefaultMessageTimeToLive

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 T:System.TimeSpan.MaxValue. Therefore, this property becomes the default time to live value applied to messages.

System_CAPS_pubpropertyDuplicateDetectionHistoryTimeWindow

Gets or sets the TimeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.

System_CAPS_pubpropertyEnableBatchedOperations

Gets or sets a value that indicates whether server-side batched operations are enabled.

System_CAPS_pubpropertyEnableDeadLetteringOnMessageExpiration

Gets or sets a value that indicates whether this queue has dead letter support when a message expires.

System_CAPS_pubpropertyEnableExpress

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.

System_CAPS_pubpropertyEnablePartitioning

Gets or sets a value that indicates whether the queue to be partitioned across multiple message brokers is enabled.

System_CAPS_pubpropertyExtensionData

Gets or sets the structure that contains extra data.(Inherited from EntityDescription.)

System_CAPS_pubpropertyForwardDeadLetteredMessagesTo

Gets or sets the path to the recipient to which the dead lettered message is forwarded.

System_CAPS_pubpropertyForwardTo

Gets or sets the path to the recipient to which the message is forwarded.

System_CAPS_pubpropertyIsAnonymousAccessible

Gets or sets a value that indicates whether the message is anonymous accessible.

System_CAPS_pubpropertyIsReadOnly

Gets or sets a value that indicates whether the entity description is read-only.(Inherited from EntityDescription.)

System_CAPS_pubpropertyLockDuration

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.

System_CAPS_pubpropertyMaxDeliveryCount

Gets or sets the maximum delivery count. A message is automatically deadlettered after this number of deliveries.

System_CAPS_pubpropertyMaxSizeInMegabytes

Gets or sets the maximum size of the queue in megabytes, which is the size of memory allocated for the queue.

System_CAPS_pubpropertyMessageCount

Gets the number of messages in the queue.

System_CAPS_pubpropertyMessageCountDetails

Gets message details for a queue.

System_CAPS_pubpropertyPath

Gets or sets the name of the queue.

System_CAPS_pubpropertyRequiresDuplicateDetection

Gets or sets the value indicating if this queue requires duplicate detection.

System_CAPS_pubpropertyRequiresSession

Gets or sets a value that indicates whether the queue supports the concept of session.

System_CAPS_pubpropertySizeInBytes

Gets the size of the queue in bytes.

System_CAPS_pubpropertyStatus

Gets or sets the current status of the queue (enabled or disabled). When an entity is disabled, that entity cannot send or receive messages.

System_CAPS_pubpropertySupportOrdering

Gets or sets a value that indicates whether the queue supports ordering.

System_CAPS_pubpropertyUpdatedAt

Gets the exact time the message has been updated.

System_CAPS_pubpropertyUserMetadata

Gets or sets the user metadata.

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticMessageTimeToLiveDefaultValue

Specifies the message time to live default value.

System_CAPS_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.

Return to top
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft