Поделиться через


CreateBatchOptions interface

Параметры настройки метода createBatch в EventHubProducerClient.

  • partitionKey: хэширование значения для создания назначения секции.
  • maxSizeInBytes: верхний предел размера пакета.
  • abortSignal: сигнал запроса на отмену операции отправки.

Пример использования:

{
    partitionKey: 'foo',
    maxSizeInBytes: 1024 * 1024 // 1 MB
}
Extends

Свойства

maxSizeInBytes

Верхний предел размера пакета. Функция tryAdd возвращает false после достижения этого ограничения.

partitionId

Этот пакет будет отправлен в раздел. Если это значение задано, невозможно задать partitionKey.

partitionKey

Хэширование значения для создания назначения секции. Это гарантирует, что сообщения с тем же разделом в конечном итоге будут в том же разделе. Если это значение задано, идентификатор секции нельзя задать.

Унаследованные свойства

abortSignal

Сигнал, который можно использовать для прерывания запросов.

tracingOptions

Параметры настройки трассировки.

Сведения о свойстве

maxSizeInBytes

Верхний предел размера пакета. Функция tryAdd возвращает false после достижения этого ограничения.

maxSizeInBytes?: number

Значение свойства

number

partitionId

Этот пакет будет отправлен в раздел. Если это значение задано, невозможно задать partitionKey.

partitionId?: string

Значение свойства

string

partitionKey

Хэширование значения для создания назначения секции. Это гарантирует, что сообщения с тем же разделом в конечном итоге будут в том же разделе. Если это значение задано, идентификатор секции нельзя задать.

partitionKey?: string

Значение свойства

string

Сведения об унаследованном свойстве

abortSignal

Сигнал, который можно использовать для прерывания запросов.

abortSignal?: AbortSignalLike

Значение свойства

наследуется отOperationOptions.abortSignal

tracingOptions

Параметры настройки трассировки.

tracingOptions?: OperationTracingOptions

Значение свойства

наследуется отOperationOptions.tracingOptions