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