Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
620 lines (620 sloc) 36.9 KB
<Type Name="QueueDescription" FullName="Microsoft.ServiceBus.Messaging.QueueDescription">
<TypeSignature Language="C#" Value="public sealed class QueueDescription : Microsoft.ServiceBus.Messaging.EntityDescription" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit QueueDescription extends Microsoft.ServiceBus.Messaging.EntityDescription" />
<TypeSignature Language="DocId" Value="T:Microsoft.ServiceBus.Messaging.QueueDescription" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class QueueDescription&#xA;Inherits EntityDescription" />
<TypeSignature Language="F#" Value="type QueueDescription = class&#xA; inherit EntityDescription" />
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.ServiceBus.Messaging.EntityDescription</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName>System.Runtime.Serialization.DataContract(Name="QueueDescription", Namespace="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Represents the metadata description of the queue.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public QueueDescription (string path);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string path) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.QueueDescription.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (path As String)" />
<MemberSignature Language="F#" Value="new Microsoft.ServiceBus.Messaging.QueueDescription : string -&gt; Microsoft.ServiceBus.Messaging.QueueDescription" Usage="new Microsoft.ServiceBus.Messaging.QueueDescription path" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="path" Type="System.String" />
</Parameters>
<Docs>
<param name="path">Path of the queue relative to the namespace base address.</param>
<summary>Initializes a new instance of the
<see cref="T:Microsoft.ServiceBus.Messaging.QueueDescription" /> class with the specified relative path.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AccessedAt">
<MemberSignature Language="C#" Value="public DateTime AccessedAt { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime AccessedAt" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.QueueDescription.AccessedAt" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property AccessedAt As DateTime" />
<MemberSignature Language="F#" Value="member this.AccessedAt : DateTime" Usage="Microsoft.ServiceBus.Messaging.QueueDescription.AccessedAt" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the last time a message was sent, or the last time there was a receive request to this queue.</summary>
<value>The last time a message was sent, or the last time there was a receive request to this queue.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Authorization">
<MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.AuthorizationRules Authorization { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.ServiceBus.Messaging.AuthorizationRules Authorization" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.QueueDescription.Authorization" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Authorization As AuthorizationRules" />
<MemberSignature Language="F#" Value="member this.Authorization : Microsoft.ServiceBus.Messaging.AuthorizationRules" Usage="Microsoft.ServiceBus.Messaging.QueueDescription.Authorization" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.Messaging.AuthorizationRules</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the <see cref="T:Microsoft.ServiceBus.Messaging.AuthorizationRules" />.</summary>
<value>The <see cref="T:Microsoft.ServiceBus.Messaging.AuthorizationRules" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AutoDeleteOnIdle">
<MemberSignature Language="C#" Value="public TimeSpan AutoDeleteOnIdle { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan AutoDeleteOnIdle" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.QueueDescription.AutoDeleteOnIdle" />
<MemberSignature Language="VB.NET" Value="Public Property AutoDeleteOnIdle As TimeSpan" />
<MemberSignature Language="F#" Value="member this.AutoDeleteOnIdle : TimeSpan with get, set" Usage="Microsoft.ServiceBus.Messaging.QueueDescription.AutoDeleteOnIdle" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the
<see cref="T:System.TimeSpan" /> idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.</summary>
<value>The auto delete on idle time span for the queue.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AvailabilityStatus">
<MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.EntityAvailabilityStatus AvailabilityStatus { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.ServiceBus.Messaging.EntityAvailabilityStatus AvailabilityStatus" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.QueueDescription.AvailabilityStatus" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property AvailabilityStatus As EntityAvailabilityStatus" />
<MemberSignature Language="F#" Value="member this.AvailabilityStatus : Microsoft.ServiceBus.Messaging.EntityAvailabilityStatus" Usage="Microsoft.ServiceBus.Messaging.QueueDescription.AvailabilityStatus" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.Messaging.EntityAvailabilityStatus</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the entity availability status for the queue.</summary>
<value>The entity availability status for the queue.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreatedAt">
<MemberSignature Language="C#" Value="public DateTime CreatedAt { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime CreatedAt" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.QueueDescription.CreatedAt" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property CreatedAt As DateTime" />
<MemberSignature Language="F#" Value="member this.CreatedAt : DateTime" Usage="Microsoft.ServiceBus.Messaging.QueueDescription.CreatedAt" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the exact time the message was created.</summary>
<value>The time the message was created.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DefaultMessageTimeToLive">
<MemberSignature Language="C#" Value="public TimeSpan DefaultMessageTimeToLive { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan DefaultMessageTimeToLive" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.QueueDescription.DefaultMessageTimeToLive" />
<MemberSignature Language="VB.NET" Value="Public Property DefaultMessageTimeToLive As TimeSpan" />
<MemberSignature Language="F#" Value="member this.DefaultMessageTimeToLive : TimeSpan with get, set" Usage="Microsoft.ServiceBus.Messaging.QueueDescription.DefaultMessageTimeToLive" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>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
<see cref="P:Microsoft.ServiceBus.Messaging.BrokeredMessage.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
<see cref="F:System.TimeSpan.MaxValue" />. Therefore, this property becomes the default time to live value applied to messages.</summary>
<value>The default message time to live value.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DuplicateDetectionHistoryTimeWindow">
<MemberSignature Language="C#" Value="public TimeSpan DuplicateDetectionHistoryTimeWindow { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan DuplicateDetectionHistoryTimeWindow" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.QueueDescription.DuplicateDetectionHistoryTimeWindow" />
<MemberSignature Language="VB.NET" Value="Public Property DuplicateDetectionHistoryTimeWindow As TimeSpan" />
<MemberSignature Language="F#" Value="member this.DuplicateDetectionHistoryTimeWindow : TimeSpan with get, set" Usage="Microsoft.ServiceBus.Messaging.QueueDescription.DuplicateDetectionHistoryTimeWindow" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the
<see cref="T:System.TimeSpan" /> structure that defines the duration of the duplicate detection history. The default value is 10 minutes.</summary>
<value>The <see cref="T:System.TimeSpan" /> structure that represents the time windows for duplication detection history.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EnableBatchedOperations">
<MemberSignature Language="C#" Value="public bool EnableBatchedOperations { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool EnableBatchedOperations" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.QueueDescription.EnableBatchedOperations" />
<MemberSignature Language="VB.NET" Value="Public Property EnableBatchedOperations As Boolean" />
<MemberSignature Language="F#" Value="member this.EnableBatchedOperations : bool with get, set" Usage="Microsoft.ServiceBus.Messaging.QueueDescription.EnableBatchedOperations" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that indicates whether server-side batched operations are enabled.</summary>
<value>true if the batched operations are enabled; otherwise, false.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EnableDeadLetteringOnMessageExpiration">
<MemberSignature Language="C#" Value="public bool EnableDeadLetteringOnMessageExpiration { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool EnableDeadLetteringOnMessageExpiration" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.QueueDescription.EnableDeadLetteringOnMessageExpiration" />
<MemberSignature Language="VB.NET" Value="Public Property EnableDeadLetteringOnMessageExpiration As Boolean" />
<MemberSignature Language="F#" Value="member this.EnableDeadLetteringOnMessageExpiration : bool with get, set" Usage="Microsoft.ServiceBus.Messaging.QueueDescription.EnableDeadLetteringOnMessageExpiration" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that indicates whether this queue has dead letter support when a message expires.</summary>
<value>true if the queue has a dead letter support when a message expires; otherwise, false.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EnableExpress">
<MemberSignature Language="C#" Value="public bool EnableExpress { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool EnableExpress" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.QueueDescription.EnableExpress" />
<MemberSignature Language="VB.NET" Value="Public Property EnableExpress As Boolean" />
<MemberSignature Language="F#" Value="member this.EnableExpress : bool with get, set" Usage="Microsoft.ServiceBus.Messaging.QueueDescription.EnableExpress" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>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.</summary>
<value>true if Express Entities are enabled; otherwise, false.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EnablePartitioning">
<MemberSignature Language="C#" Value="public bool EnablePartitioning { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool EnablePartitioning" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.QueueDescription.EnablePartitioning" />
<MemberSignature Language="VB.NET" Value="Public Property EnablePartitioning As Boolean" />
<MemberSignature Language="F#" Value="member this.EnablePartitioning : bool with get, set" Usage="Microsoft.ServiceBus.Messaging.QueueDescription.EnablePartitioning" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that indicates whether the queue to be partitioned across multiple message brokers is enabled. </summary>
<value>true if the queue to be partitioned across multiple message brokers is enabled; otherwise, false.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ForwardDeadLetteredMessagesTo">
<MemberSignature Language="C#" Value="public string ForwardDeadLetteredMessagesTo { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ForwardDeadLetteredMessagesTo" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.QueueDescription.ForwardDeadLetteredMessagesTo" />
<MemberSignature Language="VB.NET" Value="Public Property ForwardDeadLetteredMessagesTo As String" />
<MemberSignature Language="F#" Value="member this.ForwardDeadLetteredMessagesTo : string with get, set" Usage="Microsoft.ServiceBus.Messaging.QueueDescription.ForwardDeadLetteredMessagesTo" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the path to the recipient to which the dead lettered message is forwarded.</summary>
<value>The path to the recipient to which the dead lettered message is forwarded.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ForwardTo">
<MemberSignature Language="C#" Value="public string ForwardTo { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ForwardTo" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.QueueDescription.ForwardTo" />
<MemberSignature Language="VB.NET" Value="Public Property ForwardTo As String" />
<MemberSignature Language="F#" Value="member this.ForwardTo : string with get, set" Usage="Microsoft.ServiceBus.Messaging.QueueDescription.ForwardTo" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the path to the recipient to which the message is forwarded.</summary>
<value>The path to the recipient to which the message is forwarded.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsAnonymousAccessible">
<MemberSignature Language="C#" Value="public bool IsAnonymousAccessible { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsAnonymousAccessible" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.QueueDescription.IsAnonymousAccessible" />
<MemberSignature Language="VB.NET" Value="Public Property IsAnonymousAccessible As Boolean" />
<MemberSignature Language="F#" Value="member this.IsAnonymousAccessible : bool with get, set" Usage="Microsoft.ServiceBus.Messaging.QueueDescription.IsAnonymousAccessible" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that indicates whether the message is anonymous accessible.</summary>
<value>true if the message is anonymous accessible; otherwise, false.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LockDuration">
<MemberSignature Language="C#" Value="public TimeSpan LockDuration { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan LockDuration" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.QueueDescription.LockDuration" />
<MemberSignature Language="VB.NET" Value="Public Property LockDuration As TimeSpan" />
<MemberSignature Language="F#" Value="member this.LockDuration : TimeSpan with get, set" Usage="Microsoft.ServiceBus.Messaging.QueueDescription.LockDuration" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>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
<see cref="P:Microsoft.ServiceBus.Messaging.QueueDescription.LockDuration" /> is 5 minutes; the default value is 1 minute.</summary>
<value>The duration of the lock.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxDeliveryCount">
<MemberSignature Language="C#" Value="public int MaxDeliveryCount { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MaxDeliveryCount" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.QueueDescription.MaxDeliveryCount" />
<MemberSignature Language="VB.NET" Value="Public Property MaxDeliveryCount As Integer" />
<MemberSignature Language="F#" Value="member this.MaxDeliveryCount : int with get, set" Usage="Microsoft.ServiceBus.Messaging.QueueDescription.MaxDeliveryCount" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the maximum delivery count. A message is automatically deadlettered after this number of deliveries.</summary>
<value>The number of maximum deliveries.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxSizeInMegabytes">
<MemberSignature Language="C#" Value="public long MaxSizeInMegabytes { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 MaxSizeInMegabytes" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.QueueDescription.MaxSizeInMegabytes" />
<MemberSignature Language="VB.NET" Value="Public Property MaxSizeInMegabytes As Long" />
<MemberSignature Language="F#" Value="member this.MaxSizeInMegabytes : int64 with get, set" Usage="Microsoft.ServiceBus.Messaging.QueueDescription.MaxSizeInMegabytes" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the maximum size of the queue in megabytes, which is the size of memory allocated for the queue.</summary>
<value>The maximum size of the queue in megabytes.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MessageCount">
<MemberSignature Language="C#" Value="public long MessageCount { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 MessageCount" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.QueueDescription.MessageCount" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property MessageCount As Long" />
<MemberSignature Language="F#" Value="member this.MessageCount : int64" Usage="Microsoft.ServiceBus.Messaging.QueueDescription.MessageCount" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the number of messages in the queue.</summary>
<value>The number of messages.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MessageCountDetails">
<MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.MessageCountDetails MessageCountDetails { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.ServiceBus.Messaging.MessageCountDetails MessageCountDetails" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.QueueDescription.MessageCountDetails" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property MessageCountDetails As MessageCountDetails" />
<MemberSignature Language="F#" Value="member this.MessageCountDetails : Microsoft.ServiceBus.Messaging.MessageCountDetails" Usage="Microsoft.ServiceBus.Messaging.QueueDescription.MessageCountDetails" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.Messaging.MessageCountDetails</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets message details for a queue.</summary>
<value>Returns
<see cref="T:Microsoft.ServiceBus.Messaging.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.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MessageTimeToLiveDefaultValue">
<MemberSignature Language="C#" Value="public static readonly TimeSpan MessageTimeToLiveDefaultValue;" />
<MemberSignature Language="ILAsm" Value=".field public static initonly valuetype System.TimeSpan MessageTimeToLiveDefaultValue" />
<MemberSignature Language="DocId" Value="F:Microsoft.ServiceBus.Messaging.QueueDescription.MessageTimeToLiveDefaultValue" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly MessageTimeToLiveDefaultValue As TimeSpan " />
<MemberSignature Language="F#" Value=" staticval mutable MessageTimeToLiveDefaultValue : TimeSpan" Usage="Microsoft.ServiceBus.Messaging.QueueDescription.MessageTimeToLiveDefaultValue" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
The message time to live default value in bytes
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Path">
<MemberSignature Language="C#" Value="public string Path { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Path" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.QueueDescription.Path" />
<MemberSignature Language="VB.NET" Value="Public Property Path As String" />
<MemberSignature Language="F#" Value="member this.Path : string with get, set" Usage="Microsoft.ServiceBus.Messaging.QueueDescription.Path" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the name of the queue.</summary>
<value>The name of the queue.</value>
<remarks>
This is a relative path to the <see cref="P:Microsoft.ServiceBus.NamespaceManager.Address" />.
</remarks>
</Docs>
</Member>
<Member MemberName="RequiresDuplicateDetection">
<MemberSignature Language="C#" Value="public bool RequiresDuplicateDetection { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool RequiresDuplicateDetection" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.QueueDescription.RequiresDuplicateDetection" />
<MemberSignature Language="VB.NET" Value="Public Property RequiresDuplicateDetection As Boolean" />
<MemberSignature Language="F#" Value="member this.RequiresDuplicateDetection : bool with get, set" Usage="Microsoft.ServiceBus.Messaging.QueueDescription.RequiresDuplicateDetection" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the value indicating if this queue requires duplicate detection.</summary>
<value>true if this queue requires duplicate detection; otherwise, false.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RequiresSession">
<MemberSignature Language="C#" Value="public bool RequiresSession { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool RequiresSession" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.QueueDescription.RequiresSession" />
<MemberSignature Language="VB.NET" Value="Public Property RequiresSession As Boolean" />
<MemberSignature Language="F#" Value="member this.RequiresSession : bool with get, set" Usage="Microsoft.ServiceBus.Messaging.QueueDescription.RequiresSession" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that indicates whether the queue supports the concept of session.</summary>
<value>true if the receiver application can only receive from the queue through a
<see cref="T:Microsoft.ServiceBus.Messaging.MessageSession" />; false if a queue cannot receive using
<see cref="T:Microsoft.ServiceBus.Messaging.MessageSession" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SizeInBytes">
<MemberSignature Language="C#" Value="public long SizeInBytes { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 SizeInBytes" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.QueueDescription.SizeInBytes" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property SizeInBytes As Long" />
<MemberSignature Language="F#" Value="member this.SizeInBytes : int64" Usage="Microsoft.ServiceBus.Messaging.QueueDescription.SizeInBytes" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the size of the queue in bytes.</summary>
<value>The size of the queue.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Status">
<MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.EntityStatus Status { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.ServiceBus.Messaging.EntityStatus Status" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.QueueDescription.Status" />
<MemberSignature Language="VB.NET" Value="Public Property Status As EntityStatus" />
<MemberSignature Language="F#" Value="member this.Status : Microsoft.ServiceBus.Messaging.EntityStatus with get, set" Usage="Microsoft.ServiceBus.Messaging.QueueDescription.Status" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.Messaging.EntityStatus</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the current status of the queue (enabled or
disabled). When an entity is disabled, that entity cannot send or receive messages.</summary>
<value>The current status of the queue.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SupportOrdering">
<MemberSignature Language="C#" Value="public bool SupportOrdering { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool SupportOrdering" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.QueueDescription.SupportOrdering" />
<MemberSignature Language="VB.NET" Value="Public Property SupportOrdering As Boolean" />
<MemberSignature Language="F#" Value="member this.SupportOrdering : bool with get, set" Usage="Microsoft.ServiceBus.Messaging.QueueDescription.SupportOrdering" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that indicates whether the queue supports ordering.</summary>
<value>true if the queue supports ordering; otherwise, false.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UpdatedAt">
<MemberSignature Language="C#" Value="public DateTime UpdatedAt { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime UpdatedAt" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.QueueDescription.UpdatedAt" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property UpdatedAt As DateTime" />
<MemberSignature Language="F#" Value="member this.UpdatedAt : DateTime" Usage="Microsoft.ServiceBus.Messaging.QueueDescription.UpdatedAt" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the exact time the message has been updated.</summary>
<value>The time the message has been updated.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UserMetadata">
<MemberSignature Language="C#" Value="public string UserMetadata { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string UserMetadata" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.QueueDescription.UserMetadata" />
<MemberSignature Language="VB.NET" Value="Public Property UserMetadata As String" />
<MemberSignature Language="F#" Value="member this.UserMetadata : string with get, set" Usage="Microsoft.ServiceBus.Messaging.QueueDescription.UserMetadata" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the user metadata.</summary>
<value>The user metadata.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>
You can’t perform that action at this time.