-
Notifications
You must be signed in to change notification settings - Fork 260
/
PartitionReceiverOptions.xml
400 lines (398 loc) · 24.6 KB
/
PartitionReceiverOptions.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
<Type Name="PartitionReceiverOptions" FullName="Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions">
<TypeSignature Language="C#" Value="public class PartitionReceiverOptions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PartitionReceiverOptions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions" />
<TypeSignature Language="VB.NET" Value="Public Class PartitionReceiverOptions" />
<TypeSignature Language="F#" Value="type PartitionReceiverOptions = class" />
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.4.0.0</AssemblyVersion>
<AssemblyVersion>5.4.1.0</AssemblyVersion>
<AssemblyVersion>5.5.0.0</AssemblyVersion>
<AssemblyVersion>5.6.0.0</AssemblyVersion>
<AssemblyVersion>5.6.1.0</AssemblyVersion>
<AssemblyVersion>5.6.2.0</AssemblyVersion>
<AssemblyVersion>5.7.0.0</AssemblyVersion>
<AssemblyVersion>5.7.1.0</AssemblyVersion>
<AssemblyVersion>5.7.2.0</AssemblyVersion>
<AssemblyVersion>5.7.3.0</AssemblyVersion>
<AssemblyVersion>5.7.4.0</AssemblyVersion>
<AssemblyVersion>5.7.5.0</AssemblyVersion>
<AssemblyVersion>5.8.0.0</AssemblyVersion>
<AssemblyVersion>5.8.1.0</AssemblyVersion>
<AssemblyVersion>5.9.0.0</AssemblyVersion>
<AssemblyVersion>5.9.1.0</AssemblyVersion>
<AssemblyVersion>5.9.2.0</AssemblyVersion>
<AssemblyVersion>5.9.3.0</AssemblyVersion>
<AssemblyVersion>5.10.0.0</AssemblyVersion>
<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.11.4.0</AssemblyVersion>
<AssemblyVersion>5.11.5.0</AssemblyVersion>
<AssemblyVersion>5.12.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
The set of options that can be specified when creating a <see cref="T:Azure.Messaging.EventHubs.Primitives.PartitionReceiver" />
to configure its behavior.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public PartitionReceiverOptions ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.11.5.0</AssemblyVersion>
<AssemblyVersion>5.12.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ConnectionOptions">
<MemberSignature Language="C#" Value="public Azure.Messaging.EventHubs.EventHubConnectionOptions ConnectionOptions { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Azure.Messaging.EventHubs.EventHubConnectionOptions ConnectionOptions" />
<MemberSignature Language="DocId" Value="P:Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions.ConnectionOptions" />
<MemberSignature Language="VB.NET" Value="Public Property ConnectionOptions As EventHubConnectionOptions" />
<MemberSignature Language="F#" Value="member this.ConnectionOptions : Azure.Messaging.EventHubs.EventHubConnectionOptions with get, set" Usage="Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions.ConnectionOptions" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.11.5.0</AssemblyVersion>
<AssemblyVersion>5.12.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Messaging.EventHubs.EventHubConnectionOptions</ReturnType>
</ReturnValue>
<Docs>
<summary>
The options used for configuring the connection to the Event Hubs service.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DefaultMaximumReceiveWaitTime">
<MemberSignature Language="C#" Value="public TimeSpan? DefaultMaximumReceiveWaitTime { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.TimeSpan> DefaultMaximumReceiveWaitTime" />
<MemberSignature Language="DocId" Value="P:Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions.DefaultMaximumReceiveWaitTime" />
<MemberSignature Language="VB.NET" Value="Public Property DefaultMaximumReceiveWaitTime As Nullable(Of TimeSpan)" />
<MemberSignature Language="F#" Value="member this.DefaultMaximumReceiveWaitTime : Nullable<TimeSpan> with get, set" Usage="Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions.DefaultMaximumReceiveWaitTime" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.11.5.0</AssemblyVersion>
<AssemblyVersion>5.12.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.TimeSpan></ReturnType>
</ReturnValue>
<Docs>
<summary>
The default amount of time to wait for the requested amount of messages when reading; if this
period elapses before the requested amount of messages were available or read, then the set of
messages that were read will be returned.
</summary>
<value>The default wait time is 60 seconds.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">Occurs when the requested wait time is negative.</exception>
</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.Primitives.PartitionReceiverOptions.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="partitionReceiverOptions.Equals obj" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.11.5.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="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.Primitives.PartitionReceiverOptions.GetHashCode" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetHashCode () As Integer" />
<MemberSignature Language="F#" Value="override this.GetHashCode : unit -> int" Usage="partitionReceiverOptions.GetHashCode " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.11.5.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="Identifier">
<MemberSignature Language="C#" Value="public string Identifier { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Identifier" />
<MemberSignature Language="DocId" Value="P:Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions.Identifier" />
<MemberSignature Language="VB.NET" Value="Public Property Identifier As String" />
<MemberSignature Language="F#" Value="member this.Identifier : string with get, set" Usage="Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions.Identifier" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.11.5.0</AssemblyVersion>
<AssemblyVersion>5.12.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
A unique name used to identify the receiver. If <c>null</c> or empty, a GUID will be used as the
identifier.
</summary>
<value>If not specified, a random unique identifier will be generated.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OwnerLevel">
<MemberSignature Language="C#" Value="public long? OwnerLevel { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int64> OwnerLevel" />
<MemberSignature Language="DocId" Value="P:Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions.OwnerLevel" />
<MemberSignature Language="VB.NET" Value="Public Property OwnerLevel As Nullable(Of Long)" />
<MemberSignature Language="F#" Value="member this.OwnerLevel : Nullable<int64> with get, set" Usage="Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions.OwnerLevel" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.11.5.0</AssemblyVersion>
<AssemblyVersion>5.12.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Int64></ReturnType>
</ReturnValue>
<Docs>
<summary>
When populated, the owner level indicates that a reading is intended to be performed exclusively for events in the
requested partition and for the associated consumer group. To do so, reading will attempt to assert ownership
over the partition; in the case where more than one exclusive reader attempts to assert ownership for the same
partition/consumer group pair, the one having a larger <see cref="P:Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions.OwnerLevel" /> value will "win."
When an exclusive reader is used, other readers which are non-exclusive or which have a lower owner level will either
not be allowed to be created, if they already exist, will encounter an exception during the next attempted operation.
</summary>
<value>
The relative priority to associate with an exclusive reader; for a non-exclusive reader, this value should be <c>null</c>. The
default owner level is <c>null</c>.
</value>
<remarks>
An <see cref="T:Azure.Messaging.EventHubs.EventHubsException" /> will occur if a <see cref="T:Azure.Messaging.EventHubs.Primitives.PartitionReceiver" /> is unable to read events from the
requested Event Hub partition for the given consumer group. In this case, the <see cref="T:Azure.Messaging.EventHubs.EventHubsException.FailureReason" />
will be set to <see cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.ConsumerDisconnected" />.
</remarks>
<altmember cref="T:Azure.Messaging.EventHubs.EventHubsException" />
<exception cref="T:Azure.Messaging.EventHubs.EventHubsException">
Occurs when the owner level is set and the <see cref="T:Azure.Messaging.EventHubs.Primitives.PartitionReceiver" /> is unable to read from the requested Event Hub partition due to being denied
ownership. In this case, the <see cref="T:Azure.Messaging.EventHubs.EventHubsException.FailureReason" /> will be set to <see cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.ConsumerDisconnected" />.
</exception>
<altmember cref="F:Azure.Messaging.EventHubs.EventHubsException.FailureReason.ConsumerDisconnected" />
</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:Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions.PrefetchCount" />
<MemberSignature Language="VB.NET" Value="Public Property PrefetchCount As Integer" />
<MemberSignature Language="F#" Value="member this.PrefetchCount : int with get, set" Usage="Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions.PrefetchCount" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.11.5.0</AssemblyVersion>
<AssemblyVersion>5.12.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
The number of events that will be eagerly requested from the Event Hubs service and queued locally without regard to
whether a read operation is currently active, intended to help maximize throughput by allowing events to be read from
from a local cache rather than waiting on a service request.
</summary>
<value>
The <see cref="P:Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions.PrefetchCount" /> is a control that developers can use to help tune performance for the specific
needs of an application, given its expected size of events, throughput needs, and expected scenarios for using
Event Hubs.
The default prefetch count is 300.
</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">Occurs when the requested count is negative.</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:Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions.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="Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions.PrefetchSizeInBytes" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.11.5.0</AssemblyVersion>
<AssemblyVersion>5.12.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Int64></ReturnType>
</ReturnValue>
<Docs>
<summary>
The desired number of bytes to attempt to eagerly request from the Event Hubs service and queued locally without regard to
whether a read operation is currently active, intended to help maximize throughput by allowing events to be read from
from a local cache rather than waiting on a service request.
</summary>
<value>
<para>When set to <c>null</c>, the option is considered disabled; otherwise, it will be considered enabled and take
precedence over any value specified for the <see cref="P:Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions.PrefetchCount" />The <see cref="P:Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions.PrefetchSizeInBytes" /> is an
advanced control that developers can use to help tune performance in some scenarios; it is recommended to prefer using
the <see cref="P:Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions.PrefetchCount" /> over this option where possible for more accurate control and more predictable throughput.</para>
<para>This size should be considered a statement of intent rather than a guaranteed limit; the local cache may be larger or
smaller than the number of bytes specified, and will always contain at least one event when the <see cref="P:Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions.PrefetchSizeInBytes" />
is specified. A heuristic is used to predict the average event size to use for size calculations, which should be expected to fluctuate
as traffic passes through the system. Consequently, the resulting resource use will fluctuate as well.</para>
<para>This option is disabled by default with the value set to <c>null</c>.</para>
</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">Occurs when the requested size is negative.</exception>
</Docs>
</Member>
<Member MemberName="RetryOptions">
<MemberSignature Language="C#" Value="public Azure.Messaging.EventHubs.EventHubsRetryOptions RetryOptions { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Azure.Messaging.EventHubs.EventHubsRetryOptions RetryOptions" />
<MemberSignature Language="DocId" Value="P:Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions.RetryOptions" />
<MemberSignature Language="VB.NET" Value="Public Property RetryOptions As EventHubsRetryOptions" />
<MemberSignature Language="F#" Value="member this.RetryOptions : Azure.Messaging.EventHubs.EventHubsRetryOptions with get, set" Usage="Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions.RetryOptions" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.11.5.0</AssemblyVersion>
<AssemblyVersion>5.12.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Messaging.EventHubs.EventHubsRetryOptions</ReturnType>
</ReturnValue>
<Docs>
<summary>
The set of options to use for determining whether a failed operation should be retried and,
if so, the amount of time to wait between retry attempts. These options also control the
amount of time allowed for reading events and other interactions with the Event Hubs service.
</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.Primitives.PartitionReceiverOptions.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="partitionReceiverOptions.ToString " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.11.5.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.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Converts the instance to string representation.
</summary>
<returns>A <see cref="T:System.String" /> that represents this instance.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TrackLastEnqueuedEventProperties">
<MemberSignature Language="C#" Value="public bool TrackLastEnqueuedEventProperties { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool TrackLastEnqueuedEventProperties" />
<MemberSignature Language="DocId" Value="P:Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions.TrackLastEnqueuedEventProperties" />
<MemberSignature Language="VB.NET" Value="Public Property TrackLastEnqueuedEventProperties As Boolean" />
<MemberSignature Language="F#" Value="member this.TrackLastEnqueuedEventProperties : bool with get, set" Usage="Azure.Messaging.EventHubs.Primitives.PartitionReceiverOptions.TrackLastEnqueuedEventProperties" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Messaging.EventHubs</AssemblyName>
<AssemblyVersion>5.11.5.0</AssemblyVersion>
<AssemblyVersion>5.12.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Indicates whether or not the reader should request information on the last enqueued event on the partition
associated with a given event, and track that information as events are read.
</summary>
<value>
<c>true</c> if information about a partition's last event should be requested and tracked; otherwise, <c>false</c>. The
default value is <c>true</c>.
</value>
<remarks>
When information about a partition's last enqueued event is being tracked, each event received from the Event Hubs
service will carry metadata about the partition that it otherwise would not. This results in a small amount of
additional network bandwidth consumption that is generally a favorable trade-off when considered
against periodically making requests for partition properties using one of the Event Hub clients.
</remarks>
</Docs>
</Member>
</Members>
</Type>