SubscribeOptions interface

Pacote:

@azure/event-hubs

Opções para configurar o método subscribe no EventHubConsumerClient. Por exemplo, { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }

Propriedades

maxBatchSize	O número de eventos a solicitar por lote
maxWaitTimeInSeconds	A quantidade máxima de tempo de espera para construir a contagem de mensagens solicitadas antes de passar os dados para o código do usuário para processamento. Se não for fornecido, o padrão será de 60 segundos.
ownerLevel	O nível de proprietário a utilizar à medida que esta subscrição subscreve partições.
prefetchCount	A contagem de eventos solicitados ansiosamente e enfileirados sem levar em conta se uma leitura foi solicitada.
skipParsingBodyAsJson	Opção para desativar o cliente de executar JSON.parse() no corpo da mensagem ao receber a mensagem. Não aplicável se a mensagem foi enviada com o valor ou sequência do tipo de corpo AMQP. Use essa opção quando preferir trabalhar diretamente com os bytes presentes no corpo da mensagem do que fazer com que o cliente tente analisá-la.
startPosition	A posição do evento em uma partição para começar a receber eventos se nenhum ponto de verificação for encontrado. Passe um mapa de id de partição para a posição se você gostaria de usar uma posição inicial diferente para cada partição.
tracingOptions	Opções para configurar o rastreamento.
trackLastEnqueuedEventProperties	Indica se o consumidor deve ou não solicitar informações sobre o último evento enfileirado em sua partição associada e acompanhar essas informações à medida que os eventos são recebidos. Quando as informações sobre o último evento enfileirado da partição estiverem sendo rastreadas, cada evento recebido do serviço Hubs de Eventos carregará metadados sobre a partição que, de outra forma, não faria. Isso resulta em uma pequena quantidade de consumo adicional de largura de banda de rede que geralmente é uma compensação favorável quando considerada contra a realização periódica de solicitações de propriedades de partição usando o cliente do Hub de Eventos.

Detalhes de Propriedade

maxBatchSize

O número de eventos a solicitar por lote

maxBatchSize?: number

Valor de Propriedade

number

maxWaitTimeInSeconds

A quantidade máxima de tempo de espera para construir a contagem de mensagens solicitadas antes de passar os dados para o código do usuário para processamento. Se não for fornecido, o padrão será de 60 segundos.

maxWaitTimeInSeconds?: number

Valor de Propriedade

number

ownerLevel

O nível de proprietário a utilizar à medida que esta subscrição subscreve partições.

ownerLevel?: number

Valor de Propriedade

number

prefetchCount

A contagem de eventos solicitados ansiosamente e enfileirados sem levar em conta se uma leitura foi solicitada.

prefetchCount?: number

Valor de Propriedade

number

skipParsingBodyAsJson

Opção para desativar o cliente de executar JSON.parse() no corpo da mensagem ao receber a mensagem. Não aplicável se a mensagem foi enviada com o valor ou sequência do tipo de corpo AMQP. Use essa opção quando preferir trabalhar diretamente com os bytes presentes no corpo da mensagem do que fazer com que o cliente tente analisá-la.

skipParsingBodyAsJson?: boolean

Valor de Propriedade

boolean

startPosition

A posição do evento em uma partição para começar a receber eventos se nenhum ponto de verificação for encontrado. Passe um mapa de id de partição para a posição se você gostaria de usar uma posição inicial diferente para cada partição.

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

Valor de Propriedade

EventPosition | {[partitionId: string]: EventPosition}

tracingOptions

Opções para configurar o rastreamento.

tracingOptions?: OperationTracingOptions

Valor de Propriedade

OperationTracingOptions

trackLastEnqueuedEventProperties

Indica se o consumidor deve ou não solicitar informações sobre o último evento enfileirado em sua partição associada e acompanhar essas informações à medida que os eventos são recebidos.

Quando as informações sobre o último evento enfileirado da partição estiverem sendo rastreadas, cada evento recebido do serviço Hubs de Eventos carregará metadados sobre a partição que, de outra forma, não faria. Isso resulta em uma pequena quantidade de consumo adicional de largura de banda de rede que geralmente é uma compensação favorável quando considerada contra a realização periódica de solicitações de propriedades de partição usando o cliente do Hub de Eventos.

trackLastEnqueuedEventProperties?: boolean

Valor de Propriedade

boolean