SubscribeOptions interface

パッケージ:

@azure/event-hubs

で メソッドを subscribe 構成するための EventHubConsumerClientオプション。 たとえば、{ maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } } のように指定します。

プロパティ

maxBatchSize	バッチごとに要求するイベントの数
maxWaitTimeInSeconds	処理のためにデータをユーザー コードに渡す前に、要求されたメッセージ数の蓄積を待機する最大時間。 指定しない場合、既定値は 60 秒です。
ownerLevel	このサブスクリプションがパーティションをサブスクライブする場合に使用する所有者レベル。
prefetchCount	読み取りが要求されたかどうかに関係なく、一括で要求され、キューに登録されたイベントの数。
skipParsingBodyAsJson	メッセージを受信するときに、クライアントがメッセージ本文で JSON.parse() を実行できないようにするオプション。 メッセージが AMQP 本文の種類の値またはシーケンスと共に送信された場合は適用されません。 このオプションは、クライアントが解析を試みるよりも、メッセージ本文に存在するバイトを直接操作する場合に使用します。
startPosition	チェックポイントが見つからない場合のイベントの受信を開始するパーティション内のイベント位置。 パーティションごとに異なる開始位置を使用する場合は、パーティション ID のマップを position に渡します。
tracingOptions	トレースを構成するためのオプション。
trackLastEnqueuedEventProperties	コンシューマーが関連付けられたパーティションで最後にエンキューされたイベントに関する情報を要求し、イベントの受信時にその情報を追跡する必要があるかどうかを示します。 パーティションの最後のエンキュー イベントに関する情報が追跡されている場合、Event Hubs サービスから受信した各イベントは、それ以外の場合は行わないパーティションに関するメタデータを保持します。 これにより、Event Hub クライアントを使用してパーティション プロパティの要求を定期的に行うことを考慮すると、通常は有利なトレードオフとなる、追加のネットワーク帯域幅消費が少なくなります。

プロパティの詳細

maxBatchSize

バッチごとに要求するイベントの数

maxBatchSize?: number

プロパティ値

number

maxWaitTimeInSeconds

処理のためにデータをユーザー コードに渡す前に、要求されたメッセージ数の蓄積を待機する最大時間。 指定しない場合、既定値は 60 秒です。

maxWaitTimeInSeconds?: number

プロパティ値

number

ownerLevel

このサブスクリプションがパーティションをサブスクライブする場合に使用する所有者レベル。

ownerLevel?: number

プロパティ値

number

prefetchCount

読み取りが要求されたかどうかに関係なく、一括で要求され、キューに登録されたイベントの数。

prefetchCount?: number

プロパティ値

number

skipParsingBodyAsJson

メッセージを受信するときに、クライアントがメッセージ本文で JSON.parse() を実行できないようにするオプション。 メッセージが AMQP 本文の種類の値またはシーケンスと共に送信された場合は適用されません。 このオプションは、クライアントが解析を試みるよりも、メッセージ本文に存在するバイトを直接操作する場合に使用します。

skipParsingBodyAsJson?: boolean

プロパティ値

boolean

startPosition

チェックポイントが見つからない場合のイベントの受信を開始するパーティション内のイベント位置。 パーティションごとに異なる開始位置を使用する場合は、パーティション ID のマップを position に渡します。

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

プロパティ値

EventPosition | {[partitionId: string]: EventPosition}

tracingOptions

トレースを構成するためのオプション。

tracingOptions?: OperationTracingOptions

プロパティ値

OperationTracingOptions

trackLastEnqueuedEventProperties

コンシューマーが関連付けられたパーティションで最後にエンキューされたイベントに関する情報を要求し、イベントの受信時にその情報を追跡する必要があるかどうかを示します。

パーティションの最後のエンキュー イベントに関する情報が追跡されている場合、Event Hubs サービスから受信した各イベントは、それ以外の場合は行わないパーティションに関するメタデータを保持します。 これにより、Event Hub クライアントを使用してパーティション プロパティの要求を定期的に行うことを考慮すると、通常は有利なトレードオフとなる、追加のネットワーク帯域幅消費が少なくなります。

trackLastEnqueuedEventProperties?: boolean

プロパティ値

boolean