SubscribeOptions interface
Opções para configurar o subscribe método no EventHubConsumerClient.
Por exemplo, { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }
Propriedades
| max |
O número de eventos a pedir por lote |
| max |
A quantidade máxima de tempo a aguardar para aumentar a contagem de mensagens pedidas antes de transmitir os dados para o código do utilizador para processamento. Se não for fornecido, a predefinição é de 60 segundos. |
| owner |
O nível de proprietário a utilizar como esta subscrição subscreve partições. |
| prefetch |
A contagem de eventos pedidos ansiosamente e em fila, sem ter em conta se foi pedida uma leitura. |
| skip |
Opção para desativar o cliente da execução de JSON.parse() no corpo da mensagem ao receber a mensagem. Não aplicável se a mensagem tiver sido enviada com o valor ou sequência do tipo de corpo AMQP. Utilize esta opção quando preferir trabalhar diretamente com os bytes presentes no corpo da mensagem do que se o cliente tentar analisá-la. |
| start |
A posição do evento numa partição para começar a receber eventos se não for encontrado nenhum ponto de verificação. Transmita um mapa do ID de partição para a posição se quiser utilizar uma posição inicial diferente para cada partição. |
| tracing |
Opções para configurar o rastreio. |
| track |
Indica se o consumidor deve ou não pedir informações sobre o último evento em fila na partição associada e controlar essas informações à medida que os eventos são recebidos. Quando as informações sobre o último evento enqueunciado da partição estiverem a ser controladas, cada evento recebido do serviço Hubs de Eventos irá transportar metadados sobre a partição que de outra forma não teria. Isto resulta numa pequena quantidade de consumo de largura de banda de rede adicional que é geralmente uma compensação favorável quando considerada contra a realização periódica de pedidos de propriedades de partição com o cliente do Hub de Eventos. |
Detalhes de Propriedade
maxBatchSize
O número de eventos a pedir por lote
maxBatchSize?: numberValor de Propriedade
number
maxWaitTimeInSeconds
A quantidade máxima de tempo a aguardar para aumentar a contagem de mensagens pedidas antes de transmitir os dados para o código do utilizador para processamento. Se não for fornecido, a predefinição é de 60 segundos.
maxWaitTimeInSeconds?: numberValor de Propriedade
number
ownerLevel
O nível de proprietário a utilizar como esta subscrição subscreve partições.
ownerLevel?: numberValor de Propriedade
number
prefetchCount
A contagem de eventos pedidos ansiosamente e em fila, sem ter em conta se foi pedida uma leitura.
prefetchCount?: numberValor de Propriedade
number
skipParsingBodyAsJson
Opção para desativar o cliente da execução de JSON.parse() no corpo da mensagem ao receber a mensagem. Não aplicável se a mensagem tiver sido enviada com o valor ou sequência do tipo de corpo AMQP. Utilize esta opção quando preferir trabalhar diretamente com os bytes presentes no corpo da mensagem do que se o cliente tentar analisá-la.
skipParsingBodyAsJson?: booleanValor de Propriedade
boolean
startPosition
A posição do evento numa partição para começar a receber eventos se não for encontrado nenhum ponto de verificação. Transmita um mapa do ID de partição para a posição se quiser utilizar 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 rastreio.
tracingOptions?: OperationTracingOptionsValor de Propriedade
trackLastEnqueuedEventProperties
Indica se o consumidor deve ou não pedir informações sobre o último evento em fila na partição associada e controlar essas informações à medida que os eventos são recebidos.
Quando as informações sobre o último evento enqueunciado da partição estiverem a ser controladas, cada evento recebido do serviço Hubs de Eventos irá transportar metadados sobre a partição que de outra forma não teria. Isto resulta numa pequena quantidade de consumo de largura de banda de rede adicional que é geralmente uma compensação favorável quando considerada contra a realização periódica de pedidos de propriedades de partição com o cliente do Hub de Eventos.
trackLastEnqueuedEventProperties?: booleanValor de Propriedade
boolean