EventHubBufferedProducerClientOptions interface
の作成時に指定できるオプションについて説明します EventHubBufferedProducerClient
。
- Extends
プロパティ
enable |
EventHubProducerClient が Event Hub パーティションへのべき等発行を有効にする必要があるかどうかを示します。 有効にすると、プロデューサーはパーティションにのみ直接発行できます。自動パーティション ルーティングのために Event Hubs ゲートウェイに発行することも、パーティション キーを使用することもできません。 既定値: false |
max |
特定のパーティションに対して特定の時刻に発行するためにバッファーに格納できるイベントの合計数。 既定値: 1500 |
max |
部分的に完全なバッチを発行する前に、バッファーに新しいイベントがエンキューされるまでの時間。 既定値: 1 秒。 |
on |
バッチが発行に失敗したときに呼び出すハンドラー。 |
on |
バッチが正常に発行されたら呼び出すハンドラー。 |
継承されたプロパティ
custom |
Event Hubs サービスに接続するときに使用するカスタム エンドポイント。 これは、ネットワークが標準のAzure Event Hubs エンドポイント アドレスへの接続は許可していないけれど、中継局経由での接続を許可している場合に便利です。 例: "https://my.custom.endpoint:100/" |
identifier | クライアントを識別するために使用される一意の名前。 指定しない場合は、識別子として GUID が使用されます |
retry |
クライアント上のすべての操作の再試行ポリシーを構成するためのオプション。
たとえば、 |
user |
Event Hubs サービスに渡される組み込みのユーザー エージェント文字列に追加される値。 |
web |
Web ソケット経由の AMQP 接続のチャネリングを構成するオプション。 |
プロパティの詳細
enableIdempotentRetries
EventHubProducerClient が Event Hub パーティションへのべき等発行を有効にする必要があるかどうかを示します。 有効にすると、プロデューサーはパーティションにのみ直接発行できます。自動パーティション ルーティングのために 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
identifier
クライアントを識別するために使用される一意の名前。 指定しない場合は、識別子として GUID が使用されます
identifier?: string
プロパティ値
string
retryOptions
クライアント上のすべての操作の再試行ポリシーを構成するためのオプション。
たとえば、{ "maxRetries": 4 }
または { "maxRetries": 4, "retryDelayInMs": 30000 }
です。
retryOptions?: RetryOptions
プロパティ値
userAgent
Event Hubs サービスに渡される組み込みのユーザー エージェント文字列に追加される値。
userAgent?: string
プロパティ値
string
webSocketOptions
Web ソケット経由の AMQP 接続のチャネリングを構成するオプション。
webSocketOptions?: WebSocketOptions