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