SubscribeOptions interface

Paquete:

@azure/event-hubs

Opciones para configurar el método subscribe en el EventHubConsumerClient. Por ejemplo, { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }

Propiedades

maxBatchSize	Número de eventos que se van a solicitar por lote
maxWaitTimeInSeconds	Cantidad máxima de tiempo de espera para compilar el recuento de mensajes solicitado antes de pasar los datos al código de usuario para su procesamiento. Si no se proporciona, el valor predeterminado es de 60 segundos.
ownerLevel	Nivel de propietario que se va a usar a medida que esta suscripción se suscribe a particiones.
prefetchCount	Recuento de eventos solicitados diligentemente y en cola sin tener en cuenta si se solicitó una lectura.
skipParsingBodyAsJson	Opción para deshabilitar que el cliente ejecute JSON.parse() en el cuerpo del mensaje al recibir el mensaje. No es aplicable si el mensaje se envió con el valor o secuencia del tipo de cuerpo AMQP. Use esta opción cuando prefiera trabajar directamente con los bytes presentes en el cuerpo del mensaje que si el cliente intenta analizarlo.
startPosition	Posición del evento en una partición para empezar a recibir eventos de si no se encuentra ningún punto de control. Pase un mapa del identificador de partición a la posición si desea usar una posición inicial diferente para cada partición.
tracingOptions	Opciones para configurar el seguimiento.
trackLastEnqueuedEventProperties	Indica si el consumidor debe solicitar información sobre el último evento en cola en su partición asociada y realizar un seguimiento de esa información a medida que se reciben los eventos. Cuando se realiza el seguimiento de la información sobre el último evento en cola de la partición, cada evento recibido del servicio Event Hubs contendrá metadatos sobre la partición que, de lo contrario, no lo haría. Esto da como resultado una pequeña cantidad de consumo adicional de ancho de banda de red que suele ser un equilibrio favorable cuando se considera que realiza solicitudes de propiedades de partición periódicamente mediante el cliente del centro de eventos.

Detalles de las propiedades

maxBatchSize

Número de eventos que se van a solicitar por lote

maxBatchSize?: number

Valor de propiedad

number

maxWaitTimeInSeconds

Cantidad máxima de tiempo de espera para compilar el recuento de mensajes solicitado antes de pasar los datos al código de usuario para su procesamiento. Si no se proporciona, el valor predeterminado es de 60 segundos.

maxWaitTimeInSeconds?: number

Valor de propiedad

number

ownerLevel

Nivel de propietario que se va a usar a medida que esta suscripción se suscribe a particiones.

ownerLevel?: number

Valor de propiedad

number

prefetchCount

Recuento de eventos solicitados diligentemente y en cola sin tener en cuenta si se solicitó una lectura.

prefetchCount?: number

Valor de propiedad

number

skipParsingBodyAsJson

Opción para deshabilitar que el cliente ejecute JSON.parse() en el cuerpo del mensaje al recibir el mensaje. No es aplicable si el mensaje se envió con el valor o secuencia del tipo de cuerpo AMQP. Use esta opción cuando prefiera trabajar directamente con los bytes presentes en el cuerpo del mensaje que si el cliente intenta analizarlo.

skipParsingBodyAsJson?: boolean

Valor de propiedad

boolean

startPosition

Posición del evento en una partición para empezar a recibir eventos de si no se encuentra ningún punto de control. Pase un mapa del identificador de partición a la posición si desea usar una posición inicial diferente para cada partición.

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

Valor de propiedad

EventPosition | {[partitionId: string]: EventPosition}

tracingOptions

Opciones para configurar el seguimiento.

tracingOptions?: OperationTracingOptions

Valor de propiedad

OperationTracingOptions

trackLastEnqueuedEventProperties

Indica si el consumidor debe solicitar información sobre el último evento en cola en su partición asociada y realizar un seguimiento de esa información a medida que se reciben los eventos.

Cuando se realiza el seguimiento de la información sobre el último evento en cola de la partición, cada evento recibido del servicio Event Hubs contendrá metadatos sobre la partición que, de lo contrario, no lo haría. Esto da como resultado una pequeña cantidad de consumo adicional de ancho de banda de red que suele ser un equilibrio favorable cuando se considera que realiza solicitudes de propiedades de partición periódicamente mediante el cliente del centro de eventos.

trackLastEnqueuedEventProperties?: boolean

Valor de propiedad

boolean