Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SubscribeOptions

Package version

Options to configure the subscribe method on the EventHubConsumerClient. For example, `{ maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }

Hierarchy

  • SubscribeOptions

Index

Properties

Optional maxBatchSize

maxBatchSize: undefined | number

The number of events to request per batch

Optional maxWaitTimeInSeconds

maxWaitTimeInSeconds: undefined | number

The maximum amount of time to wait to build up the requested message count before passing the data to user code for processing. If not provided, it defaults to 60 seconds.

Optional ownerLevel

ownerLevel: undefined | number

The owner level to use as this subscription subscribes to partitions.

Optional startPosition

startPosition: EventPosition | {}

The event position in a partition to start receiving events from if no checkpoint is found. Pass a map of partition id to position if you would like to use different starting position for each partition.

Optional tracingOptions

tracingOptions: OperationTracingOptions

Options for configuring tracing.

Optional trackLastEnqueuedEventProperties

trackLastEnqueuedEventProperties: undefined | false | true

Indicates whether or not the consumer should request information on the last enqueued event on its associated partition, and track that information as events are received.

When information about the partition's last enqueued event is being tracked, each event received from the Event Hubs service will carry metadata about the partition that it otherwise would not. This results in a small amount of additional network bandwidth consumption that is generally a favorable trade-off when considered against periodically making requests for partition properties using the Event Hub client.

Generated using TypeDoc