EventHubBufferedProducerClientOptions.yml

### YamlMime:TSType
name: EventHubBufferedProducerClientOptions
uid: '@azure/event-hubs.EventHubBufferedProducerClientOptions'
package: '@azure/event-hubs'
summary: >-
  Describes the options that can be provided while creating the
  `EventHubBufferedProducerClient`.
fullName: EventHubBufferedProducerClientOptions
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: enableIdempotentRetries
    uid: >-
      @azure/event-hubs.EventHubBufferedProducerClientOptions.enableIdempotentRetries
    package: '@azure/event-hubs'
    summary: >-
      Indicates whether or not the EventHubProducerClient should enable
      idempotent publishing to Event Hub partitions.

      If enabled, the producer will only be able to publish directly to
      partitions;

      it will not be able to publish to the Event Hubs gateway for automatic
      partition routing

      nor will it be able to use a partition key.

      Default: false
    fullName: enableIdempotentRetries
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'enableIdempotentRetries?: boolean'
      return:
        description: ''
        type: boolean
  - name: maxEventBufferLengthPerPartition
    uid: >-
      @azure/event-hubs.EventHubBufferedProducerClientOptions.maxEventBufferLengthPerPartition
    package: '@azure/event-hubs'
    summary: >-
      The total number of events that can be buffered for publishing at a given
      time for a given partition.


      Default: 1500
    fullName: maxEventBufferLengthPerPartition
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'maxEventBufferLengthPerPartition?: number'
      return:
        description: ''
        type: number
  - name: maxWaitTimeInMs
    uid: '@azure/event-hubs.EventHubBufferedProducerClientOptions.maxWaitTimeInMs'
    package: '@azure/event-hubs'
    summary: >-
      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.
    fullName: maxWaitTimeInMs
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'maxWaitTimeInMs?: number'
      return:
        description: ''
        type: number
  - name: onSendEventsErrorHandler
    uid: >-
      @azure/event-hubs.EventHubBufferedProducerClientOptions.onSendEventsErrorHandler
    package: '@azure/event-hubs'
    summary: The handler to call when a batch fails to publish.
    fullName: onSendEventsErrorHandler
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'onSendEventsErrorHandler: (ctx: OnSendEventsErrorContext) => void'
      return:
        description: ''
        type: '(ctx: OnSendEventsErrorContext) => void'
  - name: onSendEventsSuccessHandler
    uid: >-
      @azure/event-hubs.EventHubBufferedProducerClientOptions.onSendEventsSuccessHandler
    package: '@azure/event-hubs'
    summary: The handler to call once a batch has successfully published.
    fullName: onSendEventsSuccessHandler
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'onSendEventsSuccessHandler?: (ctx: OnSendEventsSuccessContext) => void'
      return:
        description: ''
        type: '(ctx: OnSendEventsSuccessContext) => void'
inheritedProperties:
  - name: customEndpointAddress
    uid: >-
      @azure/event-hubs.EventHubBufferedProducerClientOptions.customEndpointAddress
    package: '@azure/event-hubs'
    summary: |-
      A custom endpoint to use when connecting to the Event Hubs service.
      This can be useful when your network does not allow connecting to the
      standard Azure Event Hubs endpoint address, but does allow connecting
      through an intermediary.

      Example: "https://my.custom.endpoint:100/"
    fullName: customEndpointAddress
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'customEndpointAddress?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [EventHubClientOptions.customEndpointAddress](xref:@azure/event-hubs.EventHubClientOptions.customEndpointAddress)
  - name: identifier
    uid: '@azure/event-hubs.EventHubBufferedProducerClientOptions.identifier'
    package: '@azure/event-hubs'
    summary: >-
      A unique name used to identify the client.  If not provided, a GUID will
      be used as the identifier
    fullName: identifier
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'identifier?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [EventHubClientOptions.identifier](xref:@azure/event-hubs.EventHubClientOptions.identifier)
  - name: retryOptions
    uid: '@azure/event-hubs.EventHubBufferedProducerClientOptions.retryOptions'
    package: '@azure/event-hubs'
    summary: >-
      Options to configure the retry policy for all the operations on the
      client.

      For example, `{ "maxRetries": 4 }` or `{ "maxRetries": 4,
      "retryDelayInMs": 30000 }`.
    fullName: retryOptions
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'retryOptions?: RetryOptions'
      return:
        description: ''
        type: <xref uid="@azure/event-hubs.RetryOptions" />
    inheritanceDescription: >-
      <b>Inherited From</b>
      [EventHubClientOptions.retryOptions](xref:@azure/event-hubs.EventHubClientOptions.retryOptions)
  - name: userAgent
    uid: '@azure/event-hubs.EventHubBufferedProducerClientOptions.userAgent'
    package: '@azure/event-hubs'
    summary: >-
      Value that is appended to the built in user agent string that is passed to
      the Event Hubs service.
    fullName: userAgent
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'userAgent?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [EventHubClientOptions.userAgent](xref:@azure/event-hubs.EventHubClientOptions.userAgent)
  - name: webSocketOptions
    uid: '@azure/event-hubs.EventHubBufferedProducerClientOptions.webSocketOptions'
    package: '@azure/event-hubs'
    summary: >-
      Options to configure the channelling of the AMQP connection over Web
      Sockets.
    fullName: webSocketOptions
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'webSocketOptions?: WebSocketOptions'
      return:
        description: ''
        type: <xref uid="@azure/event-hubs.WebSocketOptions" />
    inheritanceDescription: >-
      <b>Inherited From</b>
      [EventHubClientOptions.webSocketOptions](xref:@azure/event-hubs.EventHubClientOptions.webSocketOptions)
extends: <xref uid="@azure/event-hubs.EventHubClientOptions" />