ReceiveEventsOptions interface

Pakiet:

@azure/eventgrid-namespaces

Opcje odbierania zdarzeń

Rozszerzenie

ReceiveEventsOptionalParams

Właściwości dziedziczone

abortSignal	Sygnał, który może służyć do przerwania żądań.
maxEvents	Maksymalna liczba zdarzeń do odebrania. Wartość minimalna to 1, a wartość maksymalna to 100 zdarzeń. Jeśli nie zostanie określony, wartość domyślna to 1.
maxWaitTime	Maksymalna wartość czasu oczekiwania dla operacji odbierania w sekundach. Jest to czas w sekundach, przez który serwer oczekuje na dostępność zdarzenia i odpowiada na żądanie. Jeśli zdarzenie jest dostępne, broker natychmiast odpowiada klientowi. Wartość minimalna to 10 sekund, a maksymalna wartość to 120 sekund. Jeśli nie zostanie określony, wartość domyślna to 60 sekund.
onResponse	Funkcja, która ma być wywoływana za każdym razem, gdy odpowiedź jest odbierana z serwera podczas wykonywania żądanej operacji. Może być wywoływana wiele razy.
requestOptions	Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji.
tracingOptions	Opcje używane podczas śledzenia są włączone.

Szczegóły właściwości dziedziczonej

abortSignal

Sygnał, który może służyć do przerwania żądań.

abortSignal?: AbortSignalLike

Wartość właściwości

AbortSignalLike

dziedziczone zReceiveEventsOptionalParams.abortSignal

maxEvents

Maksymalna liczba zdarzeń do odebrania. Wartość minimalna to 1, a wartość maksymalna to 100 zdarzeń. Jeśli nie zostanie określony, wartość domyślna to 1.

maxEvents?: number

Wartość właściwości

number

dziedziczone zReceiveEventsOptionalParams.maxEvents

maxWaitTime

Maksymalna wartość czasu oczekiwania dla operacji odbierania w sekundach. Jest to czas w sekundach, przez który serwer oczekuje na dostępność zdarzenia i odpowiada na żądanie. Jeśli zdarzenie jest dostępne, broker natychmiast odpowiada klientowi. Wartość minimalna to 10 sekund, a maksymalna wartość to 120 sekund. Jeśli nie zostanie określony, wartość domyślna to 60 sekund.

maxWaitTime?: number

Wartość właściwości

number

dziedziczone zReceiveEventsOptionalParams.maxWaitTime

onResponse

Funkcja, która ma być wywoływana za każdym razem, gdy odpowiedź jest odbierana z serwera podczas wykonywania żądanej operacji. Może być wywoływana wiele razy.

onResponse?: RawResponseCallback

Wartość właściwości

RawResponseCallback

dziedziczone zReceiveEventsOptionalParams.onResponse

requestOptions

Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji.

requestOptions?: OperationRequestOptions

Wartość właściwości

OperationRequestOptions

dziedziczone zReceiveEventsOptionalParams.requestOptions

tracingOptions

Opcje używane podczas śledzenia są włączone.

tracingOptions?: OperationTracingOptions

Wartość właściwości

OperationTracingOptions

dziedziczone zReceiveEventsOptionalParams.tracingOptions