CreateBatchOptions.MaximumSizeInBytes Property

Definition

Namespace:

Azure.Messaging.EventHubs.Producer

Assembly:

Azure.Messaging.EventHubs.dll

Package:

Azure.Messaging.EventHubs v5.11.5

Source:

CreateBatchOptions.cs

The maximum size to allow for a single batch of events, in bytes.

public long? MaximumSizeInBytes { get; set; }

member this.MaximumSizeInBytes : Nullable<int64> with get, set

Public Property MaximumSizeInBytes As Nullable(Of Long)

Property Value

Nullable<Int64>

The desired limit, in bytes, for the size of the associated event batch. If null, the maximum size allowed by the associated Event Hub will be used.

The default maximum size will be set to the maximum allowed by the Event Hub.

Exceptions

ArgumentOutOfRangeException

Occurs when the requested size is less than 24.