QueueDescription QueueDescription QueueDescription Class

Definition

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
type QueueDescription = class
    inherit EntityDescription
    interface IResourceDescription
Public NotInheritable Class QueueDescription
Inherits EntityDescription
Inheritance
QueueDescriptionQueueDescriptionQueueDescription
Attributes

Constructors

QueueDescription(String) QueueDescription(String) QueueDescription(String)

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

Fields

MessageTimeToLiveDefaultValue MessageTimeToLiveDefaultValue MessageTimeToLiveDefaultValue

The message time to live default value in bytes

Properties

AccessedAt AccessedAt AccessedAt

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

Authorization Authorization Authorization

Gets the AuthorizationRules.

AutoDeleteOnIdle AutoDeleteOnIdle AutoDeleteOnIdle

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

AvailabilityStatus AvailabilityStatus AvailabilityStatus

Gets the entity availability status for the queue.

CreatedAt CreatedAt CreatedAt

Gets the exact time the message was created.

DefaultMessageTimeToLive DefaultMessageTimeToLive 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 DuplicateDetectionHistoryTimeWindow DuplicateDetectionHistoryTimeWindow

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

EnableBatchedOperations EnableBatchedOperations EnableBatchedOperations

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

EnableDeadLetteringOnMessageExpiration EnableDeadLetteringOnMessageExpiration EnableDeadLetteringOnMessageExpiration

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

EnableExpress EnableExpress 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 EnablePartitioning EnablePartitioning

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

ExtensionData ExtensionData ExtensionData Inherited from EntityDescription
ForwardDeadLetteredMessagesTo ForwardDeadLetteredMessagesTo ForwardDeadLetteredMessagesTo

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

ForwardTo ForwardTo ForwardTo

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

IsAnonymousAccessible IsAnonymousAccessible IsAnonymousAccessible

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

IsReadOnly IsReadOnly IsReadOnly Inherited from EntityDescription
LockDuration LockDuration 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 MaxDeliveryCount MaxDeliveryCount

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

MaxSizeInMegabytes MaxSizeInMegabytes MaxSizeInMegabytes

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

MessageCount MessageCount MessageCount

Gets the number of messages in the queue.

MessageCountDetails MessageCountDetails MessageCountDetails

Gets message details for a queue.

Path Path Path

Gets or sets the name of the queue.

RequiresDuplicateDetection RequiresDuplicateDetection RequiresDuplicateDetection

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

RequiresSession RequiresSession RequiresSession

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

SizeInBytes SizeInBytes SizeInBytes

Gets the size of the queue in bytes.

Status Status 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 SupportOrdering SupportOrdering

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

UpdatedAt UpdatedAt UpdatedAt

Gets the exact time the message has been updated.

UserMetadata UserMetadata UserMetadata

Gets or sets the user metadata.

Methods

ThrowIfReadOnly() ThrowIfReadOnly() ThrowIfReadOnly() Inherited from EntityDescription

Extension Methods

IsDefined(Object) IsDefined(Object) IsDefined(Object)

Determines if a certain property is defined or not.

IsNull(Object) IsNull(Object) IsNull(Object)

Determines if a certain property is null or not.

IsPrimitive(Object) IsPrimitive(Object) IsPrimitive(Object)

Determines if a certain property is of premitive JSON type.

Applies to