[event-hubs] adds loadBalancingOptions and greedy load balancing strategy

sdk/eventhub/event-hubs/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History
 
+## 5.3.0-preview.1 (Unreleased)
+
+- Adds `loadBalancingOptions` to the `EventHubConsumerClient` to add control around
+  how aggressively the client claims partitions while load balancing.
+  ([PR 9706](https://github.com/Azure/azure-sdk-for-js/pull/9706))
+
 ## 5.2.2 (Unreleased)
 
 - Fixes issue [#9289](https://github.com/Azure/azure-sdk-for-js/issues/9289)

sdk/eventhub/event-hubs/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@azure/event-hubs",
   "sdk-type": "client",
-  "version": "5.2.2",
+  "version": "5.3.0-preview.1",
   "description": "Azure Event Hubs SDK for JS.",
   "author": "Microsoft Corporation",
   "license": "MIT",

sdk/eventhub/event-hubs/review/event-hubs.api.md

@@ -81,12 +81,12 @@ export interface EventHubClientOptions {
 
 // @public
 export class EventHubConsumerClient {
-    constructor(consumerGroup: string, connectionString: string, options?: EventHubClientOptions);
-    constructor(consumerGroup: string, connectionString: string, checkpointStore: CheckpointStore, options?: EventHubClientOptions);
-    constructor(consumerGroup: string, connectionString: string, eventHubName: string, options?: EventHubClientOptions);
-    constructor(consumerGroup: string, connectionString: string, eventHubName: string, checkpointStore: CheckpointStore, options?: EventHubClientOptions);
-    constructor(consumerGroup: string, fullyQualifiedNamespace: string, eventHubName: string, credential: TokenCredential, options?: EventHubClientOptions);
-    constructor(consumerGroup: string, fullyQualifiedNamespace: string, eventHubName: string, credential: TokenCredential, checkpointStore: CheckpointStore, options?: EventHubClientOptions);
+    constructor(consumerGroup: string, connectionString: string, options?: EventHubConsumerClientOptions);
+    constructor(consumerGroup: string, connectionString: string, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions);
+    constructor(consumerGroup: string, connectionString: string, eventHubName: string, options?: EventHubConsumerClientOptions);
+    constructor(consumerGroup: string, connectionString: string, eventHubName: string, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions);
+    constructor(consumerGroup: string, fullyQualifiedNamespace: string, eventHubName: string, credential: TokenCredential, options?: EventHubConsumerClientOptions);
+    constructor(consumerGroup: string, fullyQualifiedNamespace: string, eventHubName: string, credential: TokenCredential, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions);
     close(): Promise<void>;
     static defaultConsumerGroupName: string;
     get eventHubName(): string;
@@ -98,6 +98,11 @@ export class EventHubConsumerClient {
     subscribe(partitionId: string, handlers: SubscriptionEventHandlers, options?: SubscribeOptions): Subscription;
     }
 
+// @public
+export interface EventHubConsumerClientOptions extends EventHubClientOptions {
+    loadBalancingOptions?: LoadBalancingOptions;
+}
+
 // @public
 export class EventHubProducerClient {
     constructor(connectionString: string, options?: EventHubClientOptions);
@@ -152,6 +157,13 @@ export interface LastEnqueuedEventProperties {
 // @public
 export const latestEventPosition: EventPosition;
 
+// @public
+export interface LoadBalancingOptions {
+    partitionOwnershipExpirationIntervalInMs?: number;
+    strategy?: "balanced" | "greedy";
+    updateIntervalInMs?: number;
+}
+
 // @public
 export const logger: import("@azure/logger").AzureLogger;