-
Notifications
You must be signed in to change notification settings - Fork 255
/
EventHubReceiver.xml
710 lines (710 loc) · 46.9 KB
/
EventHubReceiver.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
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
<Type Name="EventHubReceiver" FullName="Microsoft.ServiceBus.Messaging.EventHubReceiver">
<TypeSignature Language="C#" Value="public sealed class EventHubReceiver : Microsoft.ServiceBus.Messaging.ClientEntity" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit EventHubReceiver extends Microsoft.ServiceBus.Messaging.ClientEntity" />
<TypeSignature Language="DocId" Value="T:Microsoft.ServiceBus.Messaging.EventHubReceiver" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class EventHubReceiver
Inherits ClientEntity" />
<TypeSignature Language="F#" Value="type EventHubReceiver = class
 inherit ClientEntity" />
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.ServiceBus.Messaging.ClientEntity</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>A client class used in receive operations related to an Event Hub consumer group.
Represents a logical receiver connection to a specific Event Hub partition within a consumer group.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="Epoch">
<MemberSignature Language="C#" Value="public long? Epoch { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int64> Epoch" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.EventHubReceiver.Epoch" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Epoch As Nullable(Of Long)" />
<MemberSignature Language="F#" Value="member this.Epoch : Nullable<int64>" Usage="Microsoft.ServiceBus.Messaging.EventHubReceiver.Epoch" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Int64></ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the epoch value that is used to determine partition ownership during the receive operation.</summary>
<value>Returns <see cref="T:System.Int64" />.</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.EventHubReceiver.EventHubPath" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property EventHubPath As String" />
<MemberSignature Language="F#" Value="member this.EventHubPath : string" Usage="Microsoft.ServiceBus.Messaging.EventHubReceiver.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 event hub path.</summary>
<value>The event hub path.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Identifier">
<MemberSignature Language="C#" Value="public string Identifier { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Identifier" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.EventHubReceiver.Identifier" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Identifier As String" />
<MemberSignature Language="F#" Value="member this.Identifier : string" Usage="Microsoft.ServiceBus.Messaging.EventHubReceiver.Identifier" />
<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 identifier of a receiver which was set during the creation of the receiver.</summary>
<value>A string representing the identifier of a receiver. It will return null if the identifier is not set.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.EventHubReceiver.Name" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Name As String" />
<MemberSignature Language="F#" Value="member this.Name : string" Usage="Microsoft.ServiceBus.Messaging.EventHubReceiver.Name" />
<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 Hub.</summary>
<value>The name of the Event Hub.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OffsetInclusive">
<MemberSignature Language="C#" Value="public bool OffsetInclusive { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool OffsetInclusive" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.EventHubReceiver.OffsetInclusive" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property OffsetInclusive As Boolean" />
<MemberSignature Language="F#" Value="member this.OffsetInclusive : bool" Usage="Microsoft.ServiceBus.Messaging.EventHubReceiver.OffsetInclusive" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value indicating whether
<see cref="P:Microsoft.ServiceBus.Messaging.EventHubReceiver.StartingOffset" /> is treated as an inclusive offset, meaning that the first event returned is the event that contains the starting offset. Normally, the first event returned is the event after the starting offset.</summary>
<value>Returns <see cref="T:System.Boolean" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnAbort">
<MemberSignature Language="C#" Value="protected override void OnAbort ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void OnAbort() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubReceiver.OnAbort" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub OnAbort ()" />
<MemberSignature Language="F#" Value="override this.OnAbort : unit -> unit" Usage="eventHubReceiver.OnAbort " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnBeginClose">
<MemberSignature Language="C#" Value="protected override IAsyncResult OnBeginClose (TimeSpan timeout, AsyncCallback callback, object state);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance class System.IAsyncResult OnBeginClose(valuetype System.TimeSpan timeout, class System.AsyncCallback callback, object state) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubReceiver.OnBeginClose(System.TimeSpan,System.AsyncCallback,System.Object)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function OnBeginClose (timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult" />
<MemberSignature Language="F#" Value="override this.OnBeginClose : TimeSpan * AsyncCallback * obj -> IAsyncResult" Usage="eventHubReceiver.OnBeginClose (timeout, callback, state)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IAsyncResult</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="timeout" Type="System.TimeSpan" />
<Parameter Name="callback" Type="System.AsyncCallback" />
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<param name="timeout">To be added.</param>
<param name="callback">To be added.</param>
<param name="state">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnBeginOpen">
<MemberSignature Language="C#" Value="protected override IAsyncResult OnBeginOpen (TimeSpan timeout, AsyncCallback callback, object state);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance class System.IAsyncResult OnBeginOpen(valuetype System.TimeSpan timeout, class System.AsyncCallback callback, object state) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubReceiver.OnBeginOpen(System.TimeSpan,System.AsyncCallback,System.Object)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function OnBeginOpen (timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult" />
<MemberSignature Language="F#" Value="override this.OnBeginOpen : TimeSpan * AsyncCallback * obj -> IAsyncResult" Usage="eventHubReceiver.OnBeginOpen (timeout, callback, state)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IAsyncResult</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="timeout" Type="System.TimeSpan" />
<Parameter Name="callback" Type="System.AsyncCallback" />
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<param name="timeout">To be added.</param>
<param name="callback">To be added.</param>
<param name="state">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnClose">
<MemberSignature Language="C#" Value="protected override void OnClose (TimeSpan timeout);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void OnClose(valuetype System.TimeSpan timeout) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubReceiver.OnClose(System.TimeSpan)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub OnClose (timeout As TimeSpan)" />
<MemberSignature Language="F#" Value="override this.OnClose : TimeSpan -> unit" Usage="eventHubReceiver.OnClose timeout" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="timeout" Type="System.TimeSpan" />
</Parameters>
<Docs>
<param name="timeout">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnEndClose">
<MemberSignature Language="C#" Value="protected override void OnEndClose (IAsyncResult result);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void OnEndClose(class System.IAsyncResult result) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubReceiver.OnEndClose(System.IAsyncResult)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub OnEndClose (result As IAsyncResult)" />
<MemberSignature Language="F#" Value="override this.OnEndClose : IAsyncResult -> unit" Usage="eventHubReceiver.OnEndClose result" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="result" Type="System.IAsyncResult" />
</Parameters>
<Docs>
<param name="result">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnEndOpen">
<MemberSignature Language="C#" Value="protected override void OnEndOpen (IAsyncResult result);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void OnEndOpen(class System.IAsyncResult result) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubReceiver.OnEndOpen(System.IAsyncResult)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub OnEndOpen (result As IAsyncResult)" />
<MemberSignature Language="F#" Value="override this.OnEndOpen : IAsyncResult -> unit" Usage="eventHubReceiver.OnEndOpen result" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="result" Type="System.IAsyncResult" />
</Parameters>
<Docs>
<param name="result">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnOpen">
<MemberSignature Language="C#" Value="protected override void OnOpen (TimeSpan timeout);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void OnOpen(valuetype System.TimeSpan timeout) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubReceiver.OnOpen(System.TimeSpan)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub OnOpen (timeout As TimeSpan)" />
<MemberSignature Language="F#" Value="override this.OnOpen : TimeSpan -> unit" Usage="eventHubReceiver.OnOpen timeout" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="timeout" Type="System.TimeSpan" />
</Parameters>
<Docs>
<param name="timeout">To be added.</param>
<summary>To be added.</summary>
<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.EventHubReceiver.PartitionId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property PartitionId As String" />
<MemberSignature Language="F#" Value="member this.PartitionId : string" Usage="Microsoft.ServiceBus.Messaging.EventHubReceiver.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 a logical partition of an Event Hub.</summary>
<value>The partition identifier.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PrefetchCount">
<MemberSignature Language="C#" Value="public int PrefetchCount { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 PrefetchCount" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.EventHubReceiver.PrefetchCount" />
<MemberSignature Language="VB.NET" Value="Public Property PrefetchCount As Integer" />
<MemberSignature Language="F#" Value="member this.PrefetchCount : int with get, set" Usage="Microsoft.ServiceBus.Messaging.EventHubReceiver.PrefetchCount" />
<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 number of events that any receive operation will actively cache. By default, this value is inherited from
<see cref="T:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup" />. The default value is 300.</summary>
<value>The number of messages that the message receiver can simultaneously request.</value>
<remarks> Changes to this value will be used in next receive operation, however this does not affect the
number of events already cached by the receiver. Setting this property to non-zero value will set
<see cref="P:Microsoft.ServiceBus.Messaging.EventHubReceiver.PrefetchSizeInBytes" /> to null.
Note that setting the count too low will affect the effective performance of the event hub receive call.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">Thrown if the value is less than the minimum required value of 10.</exception>
</Docs>
</Member>
<Member MemberName="PrefetchSizeInBytes">
<MemberSignature Language="C#" Value="public long? PrefetchSizeInBytes { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int64> PrefetchSizeInBytes" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.EventHubReceiver.PrefetchSizeInBytes" />
<MemberSignature Language="VB.NET" Value="Public Property PrefetchSizeInBytes As Nullable(Of Long)" />
<MemberSignature Language="F#" Value="member this.PrefetchSizeInBytes : Nullable<int64> with get, set" Usage="Microsoft.ServiceBus.Messaging.EventHubReceiver.PrefetchSizeInBytes" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Int64></ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the maximum size (in bytes) in total that any receive operation will actively cache. The size of each event data is determined by the
<see cref="P:Microsoft.ServiceBus.Messaging.EventData.SerializedSizeInBytes" /> property.</summary>
<value>Returns <see cref="T:System.Int64" />.</value>
<remarks>The size limit is not an absolute limit. the size might go over by at least
one event data worth of size. Changes to this value will be used in next receive operation, however this does not affect the
number of events already cached by the receiver.
Setting this property to non-null value will set <see cref="P:Microsoft.ServiceBus.Messaging.EventHubReceiver.PrefetchCount" /> to zero.
Note that setting the size too low will affect the effective performance of the event hub receive call.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">Thrown when the size value is less than the minimum required value of 260K bytes.</exception>
</Docs>
</Member>
<Member MemberName="Receive">
<MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.EventData Receive ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.ServiceBus.Messaging.EventData Receive() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubReceiver.Receive" />
<MemberSignature Language="VB.NET" Value="Public Function Receive () As EventData" />
<MemberSignature Language="F#" Value="member this.Receive : unit -> Microsoft.ServiceBus.Messaging.EventData" Usage="eventHubReceiver.Receive " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.Messaging.EventData</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Receives Event Hubs event data.</summary>
<returns>Returns the received <see cref="T:Microsoft.ServiceBus.Messaging.EventData" /> object, or null if no event data is available.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.ServiceBus.Messaging.MessagingException">Thrown if the service encounters a transient error.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.MessagingCommunicationException">Thrown if the client
has a problem connecting to the service.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.ServerBusyException">Thrown if the current namespace
is placing too much load on the system.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.ReceiverDisconnectedException">Thrown if another receiver with a higher
<see cref="P:Microsoft.ServiceBus.Messaging.EventHubReceiver.Epoch" /> value is connected as the current receiver to the same partition specified by
<see cref="P:Microsoft.ServiceBus.Messaging.EventHubReceiver.PartitionId" />.</exception>
</Docs>
</Member>
<Member MemberName="Receive">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.EventData> Receive (int maxCount);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Collections.Generic.IEnumerable`1<class Microsoft.ServiceBus.Messaging.EventData> Receive(int32 maxCount) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubReceiver.Receive(System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Function Receive (maxCount As Integer) As IEnumerable(Of EventData)" />
<MemberSignature Language="F#" Value="member this.Receive : int -> seq<Microsoft.ServiceBus.Messaging.EventData>" Usage="eventHubReceiver.Receive maxCount" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.EventData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="maxCount" Type="System.Int32" />
</Parameters>
<Docs>
<param name="maxCount">The maximum amount of event data the user is willing to accept in one call.</param>
<summary>Receives Event Hubs event data, up to the specified count.</summary>
<returns>Returns the received
<see cref="T:Microsoft.ServiceBus.Messaging.EventData" /> collection. The collection is either empty if no event is returned within the specified time, or all events up to <paramref name="maxCount" /> are returned.</returns>
<remarks>Service does not wait for <paramref name="maxCount" /> events to be filled before
returning to user. It returns as soon as there are any events available.</remarks>
<exception cref="T:Microsoft.ServiceBus.Messaging.MessagingException">Thrown if the service encounters a transient error.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.MessagingCommunicationException">Thrown if the client
has a problem connecting to the service.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.ServerBusyException">Thrown if the current namespace
is placing too much load on the system.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.ReceiverDisconnectedException">Thrown if another receiver with a higher
<see cref="P:Microsoft.ServiceBus.Messaging.EventHubReceiver.Epoch" /> value is connected as the current receiver to the same partition specified by
<see cref="P:Microsoft.ServiceBus.Messaging.EventHubReceiver.PartitionId" />.</exception>
</Docs>
</Member>
<Member MemberName="Receive">
<MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.EventData Receive (TimeSpan waitTime);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.ServiceBus.Messaging.EventData Receive(valuetype System.TimeSpan waitTime) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubReceiver.Receive(System.TimeSpan)" />
<MemberSignature Language="VB.NET" Value="Public Function Receive (waitTime As TimeSpan) As EventData" />
<MemberSignature Language="F#" Value="member this.Receive : TimeSpan -> Microsoft.ServiceBus.Messaging.EventData" Usage="eventHubReceiver.Receive waitTime" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.Messaging.EventData</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitTime" Type="System.TimeSpan" />
</Parameters>
<Docs>
<param name="waitTime">The maximum time the user is willing to wait for event data to arrive.</param>
<summary>Receives Event Hubs event data with the specified timeout value.</summary>
<returns>Returns the received
<see cref="T:Microsoft.ServiceBus.Messaging.EventData" /> collection, or null if there is no event data available.</returns>
<remarks>
<paramref name="waitTime" /> is not a guaranteed wait time, as API will return data as soon as it is available.</remarks>
<exception cref="T:Microsoft.ServiceBus.Messaging.MessagingException">Thrown if the service encounters a transient error.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.MessagingCommunicationException">Thrown if the client
has a problem connecting to the service.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.ServerBusyException">Thrown if the current namespace
is placing too much load on the system.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.ReceiverDisconnectedException">Thrown if another receiver with a higher
<see cref="P:Microsoft.ServiceBus.Messaging.EventHubReceiver.Epoch" /> value is connected as the current receiver to the same partition specified by
<see cref="P:Microsoft.ServiceBus.Messaging.EventHubReceiver.PartitionId" />.</exception>
</Docs>
</Member>
<Member MemberName="Receive">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.EventData> Receive (int maxCount, TimeSpan waitTime);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Collections.Generic.IEnumerable`1<class Microsoft.ServiceBus.Messaging.EventData> Receive(int32 maxCount, valuetype System.TimeSpan waitTime) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubReceiver.Receive(System.Int32,System.TimeSpan)" />
<MemberSignature Language="VB.NET" Value="Public Function Receive (maxCount As Integer, waitTime As TimeSpan) As IEnumerable(Of EventData)" />
<MemberSignature Language="F#" Value="member this.Receive : int * TimeSpan -> seq<Microsoft.ServiceBus.Messaging.EventData>" Usage="eventHubReceiver.Receive (maxCount, waitTime)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.EventData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="maxCount" Type="System.Int32" />
<Parameter Name="waitTime" Type="System.TimeSpan" />
</Parameters>
<Docs>
<param name="maxCount">The maximum amount of event data the user is willing to accept in one call.</param>
<param name="waitTime">The maximum time the user is willing to wait for event data to arrive.</param>
<summary>Receives Event Hubs event data, up to the specified count with the specified timeout value.</summary>
<returns>Returns the received
<see cref="T:Microsoft.ServiceBus.Messaging.EventData" /> collection. The collection is either empty if no event is returned within the specified time, or all events up to <paramref name="maxCount" /> are returned.</returns>
<remarks>
<paramref name="waitTime" /> is not a guaranteed wait time,
as API will return data as soon as it is available. Also service does not
wait for <paramref name="maxCount" /> events to be filled before
returning to user. it returns as soon as there are any events available.</remarks>
<exception cref="T:Microsoft.ServiceBus.Messaging.MessagingException">Thrown if the service encounters a transient error.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.MessagingCommunicationException">Thrown if the client
has a problem connecting to the service.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.ServerBusyException">Thrown if the current namespace
is placing too much load on the system.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.ReceiverDisconnectedException">Thrown if another receiver with a higher
<see cref="P:Microsoft.ServiceBus.Messaging.EventHubReceiver.Epoch" /> value is connected as the current receiver to the same partition specified by
<see cref="P:Microsoft.ServiceBus.Messaging.EventHubReceiver.PartitionId" />.</exception>
</Docs>
</Member>
<Member MemberName="ReceiveAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.EventData> ReceiveAsync ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceBus.Messaging.EventData> ReceiveAsync() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubReceiver.ReceiveAsync" />
<MemberSignature Language="VB.NET" Value="Public Function ReceiveAsync () As Task(Of EventData)" />
<MemberSignature Language="F#" Value="member this.ReceiveAsync : unit -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.EventData>" Usage="eventHubReceiver.ReceiveAsync " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.EventData></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Asynchronous version of <see cref="M:Microsoft.ServiceBus.Messaging.EventHubReceiver.Receive" />.</summary>
<returns>The task representing the asynchronous operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReceiveAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.EventData>> ReceiveAsync (int maxCount);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class System.Collections.Generic.IEnumerable`1<class Microsoft.ServiceBus.Messaging.EventData>> ReceiveAsync(int32 maxCount) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubReceiver.ReceiveAsync(System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Function ReceiveAsync (maxCount As Integer) As Task(Of IEnumerable(Of EventData))" />
<MemberSignature Language="F#" Value="member this.ReceiveAsync : int -> System.Threading.Tasks.Task<seq<Microsoft.ServiceBus.Messaging.EventData>>" Usage="eventHubReceiver.ReceiveAsync maxCount" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.EventData>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="maxCount" Type="System.Int32" />
</Parameters>
<Docs>
<param name="maxCount">The maximum amount of event data the user is willing to accept in one call.</param>
<summary>Asynchronous version of <see cref="M:Microsoft.ServiceBus.Messaging.EventHubReceiver.Receive(System.Int32)" />.</summary>
<returns>Returns <see cref="T:System.Threading.Tasks.Task`1" />.</returns>
<remarks>Service does not wait for <paramref name="maxCount" /> events to be filled before
returning to user. It returns as soon as there are any events available.</remarks>
</Docs>
</Member>
<Member MemberName="ReceiveAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.EventData> ReceiveAsync (TimeSpan waitTime);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceBus.Messaging.EventData> ReceiveAsync(valuetype System.TimeSpan waitTime) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubReceiver.ReceiveAsync(System.TimeSpan)" />
<MemberSignature Language="VB.NET" Value="Public Function ReceiveAsync (waitTime As TimeSpan) As Task(Of EventData)" />
<MemberSignature Language="F#" Value="member this.ReceiveAsync : TimeSpan -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.EventData>" Usage="eventHubReceiver.ReceiveAsync waitTime" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.EventData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitTime" Type="System.TimeSpan" />
</Parameters>
<Docs>
<param name="waitTime">The maximum time the user is willing to wait for event data to arrive.</param>
<summary>Asynchronous version of <see cref="M:Microsoft.ServiceBus.Messaging.EventHubReceiver.Receive(System.TimeSpan)" />.</summary>
<returns>The task representing the asynchronous operation.</returns>
<remarks>
<paramref name="waitTime" /> is not a guaranteed wait time,
as API will return data as soon as it is available.</remarks>
</Docs>
</Member>
<Member MemberName="ReceiveAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.EventData>> ReceiveAsync (int maxCount, TimeSpan waitTime);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class System.Collections.Generic.IEnumerable`1<class Microsoft.ServiceBus.Messaging.EventData>> ReceiveAsync(int32 maxCount, valuetype System.TimeSpan waitTime) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.EventHubReceiver.ReceiveAsync(System.Int32,System.TimeSpan)" />
<MemberSignature Language="VB.NET" Value="Public Function ReceiveAsync (maxCount As Integer, waitTime As TimeSpan) As Task(Of IEnumerable(Of EventData))" />
<MemberSignature Language="F#" Value="member this.ReceiveAsync : int * TimeSpan -> System.Threading.Tasks.Task<seq<Microsoft.ServiceBus.Messaging.EventData>>" Usage="eventHubReceiver.ReceiveAsync (maxCount, waitTime)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.EventData>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="maxCount" Type="System.Int32" />
<Parameter Name="waitTime" Type="System.TimeSpan" />
</Parameters>
<Docs>
<param name="maxCount">The maximum amount of event data the user is willing to accept in one call.</param>
<param name="waitTime">The maximum time the user is willing to wait for event data to arrive.</param>
<summary>Asynchronous version of <see cref="M:Microsoft.ServiceBus.Messaging.EventHubReceiver.Receive(System.Int32,System.TimeSpan)" />.</summary>
<returns>Returns <see cref="T:System.Threading.Tasks.Task`1" />.</returns>
<remarks>
<paramref name="waitTime" /> is not a guaranteed wait time,
as API will return data as soon as it is available. Also service does not
wait for <paramref name="maxCount" /> events to be filled before
returning to user. It returns as soon as there are any events available.</remarks>
</Docs>
</Member>
<Member MemberName="ReceiverRuntimeMetricEnabled">
<MemberSignature Language="C#" Value="public bool ReceiverRuntimeMetricEnabled { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool ReceiverRuntimeMetricEnabled" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.EventHubReceiver.ReceiverRuntimeMetricEnabled" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ReceiverRuntimeMetricEnabled As Boolean" />
<MemberSignature Language="F#" Value="member this.ReceiverRuntimeMetricEnabled : bool" Usage="Microsoft.ServiceBus.Messaging.EventHubReceiver.ReceiverRuntimeMetricEnabled" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary> Gets a value indicating whether the runtime metric of a receiver is enabled. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RuntimeInfo">
<MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.ReceiverRuntimeInfo RuntimeInfo { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.ServiceBus.Messaging.ReceiverRuntimeInfo RuntimeInfo" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.EventHubReceiver.RuntimeInfo" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property RuntimeInfo As ReceiverRuntimeInfo" />
<MemberSignature Language="F#" Value="member this.RuntimeInfo : Microsoft.ServiceBus.Messaging.ReceiverRuntimeInfo" Usage="Microsoft.ServiceBus.Messaging.EventHubReceiver.RuntimeInfo" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.Messaging.ReceiverRuntimeInfo</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the approximate receiver runtime information for a logical partition of an Event Hub.
To enable the setting, refer to <see cref="T:Microsoft.ServiceBus.Messaging.ReceiverOptions" /> and <see cref="P:Microsoft.ServiceBus.Messaging.EventHubConsumerGroup.EnableReceiverRuntimeMetric" /></summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StartingDateTimeUtc">
<MemberSignature Language="C#" Value="public DateTime? StartingDateTimeUtc { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.DateTime> StartingDateTimeUtc" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.EventHubReceiver.StartingDateTimeUtc" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property StartingDateTimeUtc As Nullable(Of DateTime)" />
<MemberSignature Language="F#" Value="member this.StartingDateTimeUtc : Nullable<DateTime>" Usage="Microsoft.ServiceBus.Messaging.EventHubReceiver.StartingDateTimeUtc" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.DateTime></ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the starting date and time in UTC format for this receiver. The
<see cref="M:Microsoft.ServiceBus.Messaging.EventHubReceiver.Receive" /> method starts receiving the next event after this
<see cref="P:Microsoft.ServiceBus.Messaging.EventHubReceiver.StartingDateTimeUtc" /> value. If null, the receiver starts receiving events from the beginning of the Event Hubs event stream.</summary>
<value>The starting date and time in UTC.</value>
<remarks>Service only uses this datetime as an approximation when delivering next event.
Keep in mind that there can be clock skew between client time and service time, so user application
should be designed to handle duplication in event delivery.</remarks>
</Docs>
</Member>
<Member MemberName="StartingOffset">
<MemberSignature Language="C#" Value="public string StartingOffset { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string StartingOffset" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.EventHubReceiver.StartingOffset" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property StartingOffset As String" />
<MemberSignature Language="F#" Value="member this.StartingOffset : string" Usage="Microsoft.ServiceBus.Messaging.EventHubReceiver.StartingOffset" />
<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 starting offset for this receiver. The
<see cref="M:Microsoft.ServiceBus.Messaging.EventHubReceiver.Receive" /> method starts receiving the next event after this offset value. If the value is null, the receiver starts receiving events from the beginning of the Event Hubs event stream.</summary>
<value>The starting offset.</value>
<remarks>This starting offset ties to one partition only,
represented by <see cref="P:Microsoft.ServiceBus.Messaging.EventHubReceiver.PartitionId" />.</remarks>
</Docs>
</Member>
<Member MemberName="StartingSequenceNumber">
<MemberSignature Language="C#" Value="public long? StartingSequenceNumber { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int64> StartingSequenceNumber" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.EventHubReceiver.StartingSequenceNumber" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property StartingSequenceNumber As Nullable(Of Long)" />
<MemberSignature Language="F#" Value="member this.StartingSequenceNumber : Nullable<int64>" Usage="Microsoft.ServiceBus.Messaging.EventHubReceiver.StartingSequenceNumber" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Int64></ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the starting sequence number for this receiver. The
<see cref="M:Microsoft.ServiceBus.Messaging.EventHubReceiver.Receive" /> method starts receiving the next event after this
<see cref="P:Microsoft.ServiceBus.Messaging.EventHubReceiver.StartingSequenceNumber" /> value.</summary>
<value>The starting sequence number (exclusive). A null value means that the receiver was created with an offset or a date time.</value>
<remarks>This starting offset ties to one partition only, represented by <see cref="P:Microsoft.ServiceBus.Messaging.EventHubReceiver.PartitionId" />.</remarks>
</Docs>
</Member>
</Members>
</Type>