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

CreateBatchOptions interface

  • Ссылка
Пакет:
@azure/event-hubs

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

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

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

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

Свойства

maxSizeInBytes

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

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

Значение, хэширование которого выполняется для создания назначения секции. Это гарантирует, что сообщения с тем же partitionKey в конечном итоге будут в той же секции. Если это значение задано, параметр partitionId не может быть задан.

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

abortSignal

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

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

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

maxSizeInBytes

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

maxSizeInBytes?: number

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

number

partitionId

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

partitionId?: string

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

string

partitionKey

Значение, хэширование которого выполняется для создания назначения секции. Это гарантирует, что сообщения с тем же partitionKey в конечном итоге будут в той же секции. Если это значение задано, параметр partitionId не может быть задан.

partitionKey?: string

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

string

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

abortSignal

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

abortSignal?: AbortSignalLike

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

AbortSignalLike

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

tracingOptions

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

tracingOptions?: OperationTracingOptions

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

OperationTracingOptions

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