@azure/event-hubs 5.7.0-beta.1 → 5.7.0

package/types/3.1/event-hubs.d.ts

@@ -1,7 +1,6 @@
 /// <reference types="node" />
 import { AbortSignalLike } from '@azure/abort-controller';
 import { AmqpAnnotatedMessage } from '@azure/core-amqp';
-import { AzureLogger } from '@azure/logger';
 import { MessagingError } from '@azure/core-amqp';
 import { NamedKeyCredential } from '@azure/core-auth';
 import { OperationTracingOptions } from '@azure/core-tracing';
@@ -13,22 +12,6 @@ import { SpanContext } from '@azure/core-tracing';
 import { TokenCredential } from '@azure/core-auth';
 import { WebSocketImpl } from 'rhea-promise';
 import { WebSocketOptions } from '@azure/core-amqp';
-/**
- * Options to configure the `close` method on the `EventHubBufferedProducerClient`.
- */
-export declare interface BufferedCloseOptions extends OperationOptions {
-    /**
-     * When `true`, all buffered events that are pending should be sent before closing.
-     * When `false`, abandon all buffered events and close immediately.
-     * Defaults to `true`.
-     */
-    flush?: boolean;
-}
-/**
- * Options to configure the `flush` method on the `EventHubBufferedProducerClient`.
- */
-export declare interface BufferedFlushOptions extends OperationOptions {
-}
 /**
  * A checkpoint is meant to represent the last successfully processed event by the user from a particular
  * partition of a consumer group in an Event Hub instance.
@@ -179,11 +162,6 @@ export declare interface CreateBatchOptions extends OperationOptions {
  * first event in the partition which has not expired due to the retention policy.
  */
 export declare const earliestEventPosition: EventPosition;
-/**
- * Options to configure the `enqueueEvents` method on the `EventHubBufferedProcuerClient`.
- */
-export declare interface EnqueueEventOptions extends SendBatchOptions {
-}
 /**
  * The interface that describes the data to be sent to Event Hub.
  * Use this as a reference when creating the object to be sent when using the `EventHubProducerClient`.
@@ -270,237 +248,6 @@ export declare interface EventDataBatch {
      */
     tryAdd(eventData: EventData | AmqpAnnotatedMessage, options?: TryAddOptions): boolean;
 }
-/**
- * The `EventHubBufferedProducerClient`is used to publish events to a specific Event Hub.
- *
- * The `EventHubBufferedProducerClient` does not publish events immediately.
- * Instead, events are buffered so they can be efficiently batched and published
- * when the batch is full or the `maxWaitTimeInMs` has elapsed with no new events
- * enqueued.
- *
- * Depending on the options specified when events are enqueued, they may be
- * automatically assigned to a partition, grouped according to the specified partition key,
- * or assigned a specifically requested partition.
- *
- * This model is intended to shift the burden of batch management from callers, at the cost of
- * non-deterministic timing, for when events will be published. There are additional trade-offs
- * to consider, as well:
- * - If the application crashes, events in the buffer will not have been published. To prevent
- *   data loss, callers are encouraged to track publishing progress using the
- *   `onSendEventsSuccessHandler` and `onSendEventsErrorHandler` handlers.
- * - Events specifying a partition key may be assigned a different partition than those using
- *   the same key with other producers.
- * - In the unlikely event that a partition becomes temporarily unavailable, the
- *   `EventHubBufferedProducerClient` may take longer to recover than other producers.
- *
- * In scenarios where it is important to have events published immediately with a deterministic
- * outcome, ensure that partition keys are assigned to a partition consistent with other
- * publishers, or where maximizing availability is a requirement, using the
- * `EventHubProducerClient` is recommended.
- */
-export declare class EventHubBufferedProducerClient {
-    /**
-     * Controls the `abortSignal` passed to each `BatchingPartitionChannel`.
-     * Used to signal when a channel should stop waiting for events.
-     */
-    private _abortController;
-    /**
-     * Indicates whether the client has been explicitly closed.
-     */
-    private _isClosed;
-    /**
-     * Handles assigning partitions.
-     */
-    private _partitionAssigner;
-    /**
-     * The known partitionIds that will be used when assigning events to partitions.
-     */
-    private _partitionIds;
-    /**
-     * The EventHubProducerClient to use when creating and sending batches to the Event Hub.
-     */
-    private _producer;
-    /**
-     * Mapping of partitionIds to `BatchingPartitionChannels`.
-     * Each `BatchingPartitionChannel` handles buffering events and backpressure independently.
-     */
-    private _partitionChannels;
-    /**
-     * The options passed by the user when creating the EventHubBufferedProducerClient instance.
-     */
-    private _clientOptions;
-    readonly eventHubName: string;
-    readonly fullyQualifiedNamespace: string;
-    /**
-     * The `EventHubBufferedProducerClient` class is used to send events to an Event Hub.
-     * Use the `options` parmeter to configure retry policy or proxy settings.
-     * @param connectionString - The connection string to use for connecting to the Event Hub instance.
-     * It is expected that the shared key properties and the Event Hub path are contained in this connection string.
-     * e.g. 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name;SharedAccessKey=my-SA-key;EntityPath=my-event-hub-name'.
-     * @param options - A set of options to apply when configuring the client.
-     * - `retryOptions`   : Configures the retry policy for all the operations on the client.
-     * For example, `{ "maxRetries": 4 }` or `{ "maxRetries": 4, "retryDelayInMs": 30000 }`.
-     * - `webSocketOptions`: Configures the channelling of the AMQP connection over Web Sockets.
-     * - `userAgent`      : A string to append to the built in user agent string that is passed to the service.
-     */
-    constructor(connectionString: string, options: EventHubBufferedProducerClientOptions);
-    /**
-     * The `EventHubBufferedProducerClient` class is used to send events to an Event Hub.
-     * Use the `options` parmeter to configure retry policy or proxy settings.
-     * @param connectionString - The connection string to use for connecting to the Event Hubs namespace.
-     * It is expected that the shared key properties are contained in this connection string, but not the Event Hub path,
-     * e.g. 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name;SharedAccessKey=my-SA-key;'.
-     * @param eventHubName - The name of the specific Event Hub to connect the client to.
-     * @param options - A set of options to apply when configuring the client.
-     * - `retryOptions`   : Configures the retry policy for all the operations on the client.
-     * For example, `{ "maxRetries": 4 }` or `{ "maxRetries": 4, "retryDelayInMs": 30000 }`.
-     * - `webSocketOptions`: Configures the channelling of the AMQP connection over Web Sockets.
-     * - `userAgent`      : A string to append to the built in user agent string that is passed to the service.
-     */
-    constructor(connectionString: string, eventHubName: string, options: EventHubBufferedProducerClientOptions);
-    /**
-     * The `EventHubBufferedProducerClient` class is used to send events to an Event Hub.
-     * Use the `options` parmeter to configure retry policy or proxy settings.
-     * @param fullyQualifiedNamespace - The full namespace which is likely to be similar to
-     * <yournamespace>.servicebus.windows.net
-     * @param eventHubName - The name of the specific Event Hub to connect the client to.
-     * @param credential - An credential object used by the client to get the token to authenticate the connection
-     * with the Azure Event Hubs service.
-     * See &commat;azure/identity for creating credentials that support AAD auth.
-     * Use the `AzureNamedKeyCredential` from &commat;azure/core-auth if you want to pass in a `SharedAccessKeyName`
-     * and `SharedAccessKey` without using a connection string. These fields map to the `name` and `key` field respectively
-     * in `AzureNamedKeyCredential`.
-     * Use the `AzureSASCredential` from &commat;azure/core-auth if you want to pass in a `SharedAccessSignature`
-     * without using a connection string. This field maps to `signature` in `AzureSASCredential`.
-     * @param options - A set of options to apply when configuring the client.
-     * - `retryOptions`   : Configures the retry policy for all the operations on the client.
-     * For example, `{ "maxRetries": 4 }` or `{ "maxRetries": 4, "retryDelayInMs": 30000 }`.
-     * - `webSocketOptions`: Configures the channelling of the AMQP connection over Web Sockets.
-     * - `userAgent`      : A string to append to the built in user agent string that is passed to the service.
-     */
-    constructor(fullyQualifiedNamespace: string, eventHubName: string, credential: TokenCredential | NamedKeyCredential | SASCredential, options: EventHubBufferedProducerClientOptions);
-    /**
-     * Closes the AMQP connection to the Event Hub instance,
-     * returning a promise that will be resolved when disconnection is completed.
-     *
-     * This will wait for enqueued events to be flushed to the service before closing
-     * the connection.
-     * To close without flushing, set the `flush` option to `false`.
-     *
-     * @param options - The set of options to apply to the operation call.
-     * @returns Promise<void>
-     * @throws Error if the underlying connection encounters an error while closing.
-     */
-    close(options?: BufferedCloseOptions): Promise<void>;
-    /**
-     * Enqueues an event into the buffer to be published to the Event Hub.
-     * If there is no capacity in the buffer when this method is invoked,
-     * it will wait for space to become available and ensure that the event
-     * has been enqueued.
-     *
-     * When this call returns, the event has been accepted into the buffer,
-     * but it may not have been published yet.
-     * Publishing will take place at a nondeterministic point in the future as the buffer is processed.
-     *
-     * @param events - An {@link EventData} or `AmqpAnnotatedMessage`.
-     * @param options - A set of options that can be specified to influence the way in which
-     * the event is sent to the associated Event Hub.
-     * - `abortSignal`  : A signal used to cancel the enqueueEvent operation.
-     * - `partitionId`  : The partition this set of events will be sent to. If set, `partitionKey` can not be set.
-     * - `partitionKey` : A value that is hashed to produce a partition assignment. If set, `partitionId` can not be set.
-     * @returns The total number of events that are currently buffered and waiting to be published, across all partitions.
-     */
-    enqueueEvent(event: EventData | AmqpAnnotatedMessage, options?: EnqueueEventOptions): Promise<number>;
-    /**
-     * Enqueues events into the buffer to be published to the Event Hub.
-     * If there is no capacity in the buffer when this method is invoked,
-     * it will wait for space to become available and ensure that the events
-     * have been enqueued.
-     *
-     * When this call returns, the events have been accepted into the buffer,
-     * but it may not have been published yet.
-     * Publishing will take place at a nondeterministic point in the future as the buffer is processed.
-     *
-     * @param events - An array of {@link EventData} or `AmqpAnnotatedMessage`.
-     * @param options - A set of options that can be specified to influence the way in which
-     * events are sent to the associated Event Hub.
-     * - `abortSignal`  : A signal used to cancel the enqueueEvents operation.
-     * - `partitionId`  : The partition this set of events will be sent to. If set, `partitionKey` can not be set.
-     * - `partitionKey` : A value that is hashed to produce a partition assignment. If set, `partitionId` can not be set.
-     * @returns The total number of events that are currently buffered and waiting to be published, across all partitions.
-     */
-    enqueueEvents(events: EventData[] | AmqpAnnotatedMessage[], options?: EnqueueEventOptions): Promise<number>;
-    /**
-     * Attempts to publish all events in the buffer immediately.
-     * This may result in multiple batches being published,
-     * the outcome of each of which will be individually reported by
-     * the `onSendEventsSuccessHandler` and `onSendEventsErrorHandler` handlers.
-     *
-     * @param options - The set of options to apply to the operation call.
-     */
-    flush(options?: BufferedFlushOptions): Promise<void>;
-    /**
-     * Provides the Event Hub runtime information.
-     * @param options - The set of options to apply to the operation call.
-     * @returns A promise that resolves with information about the Event Hub instance.
-     * @throws Error if the underlying connection has been closed, create a new EventHubBufferedProducerClient.
-     * @throws AbortError if the operation is cancelled via the abortSignal.
-     */
-    getEventHubProperties(options?: GetEventHubPropertiesOptions): Promise<EventHubProperties>;
-    /**
-     * Provides the id for each partition associated with the Event Hub.
-     * @param options - The set of options to apply to the operation call.
-     * @returns A promise that resolves with an Array of strings representing the id for
-     * each partition associated with the Event Hub.
-     * @throws Error if the underlying connection has been closed, create a new EventHubBufferedProducerClient.
-     * @throws AbortError if the operation is cancelled via the abortSignal.
-     */
-    getPartitionIds(options?: GetPartitionIdsOptions): Promise<Array<string>>;
-    /**
-     * Provides information about the state of the specified partition.
-     * @param partitionId - The id of the partition for which information is required.
-     * @param options - The set of options to apply to the operation call.
-     * @returns A promise that resolves with information about the state of the partition .
-     * @throws Error if the underlying connection has been closed, create a new EventHubBufferedProducerClient.
-     * @throws AbortError if the operation is cancelled via the abortSignal.
-     */
-    getPartitionProperties(partitionId: string, options?: GetPartitionPropertiesOptions): Promise<PartitionProperties>;
-    /**
-     * Gets the `BatchingPartitionChannel` associated with the partitionId.
-     *
-     * If one does not exist, it is created.
-     */
-    private _getPartitionChannel;
-    /**
-     * Returns the total number of buffered events across all partitions.
-     */
-    private _getTotalBufferedEventsCount;
-}
-/**
- * Describes the options that can be provided while creating the `EventHubBufferedProducerClient`.
- */
-export declare interface EventHubBufferedProducerClientOptions extends EventHubClientOptions {
-    /**
-     * The total number of events that can be buffered for publishing at a given time for a given partition.
-     *
-     * Default: 1500
-     */
-    maxEventBufferLengthPerPartition?: number;
-    /**
-     * The amount of time to wait for a new event to be enqueued in the buffer before publishing a partially full batch.
-     *
-     * Default: 1 second.
-     */
-    maxWaitTimeInMs?: number;
-    /**
-     * The handler to call once a batch has successfully published.
-     */
-    onSendEventsSuccessHandler?: (ctx: OnSendEventsSuccessContext) => Promise<void>;
-    /**
-     * The handler to call when a batch fails to publish.
-     */
-    onSendEventsErrorHandler: (ctx: OnSendEventsErrorContext) => Promise<void>;
-}
 /**
  * Describes the options that can be provided while creating the EventHubClient.
  * - `userAgent`        : A string to append to the built in user agent string that is passed as a connection property
@@ -1225,40 +972,8 @@ export declare interface LoadBalancingOptions {
  * The `@azure/logger` configuration for this package.
  * This will output logs using the `azure:event-hubs` namespace prefix.
  */
-export declare const logger: AzureLogger;
+export declare const logger: import("@azure/logger").AzureLogger;
 export { MessagingError };
-/**
- * Contains the events that were not successfully sent to the Event Hub,
- * the partition they were assigned to, and the error that was encountered while sending.
- */
-export declare interface OnSendEventsErrorContext {
-    /**
-     * The partition each event was assigned.
-     */
-    partitionId: string;
-    /**
-     * The array of {@link EventData} and/or `AmqpAnnotatedMessage` that were not successfully sent to the Event Hub.
-     */
-    events: Array<EventData | AmqpAnnotatedMessage>;
-    /**
-     * The error that occurred when sending the associated events to the Event Hub.
-     */
-    error: Error;
-}
-/**
- * Contains the events that were successfully sent to the Event Hub,
- * and the partition they were assigned to.
- */
-export declare interface OnSendEventsSuccessContext {
-    /**
-     * The partition each event was assigned.
-     */
-    partitionId: string;
-    /**
-     * The array of {@link EventData} and/or `AmqpAnnotatedMessage` that were successfully sent to the Event Hub.
-     */
-    events: Array<EventData | AmqpAnnotatedMessage>;
-}
 /**
  * Options for configuring tracing and the abortSignal.
  */
@@ -1519,7 +1234,7 @@ export declare interface SubscribeOptions {
     /**
      * 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