Class CreateBatchOptions

The set of options that can be specified to influence the way in which an event batch behaves and is sent to the Event Hubs service.

Inheritance
System.Object
SendEventOptions
CreateBatchOptions
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.Messaging.EventHubs.dll
Syntax
public class CreateBatchOptions : Azure.Messaging.EventHubs.Producer.SendEventOptions

Constructors

CreateBatchOptions()

Declaration
public CreateBatchOptions ();

Properties

MaximumSizeInBytes

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

Declaration
public Nullable<long> MaximumSizeInBytes { get; set; }
Property Value
System.Nullable<System.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
System.ArgumentOutOfRangeException

Occurs when the requested size is less than 24.

Methods

Equals(Object)

Determines whether the specified System.Object is equal to this instance.

Declaration
[System.ComponentModel.EditorBrowsable]
public override bool Equals (object obj);
Parameters
System.Object obj

The System.Object to compare with this instance.
Returns
System.Boolean

true if the specified System.Object is equal to this instance; otherwise, false.

GetHashCode()

Returns a hash code for this instance.

Declaration
[System.ComponentModel.EditorBrowsable]
public override int GetHashCode ();
Returns
System.Int32

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

ToString()

Converts the instance to string representation.

Declaration
[System.ComponentModel.EditorBrowsable]
public override string ToString ();
Returns
System.String

A System.String that represents this instance.