EPHOptions Class

Class that contains default and overidable EPH option.

Inheritance

builtins.object

EPHOptions

Constructor

EPHOptions()

Variables

max_batch_size

int

The maximum number of events retrieved for processing at a time. This value must be less than or equal to the prefetch count. The actual number of events returned for processing may be any number up to the maximum. The default value is 10.

prefetch_count

int

The number of events to fetch from the service in advance of processing. The default value is 300.

receive_timeout

int

The length of time a single partition receiver will wait in order to receive a batch of events. Default is 60 seconds.

release_pump_on_timeout

bool

Whether to shutdown an individual partition receiver if no events were received in the specified timeout. Shutting down the pump will release the lease to allow it to be picked up by another host. Default is False.

initial_offset_provider

str

The initial event offset to receive from if no persisted offset is found. Default is "-1" (i.e. from the first event available).

debug_trace

bool

Whether to emit the network traffic in the logs. In order to view these events the logger must be configured to track "uamqp". Default is False.

http_proxy

<xref:http_proxy>)<xref: >(dict

HTTP proxy configuration. This should be a dictionary with the following keys present: 'proxy_hostname' and 'proxy_port'. Additional optional keys are 'username' and 'password'.

keep_alive_interval

int

The time in seconds between asynchronously pinging a receiver connection to keep it alive during inactivity. Default is None - i.e. no connection pinging.

auto_reconnect_on_error

bool

Whether to automatically attempt to reconnect a receiver connection if it is detach from the service with a retryable error. Default is True.