EventHubBufferedProducerClientOptions interface

パッケージ:
@azure/event-hubs

EventHubBufferedProducerClientの作成時に指定できるオプションについて説明します。

Extends
EventHubClientOptions

プロパティ

enableIdempotentRetries

EventHubProducerClient でイベント ハブ パーティションへのべき等発行を有効にする必要があるかどうかを示します。 有効にすると、プロデューサーはパーティションに直接パブリッシュすることしかできません。自動パーティション ルーティングのために Event Hubs ゲートウェイに発行したり、パーティション キーを使用したりすることはできません。 既定値: false
maxEventBufferLengthPerPartition

特定のパーティションの特定の時間に発行するためにバッファリングできるイベントの合計数。

デフォルト: 1500
maxWaitTimeInMs

部分的に完全なバッチを発行する前に、新しいイベントがバッファーにキューに入れられるのを待機する時間。

デフォルト: 1 秒。
onSendEventsErrorHandler

バッチの発行に失敗したときに呼び出すハンドラー。
onSendEventsSuccessHandler

バッチが正常に発行された後に呼び出すハンドラー。

継承されたプロパティ

customEndpointAddress

Event Hubs サービスに接続するときに使用するカスタム エンドポイント。 これは、ネットワークが標準の Azure Event Hubs エンドポイント アドレスへの接続を許可せず、中継局経由での接続を許可している場合に役立ちます。

例: "https://my.custom.endpoint:100/"
identifier

クライアントを識別するために使用される一意の名前。 指定しない場合、GUID が識別子として使用されます
retryOptions

クライアント上のすべての操作の再試行ポリシーを構成するオプション。 たとえば、{ "maxRetries": 4 } または { "maxRetries": 4, "retryDelayInMs": 30000 } です。
userAgent

Event Hubs サービスに渡される組み込みのユーザー エージェント文字列に追加される値。
webSocketOptions

Web ソケット経由の AMQP 接続のチャネリングを構成するオプション。

プロパティの詳細

enableIdempotentRetries

EventHubProducerClient でイベント ハブ パーティションへのべき等発行を有効にする必要があるかどうかを示します。 有効にすると、プロデューサーはパーティションに直接パブリッシュすることしかできません。自動パーティション ルーティングのために Event Hubs ゲートウェイに発行したり、パーティション キーを使用したりすることはできません。 既定値: false

enableIdempotentRetries?: boolean

プロパティ値

boolean

maxEventBufferLengthPerPartition

特定のパーティションの特定の時間に発行するためにバッファリングできるイベントの合計数。

デフォルト: 1500

maxEventBufferLengthPerPartition?: number

プロパティ値

number

maxWaitTimeInMs

部分的に完全なバッチを発行する前に、新しいイベントがバッファーにキューに入れられるのを待機する時間。

デフォルト: 1 秒。

maxWaitTimeInMs?: number

プロパティ値

number

onSendEventsErrorHandler

バッチの発行に失敗したときに呼び出すハンドラー。

onSendEventsErrorHandler: (ctx: OnSendEventsErrorContext) => void

プロパティ値

(ctx: OnSendEventsErrorContext) => void

onSendEventsSuccessHandler

バッチが正常に発行された後に呼び出すハンドラー。

onSendEventsSuccessHandler?: (ctx: OnSendEventsSuccessContext) => void

プロパティ値

(ctx: OnSendEventsSuccessContext) => void

継承されたプロパティの詳細

customEndpointAddress

Event Hubs サービスに接続するときに使用するカスタム エンドポイント。 これは、ネットワークが標準の Azure Event Hubs エンドポイント アドレスへの接続を許可せず、中継局経由での接続を許可している場合に役立ちます。

例: "https://my.custom.endpoint:100/"

customEndpointAddress?: string

プロパティ値

string

継承元EventHubClientOptions.customEndpointAddress

identifier

クライアントを識別するために使用される一意の名前。 指定しない場合、GUID が識別子として使用されます

identifier?: string

プロパティ値

string

EventHubClientOptions.identifierから継承

retryOptions

クライアント上のすべての操作の再試行ポリシーを構成するオプション。 たとえば、{ "maxRetries": 4 } または { "maxRetries": 4, "retryDelayInMs": 30000 } です。

retryOptions?: RetryOptions

プロパティ値

RetryOptions

EventHubClientOptions.retryOptionsから継承

userAgent

Event Hubs サービスに渡される組み込みのユーザー エージェント文字列に追加される値。

userAgent?: string

プロパティ値

string

継承元EventHubClientOptions.userAgent

webSocketOptions

Web ソケット経由の AMQP 接続のチャネリングを構成するオプション。

webSocketOptions?: WebSocketOptions

プロパティ値

WebSocketOptions

EventHubClientOptions.webSocketOptionsから継承