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

SubscribeOptions interface

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

Параметры для настройки subscribe метода в EventHubConsumerClient. Например { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }.

Свойства

maxBatchSize

Количество событий для запроса на пакет
maxWaitTimeInSeconds

Максимальное время ожидания создания запрошенного количества сообщений перед передачей данных пользовательскому коду для обработки. Если параметр не указан, значение по умолчанию — 60 секунд.
ownerLevel

Уровень владельца, используемый в качестве подписки, подписывается на секции.
prefetchCount

Количество событий, запрашиваемых и помещенных в очередь, независимо от того, было ли запрошено чтение.
skipParsingBodyAsJson

Параметр для отключения запуска json.parse() в тексте сообщения при получении сообщения. Неприменимо, если сообщение было отправлено со значением или последовательностью типа текста AMQP. Используйте этот параметр, если вы предпочитаете работать непосредственно с байтами, имеющимися в тексте сообщения, чем при попытке клиента проанализировать его.
startPosition

Позиция события в секции, с помощью чего начинается получение событий, если контрольная точка не найдена. Передайте карту идентификатора секции в положение, если вы хотите использовать разные начальные позиции для каждой секции.
tracingOptions

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

Указывает, должен ли потребитель запрашивать сведения о последнем событии в очереди в связанной секции и отслеживать эти сведения по мере получения событий.

При отслеживании сведений о последнем событии секции в очереди каждое событие, полученное от службы Центров событий, будет содержать метаданные о секции, которых в противном случае не было бы. Это приводит к небольшому объему дополнительного потребления пропускной способности сети, что, как правило, является благоприятным компромиссом при рассмотрении проблемы с периодическим выполнением запросов свойств секции с помощью клиента концентратора событий.

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

maxBatchSize

Количество событий для запроса на пакет

maxBatchSize?: number

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

number

maxWaitTimeInSeconds

Максимальное время ожидания создания запрошенного количества сообщений перед передачей данных пользовательскому коду для обработки. Если параметр не указан, значение по умолчанию — 60 секунд.

maxWaitTimeInSeconds?: number

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

number

ownerLevel

Уровень владельца, используемый в качестве подписки, подписывается на секции.

ownerLevel?: number

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

number

prefetchCount

Количество событий, запрашиваемых и помещенных в очередь, независимо от того, было ли запрошено чтение.

prefetchCount?: number

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

number

skipParsingBodyAsJson

Параметр для отключения запуска json.parse() в тексте сообщения при получении сообщения. Неприменимо, если сообщение было отправлено со значением или последовательностью типа текста AMQP. Используйте этот параметр, если вы предпочитаете работать непосредственно с байтами, имеющимися в тексте сообщения, чем при попытке клиента проанализировать его.

skipParsingBodyAsJson?: boolean

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

boolean

startPosition

Позиция события в секции, с помощью чего начинается получение событий, если контрольная точка не найдена. Передайте карту идентификатора секции в положение, если вы хотите использовать разные начальные позиции для каждой секции.

startPosition?: EventPosition | {[partitionId: string]: EventPosition}

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

EventPosition | {[partitionId: string]: EventPosition}

tracingOptions

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

tracingOptions?: OperationTracingOptions

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

OperationTracingOptions

trackLastEnqueuedEventProperties

Указывает, должен ли потребитель запрашивать сведения о последнем событии в очереди в связанной секции и отслеживать эти сведения по мере получения событий.

При отслеживании сведений о последнем событии секции в очереди каждое событие, полученное от службы Центров событий, будет содержать метаданные о секции, которых в противном случае не было бы. Это приводит к небольшому объему дополнительного потребления пропускной способности сети, что, как правило, является благоприятным компромиссом при рассмотрении проблемы с периодическим выполнением запросов свойств секции с помощью клиента концентратора событий.

trackLastEnqueuedEventProperties?: boolean

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

boolean