EventHubOptions Class

Definition

Namespace:

Microsoft.Azure.WebJobs.EventHubs

Assembly:

Microsoft.Azure.WebJobs.Extensions.EventHubs.dll

Package:

Microsoft.Azure.WebJobs.Extensions.EventHubs v6.3.2

Source:

EventHubOptions.cs

public class EventHubOptions : Microsoft.Azure.WebJobs.Hosting.IOptionsFormatter

type EventHubOptions = class
    interface IOptionsFormatter

Public Class EventHubOptions
Implements IOptionsFormatter

Inheritance

Object

EventHubOptions

Implements

Microsoft.Azure.WebJobs.Hosting.IOptionsFormatter

Constructors

EventHubOptions()

Properties

BatchCheckpointFrequency	Gets or sets the number of batches to process before creating an EventHub cursor checkpoint. Default 1.
ClientRetryOptions	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 receiving event batches and other interactions with the Event Hubs service.
CustomEndpointAddress	The address to use for establishing a connection to the Event Hubs service, allowing network requests to be routed through any application gateways or other paths needed for the host environment.
EnableCheckpointing	Gets or sets a value indicating whether the trigger will create checkpoints as events are being processed. The default value is true.
InitialOffsetOptions	Gets the initial offset options to apply when processing. This only applies when no checkpoint information is available.
LoadBalancingUpdateInterval	The desired amount of time to allow between load balancing verification attempts.
MaxEventBatchSize	Gets or sets the maximum number of events delivered in a batch. This setting applies only to functions that receive multiple events. Default 100.
MaxWaitTime	Gets or sets the maximum time that the trigger should wait to fill a batch before invoking the function. This is only considered when MinEventBatchSize is set to larger than 1 and is otherwise unused. If less than MinEventBatchSize events were available before the wait time elapses, the function will be invoked with a partial batch. Default is 60 seconds. The longest allowed wait time is 10 minutes.
MinEventBatchSize	Gets or sets the minimum number of events desired for a batch. This setting applies only to functions that receive multiple events. This value must be less than MaxEventBatchSize and is used in conjunction with MaxWaitTime. Default 1.
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.
TargetUnprocessedEventThreshold	Get or sets the target number of unprocessed events per worker for Event Hub-triggered functions. This is used in target-based scaling to override the default scaling threshold inferred from the MaxEventBatchSize option. If TargetUnprocessedEventThreshold is set, the total unprocessed event count will be divided by this value to determine the number of worker instances, which will then be rounded up to a worker instance count that creates a balanced partition distribution.
TrackLastEnqueuedEventProperties	Indicates whether or not the processor should request information on the last enqueued event on the partition associated with a given event, and track that information as events are received.
TransportType	The type of protocol and transport that will be used for communicating with the Event Hubs service.
WebProxy	The proxy to use for communication over web sockets.

Explicit Interface Implementations

IOptionsFormatter.Format()

Returns a string representation of this EventHubOptions instance.