-
Notifications
You must be signed in to change notification settings - Fork 256
/
CheckpointPosition.xml
339 lines (339 loc) · 21.7 KB
/
CheckpointPosition.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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
<Type Name="CheckpointPosition" FullName="Azure.Messaging.EventHubs.Processor.CheckpointPosition">
<TypeSignature Language="C#" Value="public struct CheckpointPosition : IEquatable<Azure.Messaging.EventHubs.Processor.CheckpointPosition>" />
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit CheckpointPosition extends System.ValueType implements class System.IEquatable`1<valuetype Azure.Messaging.EventHubs.Processor.CheckpointPosition>" />
<TypeSignature Language="DocId" Value="T:Azure.Messaging.EventHubs.Processor.CheckpointPosition" />
<TypeSignature Language="VB.NET" Value="Public Structure CheckpointPosition
Implements IEquatable(Of CheckpointPosition)" />
<TypeSignature Language="F#" Value="type CheckpointPosition = struct" />
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.11.0.0</AssemblyVersion>
<AssemblyVersion>5.11.1.0</AssemblyVersion>
<AssemblyVersion>5.11.2.0</AssemblyVersion>
<AssemblyVersion>5.11.3.0</AssemblyVersion>
<AssemblyVersion>5.12.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IEquatable<Azure.Messaging.EventHubs.Processor.CheckpointPosition></InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
The position in a partition's event stream to use when updating a checkpoint, indicating that an event processor should begin reading from the next event.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CheckpointPosition (long sequenceNumber);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int64 sequenceNumber) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Processor.CheckpointPosition.#ctor(System.Int64)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (sequenceNumber As Long)" />
<MemberSignature Language="F#" Value="new Azure.Messaging.EventHubs.Processor.CheckpointPosition : int64 -> Azure.Messaging.EventHubs.Processor.CheckpointPosition" Usage="new Azure.Messaging.EventHubs.Processor.CheckpointPosition sequenceNumber" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.11.3.0</AssemblyVersion>
<AssemblyVersion>5.12.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="azure-dotnet-preview">
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="sequenceNumber" Type="System.Int64" />
</Parameters>
<Docs>
<param name="sequenceNumber">The sequence number to associate with the checkpoint. This indicates that a processor should begin reading from the next event in the stream.</param>
<summary>
Initializes a new instance of the <see cref="T:Azure.Messaging.EventHubs.Processor.CheckpointPosition" /> struct.
</summary>
<remarks>
This constructor is not compatible when processing a geo-replicated Event Hub. Use <see cref="M:Azure.Messaging.EventHubs.Processor.CheckpointPosition.#ctor(System.String,System.Int64)" /> or
<see cref="M:Azure.Messaging.EventHubs.Processor.CheckpointPosition.FromEvent(Azure.Messaging.EventHubs.EventData)" /> instead.
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CheckpointPosition (string offset, long sequenceNumber = -9223372036854775808);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string offset, int64 sequenceNumber) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Processor.CheckpointPosition.#ctor(System.String,System.Int64)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (offset As String, Optional sequenceNumber As Long = -9223372036854775808)" />
<MemberSignature Language="F#" Value="new Azure.Messaging.EventHubs.Processor.CheckpointPosition : string * int64 -> Azure.Messaging.EventHubs.Processor.CheckpointPosition" Usage="new Azure.Messaging.EventHubs.Processor.CheckpointPosition (offset, sequenceNumber)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.12.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="offset" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="sequenceNumber" Type="System.Int64" Index="1" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="offset">The offset to associate with the checkpoint. This indicates that a processor should begin reading from the next event in the stream.</param>
<param name="sequenceNumber">The sequence number to associate with the checkpoint. This is used as informational metadata.</param>
<summary>
Initializes a new instance of the <see cref="T:Azure.Messaging.EventHubs.Processor.CheckpointPosition" /> struct.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public bool Equals (Azure.Messaging.EventHubs.Processor.CheckpointPosition other);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Equals(valuetype Azure.Messaging.EventHubs.Processor.CheckpointPosition other) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Processor.CheckpointPosition.Equals(Azure.Messaging.EventHubs.Processor.CheckpointPosition)" />
<MemberSignature Language="VB.NET" Value="Public Function Equals (other As CheckpointPosition) As Boolean" />
<MemberSignature Language="F#" Value="override this.Equals : Azure.Messaging.EventHubs.Processor.CheckpointPosition -> bool" Usage="checkpointPosition.Equals other" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.IEquatable`1.Equals(`0)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.11.3.0</AssemblyVersion>
<AssemblyVersion>5.12.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="other" Type="Azure.Messaging.EventHubs.Processor.CheckpointPosition" />
</Parameters>
<Docs>
<param name="other">The <see cref="T:Azure.Messaging.EventHubs.Processor.CheckpointPosition" /> to compare with this instance.</param>
<summary>
Determines whether the specified <see cref="T:Azure.Messaging.EventHubs.Processor.CheckpointPosition" /> is equal to this instance.
</summary>
<returns>
<c>true</c> if the specified <see cref="T:Azure.Messaging.EventHubs.Processor.CheckpointPosition" /> is equal to this instance; otherwise, <c>false</c>.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public override bool Equals (object obj);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Processor.CheckpointPosition.Equals(System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function Equals (obj As Object) As Boolean" />
<MemberSignature Language="F#" Value="override this.Equals : obj -> bool" Usage="checkpointPosition.Equals obj" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.11.3.0</AssemblyVersion>
<AssemblyVersion>5.12.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="obj" Type="System.Object" />
</Parameters>
<Docs>
<param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param>
<summary>
Determines whether the specified <see cref="T:System.Object" /> is equal to this instance.
</summary>
<returns>
<c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance; otherwise, <c>false</c>.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FromEvent">
<MemberSignature Language="C#" Value="public static Azure.Messaging.EventHubs.Processor.CheckpointPosition FromEvent (Azure.Messaging.EventHubs.EventData eventData);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype Azure.Messaging.EventHubs.Processor.CheckpointPosition FromEvent(class Azure.Messaging.EventHubs.EventData eventData) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Processor.CheckpointPosition.FromEvent(Azure.Messaging.EventHubs.EventData)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function FromEvent (eventData As EventData) As CheckpointPosition" />
<MemberSignature Language="F#" Value="static member FromEvent : Azure.Messaging.EventHubs.EventData -> Azure.Messaging.EventHubs.Processor.CheckpointPosition" Usage="Azure.Messaging.EventHubs.Processor.CheckpointPosition.FromEvent eventData" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.11.3.0</AssemblyVersion>
<AssemblyVersion>5.12.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Messaging.EventHubs.Processor.CheckpointPosition</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="eventData" Type="Azure.Messaging.EventHubs.EventData" />
</Parameters>
<Docs>
<param name="eventData">The <see cref="T:Azure.Messaging.EventHubs.EventData" /> to use to determine the starting point of a checkpoint, indicating that an event processor should begin reading from the next event in the stream.</param>
<summary>
Initializes a new instance of the <see cref="T:Azure.Messaging.EventHubs.Processor.CheckpointPosition" /> from an <see cref="T:Azure.Messaging.EventHubs.EventData" /> instance.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetHashCode">
<MemberSignature Language="C#" Value="public override int GetHashCode ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Processor.CheckpointPosition.GetHashCode" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetHashCode () As Integer" />
<MemberSignature Language="F#" Value="override this.GetHashCode : unit -> int" Usage="checkpointPosition.GetHashCode " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.11.3.0</AssemblyVersion>
<AssemblyVersion>5.12.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Returns a hash code for this instance.
</summary>
<returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Offset">
<MemberSignature Language="C#" Value="public string Offset { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Offset" />
<MemberSignature Language="DocId" Value="P:Azure.Messaging.EventHubs.Processor.CheckpointPosition.Offset" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Offset As String" />
<MemberSignature Language="F#" Value="member this.Offset : string" Usage="Azure.Messaging.EventHubs.Processor.CheckpointPosition.Offset" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.12.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The offset to associate with the checkpoint. This indicates that a processor should begin reading from the next event in the stream.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="op_Equality">
<MemberSignature Language="C#" Value="public static bool operator == (Azure.Messaging.EventHubs.Processor.CheckpointPosition left, Azure.Messaging.EventHubs.Processor.CheckpointPosition right);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Equality(valuetype Azure.Messaging.EventHubs.Processor.CheckpointPosition left, valuetype Azure.Messaging.EventHubs.Processor.CheckpointPosition right) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Processor.CheckpointPosition.op_Equality(Azure.Messaging.EventHubs.Processor.CheckpointPosition,Azure.Messaging.EventHubs.Processor.CheckpointPosition)" />
<MemberSignature Language="VB.NET" Value="Public Shared Operator == (left As CheckpointPosition, right As CheckpointPosition) As Boolean" />
<MemberSignature Language="F#" Value="static member ( = ) : Azure.Messaging.EventHubs.Processor.CheckpointPosition * Azure.Messaging.EventHubs.Processor.CheckpointPosition -> bool" Usage="left = right" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.11.3.0</AssemblyVersion>
<AssemblyVersion>5.12.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="left" Type="Azure.Messaging.EventHubs.Processor.CheckpointPosition" />
<Parameter Name="right" Type="Azure.Messaging.EventHubs.Processor.CheckpointPosition" />
</Parameters>
<Docs>
<param name="left">The first <see cref="T:Azure.Messaging.EventHubs.Processor.CheckpointPosition" /> to consider.</param>
<param name="right">The second <see cref="T:Azure.Messaging.EventHubs.Processor.CheckpointPosition" /> to consider.</param>
<summary>
Determines whether the specified <see cref="T:Azure.Messaging.EventHubs.Processor.CheckpointPosition" /> instances are equal to each other.
</summary>
<returns>
<c>true</c> if the two specified <see cref="T:Azure.Messaging.EventHubs.Processor.CheckpointPosition" /> instances are equal; otherwise, <c>false</c>.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="op_Inequality">
<MemberSignature Language="C#" Value="public static bool operator != (Azure.Messaging.EventHubs.Processor.CheckpointPosition left, Azure.Messaging.EventHubs.Processor.CheckpointPosition right);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Inequality(valuetype Azure.Messaging.EventHubs.Processor.CheckpointPosition left, valuetype Azure.Messaging.EventHubs.Processor.CheckpointPosition right) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Processor.CheckpointPosition.op_Inequality(Azure.Messaging.EventHubs.Processor.CheckpointPosition,Azure.Messaging.EventHubs.Processor.CheckpointPosition)" />
<MemberSignature Language="VB.NET" Value="Public Shared Operator != (left As CheckpointPosition, right As CheckpointPosition) As Boolean" />
<MemberSignature Language="F#" Value="static member op_Inequality : Azure.Messaging.EventHubs.Processor.CheckpointPosition * Azure.Messaging.EventHubs.Processor.CheckpointPosition -> bool" Usage="Azure.Messaging.EventHubs.Processor.CheckpointPosition.op_Inequality (left, right)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.11.3.0</AssemblyVersion>
<AssemblyVersion>5.12.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="left" Type="Azure.Messaging.EventHubs.Processor.CheckpointPosition" />
<Parameter Name="right" Type="Azure.Messaging.EventHubs.Processor.CheckpointPosition" />
</Parameters>
<Docs>
<param name="left">The first <see cref="T:Azure.Messaging.EventHubs.Processor.CheckpointPosition" /> to consider.</param>
<param name="right">The second <see cref="T:Azure.Messaging.EventHubs.Processor.CheckpointPosition" /> to consider.</param>
<summary>
Determines whether the specified <see cref="T:Azure.Messaging.EventHubs.Processor.CheckpointPosition" /> instances are not equal to each other.
</summary>
<returns>
<c>true</c> if the two specified <see cref="T:Azure.Messaging.EventHubs.Processor.CheckpointPosition" /> instances are not equal; otherwise, <c>false</c>.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SequenceNumber">
<MemberSignature Language="C#" Value="public long SequenceNumber { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 SequenceNumber" />
<MemberSignature Language="DocId" Value="P:Azure.Messaging.EventHubs.Processor.CheckpointPosition.SequenceNumber" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property SequenceNumber As Long" />
<MemberSignature Language="F#" Value="member this.SequenceNumber : int64" Usage="Azure.Messaging.EventHubs.Processor.CheckpointPosition.SequenceNumber" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.11.3.0</AssemblyVersion>
<AssemblyVersion>5.12.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>
The sequence number to associate with the checkpoint. The sequence number is intended to be informational, and will only be used for
positioning if no <see cref="P:Azure.Messaging.EventHubs.Processor.CheckpointPosition.Offset" /> is set.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Processor.CheckpointPosition.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="checkpointPosition.ToString " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.11.3.0</AssemblyVersion>
<AssemblyVersion>5.12.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Converts the instance to string representation.
</summary>
<returns>A <see cref="T:System.String" /> that represents the position in the event stream.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>