EventProcessorClientOptions Class

Definition

Namespace:

Azure.Messaging.EventHubs

Assembly:

Azure.Messaging.EventHubs.Processor.dll

Package:

Azure.Messaging.EventHubs.Processor v5.11.5

Source:

EventProcessorClientOptions.cs

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

public class EventProcessorClientOptions

type EventProcessorClientOptions = class

Public Class EventProcessorClientOptions

Inheritance

Object

EventProcessorClientOptions

Constructors

EventProcessorClientOptions()

Properties

CacheEventCount	The maximum number of events that will be read from the Event Hubs service and held in a local memory cache when reading is active and events are being emitted to an enumerator for processing.
ConnectionOptions	Gets or sets the options used for configuring the connection to the Event Hubs service.
Identifier	A unique name used to identify the event processor. If null or empty, a GUID will be used as the identifier.
LoadBalancingStrategy	The strategy that an event processor will use to make decisions about partition ownership when performing load balancing to share work with other event processors.
LoadBalancingUpdateInterval	The desired amount of time to allow between load balancing verification attempts.
MaximumWaitTime	The maximum amount of time to wait for an event to become available for a given partition before emitting an empty event.
PartitionOwnershipExpirationInterval	The desired amount of time to consider a partition owned by a specific event processor instance before the ownership is considered stale and the partition becomes eligible to be requested by another event processor that wishes to assume responsibility for processing it.
PrefetchCount	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.
PrefetchSizeInBytes	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.
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.
TrackLastEnqueuedEventProperties	Indicates whether or not the consumer should request information on the last enqueued event on the partition associated with a given event, and track that information as events are received.