SubscribeOptions interface

Pacchetto:

@azure/event-hubs

Opzioni per configurare il subscribe metodo in EventHubConsumerClient. Ad esempio, usare { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }

Proprietà

maxBatchSize	Numero di eventi da richiedere per batch
maxWaitTimeInSeconds	Tempo massimo di attesa per la compilazione del conteggio dei messaggi richiesto prima di passare i dati al codice utente per l'elaborazione. Se non specificato, il valore predefinito è 60 secondi.
ownerLevel	Livello di proprietario da usare quando questa sottoscrizione sottoscrive le partizioni.
prefetchCount	Numero di eventi richiesti in modo eager e accodato, indipendentemente dal fatto che sia stata richiesta una lettura.
skipParsingBodyAsJson	Opzione per disabilitare l'esecuzione del client JSON.parse() nel corpo del messaggio durante la ricezione del messaggio. Non applicabile se il messaggio è stato inviato con il valore o la sequenza del tipo di corpo AMQP. Usare questa opzione quando si preferisce usare direttamente i byte presenti nel corpo del messaggio rispetto al tentativo del client di analizzarlo.
startPosition	Posizione dell'evento in una partizione da cui iniziare a ricevere eventi se non viene trovato alcun checkpoint. Passare una mappa di ID partizione alla posizione se si vuole usare una posizione iniziale diversa per ogni partizione.
tracingOptions	Opzioni per la configurazione della traccia.
trackLastEnqueuedEventProperties	Indica se il consumer deve richiedere informazioni sull'ultimo evento accodato nella partizione associata e tenere traccia delle informazioni ricevute come eventi. Quando vengono rilevate informazioni sull'ultimo evento accodato della partizione, ogni evento ricevuto dal servizio Hub eventi conterrà metadati sulla partizione che altrimenti non lo farebbe. Ciò comporta una piccola quantità di utilizzo aggiuntivo della larghezza di banda di rete che è in genere un compromesso favorevole quando viene considerato contro l'esecuzione periodica di richieste per le proprietà di partizione usando il client hub eventi.

Dettagli proprietà

maxBatchSize

Numero di eventi da richiedere per batch

maxBatchSize?: number

Valore della proprietà

number

maxWaitTimeInSeconds

Tempo massimo di attesa per la compilazione del conteggio dei messaggi richiesto prima di passare i dati al codice utente per l'elaborazione. Se non specificato, il valore predefinito è 60 secondi.

maxWaitTimeInSeconds?: number

Valore della proprietà

number

ownerLevel

Livello di proprietario da usare quando questa sottoscrizione sottoscrive le partizioni.

ownerLevel?: number

Valore della proprietà

number

prefetchCount

Numero di eventi richiesti in modo eager e accodato, indipendentemente dal fatto che sia stata richiesta una lettura.

prefetchCount?: number

Valore della proprietà

number

skipParsingBodyAsJson

Opzione per disabilitare l'esecuzione del client JSON.parse() nel corpo del messaggio durante la ricezione del messaggio. Non applicabile se il messaggio è stato inviato con il valore o la sequenza del tipo di corpo AMQP. Usare questa opzione quando si preferisce usare direttamente i byte presenti nel corpo del messaggio rispetto al tentativo del client di analizzarlo.

skipParsingBodyAsJson?: boolean

Valore della proprietà

boolean

startPosition

Posizione dell'evento in una partizione da cui iniziare a ricevere eventi se non viene trovato alcun checkpoint. Passare una mappa di ID partizione alla posizione se si vuole usare una posizione iniziale diversa per ogni partizione.

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

Valore della proprietà

EventPosition | {[partitionId: string]: EventPosition}

tracingOptions

Opzioni per la configurazione della traccia.

tracingOptions?: OperationTracingOptions

Valore della proprietà

OperationTracingOptions

trackLastEnqueuedEventProperties

Indica se il consumer deve richiedere informazioni sull'ultimo evento accodato nella partizione associata e tenere traccia delle informazioni ricevute come eventi.

Quando vengono rilevate informazioni sull'ultimo evento accodato della partizione, ogni evento ricevuto dal servizio Hub eventi conterrà metadati sulla partizione che altrimenti non lo farebbe. Ciò comporta una piccola quantità di utilizzo aggiuntivo della larghezza di banda di rete che è in genere un compromesso favorevole quando viene considerato contro l'esecuzione periodica di richieste per le proprietà di partizione usando il client hub eventi.

trackLastEnqueuedEventProperties?: boolean

Valore della proprietà

boolean