EventHubBufferedProducerClient class

Csomag:

@azure/event-hubs

A EventHubBufferedProducerClienthasználatával eseményeket tehet közzé egy adott eseményközpontban.

A EventHubBufferedProducerClient nem teszi közzé azonnal az eseményeket. Ehelyett a rendszer puffereli az eseményeket, hogy hatékonyan kötegelhessék és közzétehessék őket, ha a köteg megtelt, vagy ha a maxWaitTimeInMs köteg eltelt, és nincsenek új események.

Az események lekérésekor megadott beállításoktól függően előfordulhat, hogy automatikusan hozzá lesznek rendelve egy partícióhoz, a megadott partíciókulcs szerint csoportosítva, vagy hozzárendelhetők egy kifejezetten kért partícióhoz.

Ez a modell arra szolgál, hogy a kötegkezelés terheit a hívóktól a nem determinisztikus időzítés árán elmozdítsa az események közzétételének időpontjára. További kompromisszumokat is figyelembe kell venni:

• Ha az alkalmazás összeomlik, a pufferben lévő események nem lesznek közzétéve. Az adatvesztés megelőzése érdekében a hívókat arra ösztönzik, hogy a és onSendEventsErrorHandler a kezelők használatával kövessék nyomon a onSendEventsSuccessHandler közzétételi folyamatot.
• A partíciókulcsot meghatározó események más partíciót rendelhetnek hozzá, mint azok, amelyek ugyanazt a kulcsot használják más gyártókkal.
• Abban a valószínűtlen esetben, ha egy partíció átmenetileg elérhetetlenné válik, a EventHubBufferedProducerClient helyreállítás több időt vehet igénybe, mint a többi gyártó.

Olyan esetekben, amikor fontos, hogy az események azonnal, determinisztikus eredménnyel legyenek közzétéve, győződjön meg arról, hogy a partíciókulcsok más közzétevőkkel konzisztens partícióhoz vannak rendelve, vagy ahol a rendelkezésre állás maximalizálása követelmény, az EventHubProducerClient ajánlott az használatával.

Konstruktorok

EventHubBufferedProducerClient(string, EventHubBufferedProducerClientOptions)	Az EventHubBufferedProducerClient osztály eseményközpontba küldi az eseményeket. options A parmeter használatával konfigurálhatja az újrapróbálkozési szabályzatot vagy a proxybeállításokat.
EventHubBufferedProducerClient(string, string, EventHubBufferedProducerClientOptions)	Az EventHubBufferedProducerClient osztály eseményközpontba küldi az eseményeket. options A parmeter használatával konfigurálhatja az újrapróbálkozési szabályzatot vagy a proxybeállításokat.
EventHubBufferedProducerClient(string, string, TokenCredential | NamedKeyCredential | SASCredential, EventHubBufferedProducerClientOptions)	Az EventHubBufferedProducerClient osztály eseményközpontba küldi az eseményeket. options A parmeter használatával konfigurálhatja az újrapróbálkozési szabályzatot vagy a proxybeállításokat.

Tulajdonságok

eventHubName	Annak az Event Hub-példánynak a neve, amelyhez az ügyfél létrejön.
fullyQualifiedNamespace	Annak az Event Hub-példánynak a teljes névtere, amelyhez az ügyfél létrejön. Ez valószínűleg hasonló lesz a .servicebus.windows.net-hoz.
identifier	Az EventHubBufferedProducerClient azonosításához használt név. Ha nincs megadva vagy üres, a rendszer létrehoz egy véletlenszerű egyedit.

Metódusok

close(BufferedCloseOptions)	Bezárja az AMQP-kapcsolatot az Event Hub-példányhoz, és visszaad egy ígéretet, amely a leválasztás befejezésekor megoldódik. Ez megvárja, amíg az enqueued események ki lesznek ürítve a szolgáltatásba a kapcsolat bezárása előtt. Ha kiürítés nélkül szeretne bezárni, állítsa a beállítást a flush következőre: false.
enqueueEvent(EventData | AmqpAnnotatedMessage, EnqueueEventOptions)	Egy eseményt a pufferbe helyez, amelyet közzé szeretne tenni az Event Hubon. Ha a metódus meghívásakor nincs kapacitás a pufferben, megvárja, amíg a hely elérhetővé válik, és meggyőződik arról, hogy az esemény le van foglalva. Amikor ez a hívás visszatér, az esemény bekerült a pufferbe, de lehet, hogy még nem lett közzétéve. A közzététel nem meghatározott időpontban történik a jövőben, mivel a puffer feldolgozása folyamatban van.
enqueueEvents(EventData[] | AmqpAnnotatedMessage[], EnqueueEventOptions)	Az eseményeket az eseményközpontban közzéteendő pufferbe alakítja. Ha a metódus meghívásakor nincs kapacitás a pufferben, megvárja, amíg a hely elérhetővé válik, és meggyőződik arról, hogy az események le vannak foglalva. Amikor ez a hívás visszatér, az eseményeket elfogadták a pufferbe, de lehet, hogy még nem tették közzé. A közzététel nem meghatározott időpontban történik a jövőben, mivel a puffer feldolgozása folyamatban van.
flush(BufferedFlushOptions)	Megpróbálja azonnal közzétenni a pufferben lévő összes eseményt. Ez több köteg közzétételét eredményezheti, amelyek eredményét a és onSendEventsErrorHandler a onSendEventsSuccessHandler kezelők egyenként jelentik.
getEventHubProperties(GetEventHubPropertiesOptions)	Megadja az Event Hub futtatókörnyezetének adatait.
getPartitionIds(GetPartitionIdsOptions)	Megadja az Eseményközponthoz társított partíciók azonosítóját.
getPartitionProperties(string, GetPartitionPropertiesOptions)	Információt nyújt a megadott partíció állapotáról.

Konstruktor adatai

EventHubBufferedProducerClient(string, EventHubBufferedProducerClientOptions)

Az EventHubBufferedProducerClient osztály eseményközpontba küldi az eseményeket. options A parmeter használatával konfigurálhatja az újrapróbálkozési szabályzatot vagy a proxybeállításokat.

new EventHubBufferedProducerClient(connectionString: string, options: EventHubBufferedProducerClientOptions)

Paraméterek

connectionString

string

A kapcsolati sztring az Event Hub-példányhoz való csatlakozáshoz. A megosztott kulcs tulajdonságai és az Event Hub elérési útja várhatóan ebben a kapcsolati sztring található. pl. "Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key; EntityPath=my-event-hub-name".

options

EventHubBufferedProducerClientOptions

Az ügyfél konfigurálásakor alkalmazandó beállítások halmaza.

• retryOptions : Konfigurálja az újrapróbálkozási szabályzatot az ügyfél összes műveletéhez. Például { "maxRetries": 4 } vagy { "maxRetries": 4, "retryDelayInMs": 30000 }.
• webSocketOptions: Konfigurálja az AMQP-kapcsolat webes szoftvercsatornákon keresztüli csatornázását.
• userAgent : A szolgáltatásnak átadott beépített felhasználóiügynök-sztringhez hozzáfűzni kívánt sztring.

EventHubBufferedProducerClient(string, string, EventHubBufferedProducerClientOptions)

Az EventHubBufferedProducerClient osztály eseményközpontba küldi az eseményeket. options A parmeter használatával konfigurálhatja az újrapróbálkozési szabályzatot vagy a proxybeállításokat.

new EventHubBufferedProducerClient(connectionString: string, eventHubName: string, options: EventHubBufferedProducerClientOptions)

Paraméterek

connectionString

string

A kapcsolati sztring az Event Hubs-névtérhez való csatlakozáshoz. A megosztott kulcs tulajdonságai várhatóan ebben a kapcsolati sztring találhatók, az Event Hub elérési útjának azonban nem, például "Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key;'.

eventHubName

string

Annak az eseményközpontnak a neve, amelyhez az ügyfelet csatlakoztatni szeretné.

options

EventHubBufferedProducerClientOptions

Az ügyfél konfigurálásakor alkalmazandó beállítások halmaza.

• retryOptions : Konfigurálja az újrapróbálkozási szabályzatot az ügyfél összes műveletéhez. Például { "maxRetries": 4 } vagy { "maxRetries": 4, "retryDelayInMs": 30000 }.
• webSocketOptions: Konfigurálja az AMQP-kapcsolat webes szoftvercsatornákon keresztüli csatornázását.
• userAgent : A szolgáltatásnak átadott beépített felhasználóiügynök-sztringhez hozzáfűzni kívánt sztring.

EventHubBufferedProducerClient(string, string, TokenCredential | NamedKeyCredential | SASCredential, EventHubBufferedProducerClientOptions)

Az EventHubBufferedProducerClient osztály eseményközpontba küldi az eseményeket. options A parmeter használatával konfigurálhatja az újrapróbálkozési szabályzatot vagy a proxybeállításokat.

new EventHubBufferedProducerClient(fullyQualifiedNamespace: string, eventHubName: string, credential: TokenCredential | NamedKeyCredential | SASCredential, options: EventHubBufferedProducerClientOptions)

Paraméterek

fullyQualifiedNamespace

string

A teljes névtér, amely valószínűleg hasonló a .servicebus.windows.net

eventHubName

string

Annak az eseményközpontnak a neve, amelyhez az ügyfelet csatlakoztatni szeretné.

credential

TokenCredential | NamedKeyCredential | SASCredential

Egy hitelesítőadat-objektum, amelyet az ügyfél használ a jogkivonat lekéréséhez a Azure Event Hubs szolgáltatással való kapcsolat hitelesítéséhez. Az AAD-hitelesítést támogató hitelesítő adatok létrehozásáról a @azure/identitás című témakörben olvashat. Használja a AzureNamedKeyCredential from @azure/core-auth parancsot, ha kapcsolati sztring használata nélkül szeretne megadni egy SharedAccessKeyName és SharedAccessKey értéket. Ezek a mezők a és key a name mezőre vannak képezve a mezőbenAzureNamedKeyCredential. Használja a AzureSASCredential from @azure/core-auth parancsot, ha kapcsolati sztring használata nélkül szeretne megadni egy SharedAccessSignature értéket. Ez a mező a következőre lesz leképzve: signatureAzureSASCredential.

options

EventHubBufferedProducerClientOptions

Az ügyfél konfigurálásakor alkalmazandó beállítások halmaza.

• retryOptions : Konfigurálja az újrapróbálkozási szabályzatot az ügyfél összes műveletéhez. Például { "maxRetries": 4 } vagy { "maxRetries": 4, "retryDelayInMs": 30000 }.
• webSocketOptions: Konfigurálja az AMQP-kapcsolat webes szoftvercsatornákon keresztüli csatornázását.
• userAgent : A szolgáltatásnak átadott beépített felhasználóiügynök-sztringhez hozzáfűzni kívánt sztring.

Tulajdonság adatai

eventHubName

Annak az Event Hub-példánynak a neve, amelyhez az ügyfél létrejön.

string eventHubName

Tulajdonság értéke

string

fullyQualifiedNamespace

Annak az Event Hub-példánynak a teljes névtere, amelyhez az ügyfél létrejön. Ez valószínűleg hasonló lesz a .servicebus.windows.net-hoz.

string fullyQualifiedNamespace

Tulajdonság értéke

string

identifier

Az EventHubBufferedProducerClient azonosításához használt név. Ha nincs megadva vagy üres, a rendszer létrehoz egy véletlenszerű egyedit.

identifier: string

Tulajdonság értéke

string

Metódus adatai

close(BufferedCloseOptions)

Bezárja az AMQP-kapcsolatot az Event Hub-példányhoz, és visszaad egy ígéretet, amely a leválasztás befejezésekor megoldódik.

Ez megvárja, amíg az enqueued események ki lesznek ürítve a szolgáltatásba a kapcsolat bezárása előtt. Ha kiürítés nélkül szeretne bezárni, állítsa a beállítást a flush következőre: false.

function close(options?: BufferedCloseOptions): Promise<void>

Paraméterek

options

BufferedCloseOptions

A műveleti hívásra alkalmazandó beállítások halmaza.

Válaszok

Promise<void>

Ígéret

enqueueEvent(EventData | AmqpAnnotatedMessage, EnqueueEventOptions)

Egy eseményt a pufferbe helyez, amelyet közzé szeretne tenni az Event Hubon. Ha a metódus meghívásakor nincs kapacitás a pufferben, megvárja, amíg a hely elérhetővé válik, és meggyőződik arról, hogy az esemény le van foglalva.

Amikor ez a hívás visszatér, az esemény bekerült a pufferbe, de lehet, hogy még nem lett közzétéve. A közzététel nem meghatározott időpontban történik a jövőben, mivel a puffer feldolgozása folyamatban van.

function enqueueEvent(event: EventData | AmqpAnnotatedMessage, options?: EnqueueEventOptions): Promise<number>

Paraméterek

event

EventData | AmqpAnnotatedMessage

options

EnqueueEventOptions

Az eseménynek a társított eseményközpontba való elküldésének módjának befolyásolására megadható beállítások készlete.

• abortSignal : Az enqueueEvent művelet megszakításához használt jel.
• partitionId : Az eseménykészletet a rendszer elküldi a partíciónak. Ha be van állítva, partitionKey nem állítható be.
• partitionKey : A partíció-hozzárendelés létrehozásához kivonatolt érték. Ha be van állítva, partitionId nem állítható be.

Válaszok

Promise<number>

A jelenleg pufferelt és közzétételre váró események teljes száma az összes partíción.

enqueueEvents(EventData[] | AmqpAnnotatedMessage[], EnqueueEventOptions)

Az eseményeket az eseményközpontban közzéteendő pufferbe alakítja. Ha a metódus meghívásakor nincs kapacitás a pufferben, megvárja, amíg a hely elérhetővé válik, és meggyőződik arról, hogy az események le vannak foglalva.

Amikor ez a hívás visszatér, az eseményeket elfogadták a pufferbe, de lehet, hogy még nem tették közzé. A közzététel nem meghatározott időpontban történik a jövőben, mivel a puffer feldolgozása folyamatban van.

function enqueueEvents(events: EventData[] | AmqpAnnotatedMessage[], options?: EnqueueEventOptions): Promise<number>

Paraméterek

events

EventData[] | AmqpAnnotatedMessage[]

EventData vagy AmqpAnnotatedMessage.

options

EnqueueEventOptions

Az eseményeknek a társított eseményközpontba való elküldésének módjának befolyásolására megadható lehetőségek készlete.

• abortSignal : Az enqueueEvents művelet megszakításához használt jel.
• partitionId : Az eseménykészletet a rendszer elküldi a partíciónak. Ha be van állítva, partitionKey nem állítható be.
• partitionKey : A partíció-hozzárendelés létrehozásához kivonatolt érték. Ha be van állítva, partitionId nem állítható be.

Válaszok

Promise<number>

A jelenleg pufferelt és közzétételre váró események teljes száma az összes partíción.

flush(BufferedFlushOptions)

Megpróbálja azonnal közzétenni a pufferben lévő összes eseményt. Ez több köteg közzétételét eredményezheti, amelyek eredményét a és onSendEventsErrorHandler a onSendEventsSuccessHandler kezelők egyenként jelentik.

function flush(options?: BufferedFlushOptions): Promise<void>

Paraméterek

options

BufferedFlushOptions

A műveleti hívásra alkalmazandó beállítások halmaza.

Válaszok

Promise<void>

getEventHubProperties(GetEventHubPropertiesOptions)

Megadja az Event Hub futtatókörnyezetének adatait.

function getEventHubProperties(options?: GetEventHubPropertiesOptions): Promise<EventHubProperties>

Paraméterek

options

GetEventHubPropertiesOptions

A műveleti hívásra alkalmazandó beállítások halmaza.

Válaszok

Promise<EventHubProperties>

Egy ígéret, amely az Event Hub-példányra vonatkozó információkkal oldható fel.

getPartitionIds(GetPartitionIdsOptions)

Megadja az Eseményközponthoz társított partíciók azonosítóját.

function getPartitionIds(options?: GetPartitionIdsOptions): Promise<string[]>

Paraméterek

options

GetPartitionIdsOptions

A műveleti hívásra alkalmazandó beállítások halmaza.

Válaszok

Promise<string[]>

Egy ígéret, amely az Event Hubhoz társított egyes partíciók azonosítóját képviselő sztringek tömbjével oldható fel.

getPartitionProperties(string, GetPartitionPropertiesOptions)

Információt nyújt a megadott partíció állapotáról.

function getPartitionProperties(partitionId: string, options?: GetPartitionPropertiesOptions): Promise<PartitionProperties>

Paraméterek

partitionId

string

Annak a partíciónak az azonosítója, amelyhez információ szükséges.

options

GetPartitionPropertiesOptions

A műveleti hívásra alkalmazandó beállítások halmaza.

Válaszok

Promise<PartitionProperties>

Egy ígéret, amely a partíció állapotával kapcsolatos információkkal oldható fel.