SubscribeOptions interface

Pakiet:

@azure/event-hubs

Opcje konfigurowania metody subscribe w EventHubConsumerClient. Na przykład { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }

Właściwości

maxBatchSize	Liczba zdarzeń do żądania na partię
maxWaitTimeInSeconds	Maksymalny czas oczekiwania na utworzenie żądanej liczby komunikatów przed przekazaniem danych do kodu użytkownika na potrzeby przetwarzania. Jeśli nie zostanie podana, wartość domyślna to 60 sekund.
ownerLevel	Poziom właściciela do użycia jako ta subskrypcja subskrybuje partycje.
prefetchCount	Liczba zdarzeń zażądanych z niecierpliwością i w kolejce bez względu na to, czy zażądano odczytu.
skipParsingBodyAsJson	Opcja wyłączenia klienta z uruchamiania pliku JSON.parse() w treści komunikatu podczas odbierania komunikatu. Nie dotyczy, jeśli wiadomość została wysłana z wartością lub sekwencją typu treści protokołu AMQP. Użyj tej opcji, jeśli wolisz pracować bezpośrednio z bajtami obecnymi w treści komunikatu niż klient próbuje go przeanalizować.
startPosition	Pozycja zdarzenia w partycji, aby rozpocząć odbieranie zdarzeń od momentu znalezienia punktu kontrolnego. Przekaż mapę identyfikatora partycji do pozycji, jeśli chcesz użyć innej pozycji początkowej dla każdej partycji.
tracingOptions	Opcje konfigurowania śledzenia.
trackLastEnqueuedEventProperties	Wskazuje, czy odbiorca powinien zażądać informacji o ostatnim zdarzeniu w kolejce na skojarzonej partycji i śledzić te informacje w miarę odbierania zdarzeń. Gdy są śledzone informacje o ostatnim zdarzeniu w kolejce partycji, każde zdarzenie odebrane z usługi Event Hubs będzie przenosić metadane dotyczące partycji, która w przeciwnym razie nie byłaby. Powoduje to niewielkie wykorzystanie dodatkowej przepustowości sieci, które jest zazwyczaj korzystnym kompromisem w przypadku okresowego podejmowania żądań dotyczących właściwości partycji przy użyciu klienta centrum zdarzeń.

Szczegóły właściwości

maxBatchSize

Liczba zdarzeń do żądania na partię

maxBatchSize?: number

Wartość właściwości

number

maxWaitTimeInSeconds

Maksymalny czas oczekiwania na utworzenie żądanej liczby komunikatów przed przekazaniem danych do kodu użytkownika na potrzeby przetwarzania. Jeśli nie zostanie podana, wartość domyślna to 60 sekund.

maxWaitTimeInSeconds?: number

Wartość właściwości

number

ownerLevel

Poziom właściciela do użycia jako ta subskrypcja subskrybuje partycje.

ownerLevel?: number

Wartość właściwości

number

prefetchCount

Liczba zdarzeń zażądanych z niecierpliwością i w kolejce bez względu na to, czy zażądano odczytu.

prefetchCount?: number

Wartość właściwości

number

skipParsingBodyAsJson

Opcja wyłączenia klienta z uruchamiania pliku JSON.parse() w treści komunikatu podczas odbierania komunikatu. Nie dotyczy, jeśli wiadomość została wysłana z wartością lub sekwencją typu treści protokołu AMQP. Użyj tej opcji, jeśli wolisz pracować bezpośrednio z bajtami obecnymi w treści komunikatu niż klient próbuje go przeanalizować.

skipParsingBodyAsJson?: boolean

Wartość właściwości

boolean

startPosition

Pozycja zdarzenia w partycji, aby rozpocząć odbieranie zdarzeń od momentu znalezienia punktu kontrolnego. Przekaż mapę identyfikatora partycji do pozycji, jeśli chcesz użyć innej pozycji początkowej dla każdej partycji.

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

Wartość właściwości

EventPosition | {[partitionId: string]: EventPosition}

tracingOptions

Opcje konfigurowania śledzenia.

tracingOptions?: OperationTracingOptions

Wartość właściwości

OperationTracingOptions

trackLastEnqueuedEventProperties

Wskazuje, czy odbiorca powinien zażądać informacji o ostatnim zdarzeniu w kolejce na skojarzonej partycji i śledzić te informacje w miarę odbierania zdarzeń.

Gdy są śledzone informacje o ostatnim zdarzeniu w kolejce partycji, każde zdarzenie odebrane z usługi Event Hubs będzie przenosić metadane dotyczące partycji, która w przeciwnym razie nie byłaby. Powoduje to niewielkie wykorzystanie dodatkowej przepustowości sieci, które jest zazwyczaj korzystnym kompromisem w przypadku okresowego podejmowania żądań dotyczących właściwości partycji przy użyciu klienta centrum zdarzeń.

trackLastEnqueuedEventProperties?: boolean

Wartość właściwości

boolean