Class QueueDescription

Namespace

Microsoft.ServiceBus.Messaging

Assembly

Microsoft.ServiceBus.dll

Represents the metadata description of the queue.

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

Inheritance

object

EntityDescription

QueueDescription

Implements

IExtensibleDataObject

Inherited Members

EntityDescription.IsReadOnly

EntityDescription.ExtensionData

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

QueueDescription(string)

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

public QueueDescription(string path)

Parameters

path string

Path of the queue relative to the namespace base address.

Fields

MessageTimeToLiveDefaultValue

The message time to live default value in bytes

public static readonly TimeSpan MessageTimeToLiveDefaultValue

Field Value

TimeSpan

Properties

AccessedAt

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

public DateTime AccessedAt { get; }

Property Value

DateTime

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

Authorization

Gets the AuthorizationRules.

public AuthorizationRules Authorization { get; }

Property Value

AuthorizationRules

The AuthorizationRules.

AutoDeleteOnIdle

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

public TimeSpan AutoDeleteOnIdle { get; set; }

Property Value

TimeSpan

The auto delete on idle time span for the queue.

AvailabilityStatus

Gets the entity availability status for the queue.

public EntityAvailabilityStatus AvailabilityStatus { get; }

Property Value

EntityAvailabilityStatus

The entity availability status for the queue.

CreatedAt

Gets the exact time the message was created.

public DateTime CreatedAt { get; }

Property Value

DateTime

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

public TimeSpan DefaultMessageTimeToLive { get; set; }

Property Value

TimeSpan

The default message time to live value.

DuplicateDetectionHistoryTimeWindow

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

public TimeSpan DuplicateDetectionHistoryTimeWindow { get; set; }

Property Value

TimeSpan

The TimeSpan structure that represents the time windows for duplication detection history.

EnableBatchedOperations

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

public bool EnableBatchedOperations { get; set; }

Property Value

bool

true if the batched operations are enabled; otherwise, false.

EnableDeadLetteringOnMessageExpiration

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

public bool EnableDeadLetteringOnMessageExpiration { get; set; }

Property Value

bool

true if the queue has a dead letter support when a message expires; otherwise, false.

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.

public bool EnableExpress { get; set; }

Property Value

bool

true if Express Entities are enabled; otherwise, false.

EnablePartitioning

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

public bool EnablePartitioning { get; set; }

Property Value

bool

true if the queue to be partitioned across multiple message brokers is enabled; otherwise, false.

ForwardDeadLetteredMessagesTo

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

public string ForwardDeadLetteredMessagesTo { get; set; }

Property Value

string

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.

public string ForwardTo { get; set; }

Property Value

string

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.

public bool IsAnonymousAccessible { get; set; }

Property Value

bool

true if the message is anonymous accessible; otherwise, false.

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 TimeSpan LockDuration { get; set; }

Property Value

TimeSpan

The duration of the lock.

MaxDeliveryCount

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

public int MaxDeliveryCount { get; set; }

Property Value

int

The number of maximum deliveries.

MaxSizeInMegabytes

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

public long MaxSizeInMegabytes { get; set; }

Property Value

long

The maximum size of the queue in megabytes.

MessageCount

Gets the number of messages in the queue.

public long MessageCount { get; }

Property Value

long

The number of messages.

MessageCountDetails

Gets message details for a queue.

public MessageCountDetails MessageCountDetails { get; }

Property Value

MessageCountDetails

Returns MessageCountDetails with the number of active messages, dead letters, scheduled messages, messages transferred to other queues, subscriptions, or topics, and the number of messages transferred to the dead letter queue.

Path

Gets or sets the name of the queue.

public string Path { get; set; }

Property Value

string

The name of the queue.

Remarks

This is a relative path to the Address.

RequiresDuplicateDetection

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

public bool RequiresDuplicateDetection { get; set; }

Property Value

bool

true if this queue requires duplicate detection; otherwise, false.

RequiresSession

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

public bool RequiresSession { get; set; }

Property Value

bool

true if the receiver application can only receive from the queue through a MessageSession; false if a queue cannot receive using MessageSession.

SizeInBytes

Gets the size of the queue in bytes.

public long SizeInBytes { get; }

Property Value

long

The size of the queue.

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.

public EntityStatus Status { get; set; }

Property Value

EntityStatus

The current status of the queue.

SupportOrdering

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

public bool SupportOrdering { get; set; }

Property Value

bool

true if the queue supports ordering; otherwise, false.

UpdatedAt

Gets the exact time the message has been updated.

public DateTime UpdatedAt { get; }

Property Value

DateTime

The time the message has been updated.

UserMetadata

Gets or sets the user metadata.

public string UserMetadata { get; set; }

Property Value

string

The user metadata.