Compartilhar via

SubscribeOptions interface

  • Referência
Pacote:
@azure/event-hubs

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

Propriedades

maxBatchSize

O número de eventos a serem solicitados por lote
maxWaitTimeInSeconds

O tempo máximo de espera para compilar 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á 60 segundos.
ownerLevel

O nível de proprietário a ser usado como esta assinatura assina as partições.
prefetchCount

A contagem de eventos solicitados ansiosamente e enfileirados sem considerar se uma leitura foi solicitada.
skipParsingBodyAsJson

Opção para desabilitar 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 de se nenhum ponto de verificação for encontrado. Passe um mapa de ID de partição para posicionar se quiser 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 informações sobre o último evento enfileirado da partição estiverem sendo controladas, cada evento recebido do serviço hubs de eventos transportará metadados sobre a partição que, de outra forma, não 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 para fazer periodicamente solicitações de propriedades de partição usando o cliente do Hub de Eventos.

Detalhes da propriedade

maxBatchSize

O número de eventos a serem solicitados por lote

maxBatchSize?: number

Valor da propriedade

number

maxWaitTimeInSeconds

O tempo máximo de espera para compilar 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á 60 segundos.

maxWaitTimeInSeconds?: number

Valor da propriedade

number

ownerLevel

O nível de proprietário a ser usado como esta assinatura assina as partições.

ownerLevel?: number

Valor da propriedade

number

prefetchCount

A contagem de eventos solicitados ansiosamente e enfileirados sem considerar se uma leitura foi solicitada.

prefetchCount?: number

Valor da propriedade

number

skipParsingBodyAsJson

Opção para desabilitar 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 da propriedade

boolean

startPosition

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

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

Valor da propriedade

EventPosition | {[partitionId: string]: EventPosition}

tracingOptions

Opções para configurar o rastreamento.

tracingOptions?: OperationTracingOptions

Valor da 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 informações sobre o último evento enfileirado da partição estiverem sendo controladas, cada evento recebido do serviço hubs de eventos transportará metadados sobre a partição que, de outra forma, não 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 para fazer periodicamente solicitações de propriedades de partição usando o cliente do Hub de Eventos.

trackLastEnqueuedEventProperties?: boolean

Valor da propriedade

boolean