EventDataBatch interface
Интерфейс, представляющий пакет событий, который можно использовать для отправки событий в Концентратор событий.
Чтобы создать пакет, используйте метод createBatch() в EventHubProducerClient.
Чтобы отправить пакет, используйте метод sendBatch() на том же клиенте.
Чтобы заполнить пакет, используйте метод tryAdd() в самом пакете.
Свойства
| count | Количество событий, добавленных в пакет. |
| max |
Максимальный размер пакета в байтах. Функция |
| size |
Размер пакета в байтах после добавления в него событий был закодирован в одно сообщение AMQP. |
Методы
| try |
Добавляет событие в пакет, если разрешено ограничением размера пакета. ПРИМЕЧАНИЕ. Всегда не забывайте проверять возвращаемое значение этого метода, прежде чем вызывать его еще раз для следующего события. |
Сведения о свойстве
count
Количество событий, добавленных в пакет.
count: numberЗначение свойства
number
maxSizeInBytes
Максимальный размер пакета в байтах. Функция tryAdd в пакете возвращает false, если добавляемое событие приводит к превышению этого ограничения размера пакета. Используйте метод createBatch() в EventHubProducerClient, чтобы задать maxSizeInBytes.
maxSizeInBytes: numberЗначение свойства
number
sizeInBytes
Размер пакета в байтах после добавления в него событий был закодирован в одно сообщение AMQP.
sizeInBytes: numberЗначение свойства
number
Сведения о методе
tryAdd(EventData | AmqpAnnotatedMessage, TryAddOptions)
Добавляет событие в пакет, если разрешено ограничением размера пакета. ПРИМЕЧАНИЕ. Всегда не забывайте проверять возвращаемое значение этого метода, прежде чем вызывать его еще раз для следующего события.
function tryAdd(eventData: EventData | AmqpAnnotatedMessage, options?: TryAddOptions): booleanПараметры
- eventData
Отдельный объект данных событий или AmqpAnnotatedMessage.
- options
- TryAddOptions
Возвращаемое значение
boolean
Логическое значение, указывающее, добавлены ли данные события в пакет или нет.