EventHubBufferedProducerClientOptions Class

Definition

Namespace:

Azure.Messaging.EventHubs.Producer

Assembly:

Azure.Messaging.EventHubs.dll

Package:

Azure.Messaging.EventHubs v5.11.2

Source:

EventHubBufferedProducerClientOptions.cs

The set of options that can be specified when creating an EventHubBufferedProducerClient to configure its behavior.

public class EventHubBufferedProducerClientOptions

type EventHubBufferedProducerClientOptions = class

Public Class EventHubBufferedProducerClientOptions

Inheritance

Object

EventHubBufferedProducerClientOptions

Constructors

EventHubBufferedProducerClientOptions()

Initializes a new instance of the EventHubBufferedProducerClientOptions class.

Properties

ConnectionOptions	The options used for configuring the connection to the Event Hubs service.
EnableIdempotentRetries	Indicates whether or not events should be published using idempotent semantics for retries. If enabled, retries during publishing will attempt to avoid duplication with a minor cost to throughput. Duplicates are still possible but the chance of them occurring is much lower when idempotent retries are enabled.
Identifier	A unique name used to identify the consumer. If null or empty, a GUID will be used as the identifier.
MaximumConcurrentSends	The total number of batches that may be sent concurrently, across all partitions. This limit takes precedence over the value specified in MaximumConcurrentSendsPerPartition, ensuring this maximum is respected.
MaximumConcurrentSendsPerPartition	The number of batches that may be sent concurrently for a given partition. This option is superseded by the value specified for MaximumConcurrentSends, ensuring that limit is respected.
MaximumEventBufferLengthPerPartition	The total number of events that can be buffered for publishing at a given time for a given partition. Once this capacity is reached, more events can enqueued by calling EnqueueEventAsync(EventData, EnqueueEventOptions, CancellationToken) or EnqueueEventsAsync(IEnumerable<EventData>, EnqueueEventOptions, CancellationToken), which will automatically wait for room to be available.
MaximumWaitTime	The amount of time to wait for a batch to be built with events in the buffer before publishing a partially full batch.
RetryOptions	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 publishing events and other interactions with the Event Hubs service.