EventHubBufferedProducerClientOptions interface
Описывает параметры, которые можно указать при создании EventHubBufferedProducerClient
.
- Extends
Свойства
enable |
Указывает, должен ли eventHubProducerClient включить идемпотентную публикацию в секциях Концентратора событий. Если этот параметр включен, производитель сможет публиковать только непосредственно в секциях; Он не сможет публиковаться в шлюзе Центров событий для автоматической маршрутизации секций и не сможет использовать ключ секции. Значение по умолчанию: false |
max |
Общее количество событий, которые можно буферивировать для публикации в заданное время для заданной секции. По умолчанию: 1500 |
max |
Время ожидания нового события в буфере перед публикацией частично полного пакета. Значение по умолчанию: 1 секунда. |
on |
Обработчик, вызывающий, когда пакет не сможет опубликовать. |
on |
Обработчик для вызова после успешной публикации пакета. |
Унаследованные свойства
custom |
Пользовательская конечная точка, используемая при подключении к службе Центров событий. Это может быть полезно, если сеть не разрешает подключение к стандартному адресу конечной точки Центров событий Azure, но разрешает подключение через посредника. Пример: "https://my.custom.endpoint:100/" |
identifier | Уникальное имя, используемое для идентификации клиента. Если это не указано, идентификатор GUID будет использоваться в качестве идентификатора. |
retry |
Параметры настройки политики повторных попыток для всех операций на клиенте.
Например, |
user |
Значение, добавляемое к встроенной строке агента пользователя, передаваемой службе Центров событий. |
web |
Параметры настройки канала подключения AMQP через веб-сокеты. |
Сведения о свойстве
enableIdempotentRetries
Указывает, должен ли eventHubProducerClient включить идемпотентную публикацию в секциях Концентратора событий. Если этот параметр включен, производитель сможет публиковать только непосредственно в секциях; Он не сможет публиковаться в шлюзе Центров событий для автоматической маршрутизации секций и не сможет использовать ключ секции. Значение по умолчанию: false
enableIdempotentRetries?: boolean
Значение свойства
boolean
maxEventBufferLengthPerPartition
Общее количество событий, которые можно буферивировать для публикации в заданное время для заданной секции.
По умолчанию: 1500
maxEventBufferLengthPerPartition?: number
Значение свойства
number
maxWaitTimeInMs
Время ожидания нового события в буфере перед публикацией частично полного пакета.
Значение по умолчанию: 1 секунда.
maxWaitTimeInMs?: number
Значение свойства
number
onSendEventsErrorHandler
Обработчик, вызывающий, когда пакет не сможет опубликовать.
onSendEventsErrorHandler: (ctx: OnSendEventsErrorContext) => void
Значение свойства
(ctx: OnSendEventsErrorContext) => void
onSendEventsSuccessHandler
Обработчик для вызова после успешной публикации пакета.
onSendEventsSuccessHandler?: (ctx: OnSendEventsSuccessContext) => void
Значение свойства
(ctx: OnSendEventsSuccessContext) => void
Сведения об унаследованном свойстве
customEndpointAddress
Пользовательская конечная точка, используемая при подключении к службе Центров событий. Это может быть полезно, если сеть не разрешает подключение к стандартному адресу конечной точки Центров событий Azure, но разрешает подключение через посредника.
Пример: "https://my.custom.endpoint:100/"
customEndpointAddress?: string
Значение свойства
string
Наследуется отEventHubClientOptions.customEndpointAddress
identifier
Уникальное имя, используемое для идентификации клиента. Если это не указано, идентификатор GUID будет использоваться в качестве идентификатора.
identifier?: string
Значение свойства
string
наследуется отEventHubClientOptions.identifier
retryOptions
Параметры настройки политики повторных попыток для всех операций на клиенте.
Например, { "maxRetries": 4 }
или { "maxRetries": 4, "retryDelayInMs": 30000 }
.
retryOptions?: RetryOptions
Значение свойства
унаследовано отEventHubClientOptions.retryOptions
userAgent
Значение, добавляемое к встроенной строке агента пользователя, передаваемой службе Центров событий.
userAgent?: string
Значение свойства
string
наследуется отEventHubClientOptions.userAgent
webSocketOptions
Параметры настройки канала подключения AMQP через веб-сокеты.
webSocketOptions?: WebSocketOptions
Значение свойства
наследуется отEventHubClientOptions.webSocketOptions