-
Notifications
You must be signed in to change notification settings - Fork 256
/
PartitionDescription.xml
251 lines (251 loc) · 14.2 KB
/
PartitionDescription.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
<Type Name="PartitionDescription" FullName="Microsoft.ServiceBus.Messaging.PartitionDescription">
<TypeSignature Language="C#" Value="public sealed class PartitionDescription : Microsoft.ServiceBus.Messaging.EntityDescription" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit PartitionDescription extends Microsoft.ServiceBus.Messaging.EntityDescription" />
<TypeSignature Language="DocId" Value="T:Microsoft.ServiceBus.Messaging.PartitionDescription" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class PartitionDescription
Inherits EntityDescription" />
<TypeSignature Language="F#" Value="type PartitionDescription = class
 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 Language="C#">[System.Runtime.Serialization.DataContract(Name="PartitionDescription", Namespace="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Serialization.DataContract(Name="PartitionDescription", Namespace="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Represents the metadata and approximate runtime information for a logical partition of an Event Hub.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public PartitionDescription (string eventHubPath, string partitionId);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string eventHubPath, string partitionId) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.PartitionDescription.#ctor(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (eventHubPath As String, partitionId As String)" />
<MemberSignature Language="F#" Value="new Microsoft.ServiceBus.Messaging.PartitionDescription : string * string -> Microsoft.ServiceBus.Messaging.PartitionDescription" Usage="new Microsoft.ServiceBus.Messaging.PartitionDescription (eventHubPath, partitionId)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="eventHubPath" Type="System.String" />
<Parameter Name="partitionId" Type="System.String" />
</Parameters>
<Docs>
<param name="eventHubPath">The path of the Event Hub.</param>
<param name="partitionId">The partition identifier.</param>
<summary>Initializes a new instance of the <see cref="T:Microsoft.ServiceBus.Messaging.PartitionDescription" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="BeginSequenceNumber">
<MemberSignature Language="C#" Value="public long BeginSequenceNumber { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 BeginSequenceNumber" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.PartitionDescription.BeginSequenceNumber" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property BeginSequenceNumber As Long" />
<MemberSignature Language="F#" Value="member this.BeginSequenceNumber : int64" Usage="Microsoft.ServiceBus.Messaging.PartitionDescription.BeginSequenceNumber" />
<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 begin sequence number.</summary>
<value>The begin sequence number.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ConsumerGroupName">
<MemberSignature Language="C#" Value="public string ConsumerGroupName { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ConsumerGroupName" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.PartitionDescription.ConsumerGroupName" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ConsumerGroupName As String" />
<MemberSignature Language="F#" Value="member this.ConsumerGroupName : string" Usage="Microsoft.ServiceBus.Messaging.PartitionDescription.ConsumerGroupName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the name of the Event Hubs consumer group.</summary>
<value>The Event Hubs consumer group.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EndSequenceNumber">
<MemberSignature Language="C#" Value="public long EndSequenceNumber { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 EndSequenceNumber" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.PartitionDescription.EndSequenceNumber" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property EndSequenceNumber As Long" />
<MemberSignature Language="F#" Value="member this.EndSequenceNumber : int64" Usage="Microsoft.ServiceBus.Messaging.PartitionDescription.EndSequenceNumber" />
<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 end sequence number.</summary>
<value>The end sequence number.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EventHubPath">
<MemberSignature Language="C#" Value="public string EventHubPath { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string EventHubPath" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.PartitionDescription.EventHubPath" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property EventHubPath As String" />
<MemberSignature Language="F#" Value="member this.EventHubPath : string" Usage="Microsoft.ServiceBus.Messaging.PartitionDescription.EventHubPath" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the path of the Event Hub.</summary>
<value>The path of the Event Hub.</value>
<remarks>
This is a relative path to the <see cref="P:Microsoft.ServiceBus.NamespaceManager.Address" />.
</remarks>
</Docs>
</Member>
<Member MemberName="IncomingBytesPerSecond">
<MemberSignature Language="C#" Value="public long IncomingBytesPerSecond { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 IncomingBytesPerSecond" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.PartitionDescription.IncomingBytesPerSecond" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IncomingBytesPerSecond As Long" />
<MemberSignature Language="F#" Value="member this.IncomingBytesPerSecond : int64" Usage="Microsoft.ServiceBus.Messaging.PartitionDescription.IncomingBytesPerSecond" />
<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 approximate incoming rate of events (in bytes per second) for the partition.</summary>
<value>Returns <see cref="T:System.Int64" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LastEnqueuedOffset">
<MemberSignature Language="C#" Value="public string LastEnqueuedOffset { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string LastEnqueuedOffset" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.PartitionDescription.LastEnqueuedOffset" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property LastEnqueuedOffset As String" />
<MemberSignature Language="F#" Value="member this.LastEnqueuedOffset : string" Usage="Microsoft.ServiceBus.Messaging.PartitionDescription.LastEnqueuedOffset" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the offset of the last enqueued event.</summary>
<value>The offset of the last enqueued event.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LastEnqueuedTimeUtc">
<MemberSignature Language="C#" Value="public DateTime LastEnqueuedTimeUtc { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime LastEnqueuedTimeUtc" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.PartitionDescription.LastEnqueuedTimeUtc" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property LastEnqueuedTimeUtc As DateTime" />
<MemberSignature Language="F#" Value="member this.LastEnqueuedTimeUtc : DateTime" Usage="Microsoft.ServiceBus.Messaging.PartitionDescription.LastEnqueuedTimeUtc" />
<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 enqueued UTC time of the last event.</summary>
<value>The enqueued time of the last event.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OutgoingBytesPerSecond">
<MemberSignature Language="C#" Value="public long OutgoingBytesPerSecond { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 OutgoingBytesPerSecond" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.PartitionDescription.OutgoingBytesPerSecond" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property OutgoingBytesPerSecond As Long" />
<MemberSignature Language="F#" Value="member this.OutgoingBytesPerSecond : int64" Usage="Microsoft.ServiceBus.Messaging.PartitionDescription.OutgoingBytesPerSecond" />
<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 approximate outgoing rate (in bytes per second) for the partition in the specified consumer group.</summary>
<value>Returns <see cref="T:System.Int64" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PartitionId">
<MemberSignature Language="C#" Value="public string PartitionId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string PartitionId" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.PartitionDescription.PartitionId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property PartitionId As String" />
<MemberSignature Language="F#" Value="member this.PartitionId : string" Usage="Microsoft.ServiceBus.Messaging.PartitionDescription.PartitionId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the partition ID for the Event Hub to which it belongs.</summary>
<value>The partition identifier.</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.PartitionDescription.SizeInBytes" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property SizeInBytes As Long" />
<MemberSignature Language="F#" Value="member this.SizeInBytes : int64" Usage="Microsoft.ServiceBus.Messaging.PartitionDescription.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 approximate size, in bytes, of the Event Hubs partition.</summary>
<value>Returns <see cref="T:System.Int64" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>