PartitionContext interface

パッケージ:

@azure/event-hubs

の一部 SubscriptionEventHandlersである各関数に渡されるコンテキストを記述するインターフェイス。 これらの関数のいずれかを実装する場合は、コンテキスト オブジェクトを使用して、パーティションに関する情報とチェックポイント機能を取得します。

プロパティ

consumerGroup	コンシューマー グループ名。
eventHubName	イベント ハブ名。
fullyQualifiedNamespace	完全修飾 Event Hubs の名前空間。 これは.servicebus.windows.net に似ている可能性があります
lastEnqueuedEventProperties	処理中のパーティションで最後にエンキューされたイベントに関する情報。 このプロパティは、EventProcessor のインスタンスを trackLastEnqueuedEventProperties 作成するときに オプションが true に設定されている場合にのみ更新されます。
partitionId	イベント ハブ パーティションの識別子。

メソッド

updateCheckpoint(ReceivedEventData)

イベント データを使用してチェックポイントを更新します。 チェックポイントは、Event Hub インスタンス内のコンシューマー グループの特定のパーティションからユーザーが最後に正常に処理したイベントを表します。

プロパティの詳細

consumerGroup

コンシューマー グループ名。

consumerGroup: string

プロパティ値

string

eventHubName

イベント ハブ名。

eventHubName: string

プロパティ値

string

fullyQualifiedNamespace

完全修飾 Event Hubs の名前空間。 これは.servicebus.windows.net に似ている可能性があります

fullyQualifiedNamespace: string

プロパティ値

string

lastEnqueuedEventProperties

処理中のパーティションで最後にエンキューされたイベントに関する情報。 このプロパティは、EventProcessor のインスタンスを trackLastEnqueuedEventProperties 作成するときに オプションが true に設定されている場合にのみ更新されます。

lastEnqueuedEventProperties?: LastEnqueuedEventProperties

プロパティ値

LastEnqueuedEventProperties

partitionId

イベント ハブ パーティションの識別子。

partitionId: string

プロパティ値

string

メソッドの詳細

updateCheckpoint(ReceivedEventData)

イベント データを使用してチェックポイントを更新します。

チェックポイントは、Event Hub インスタンス内のコンシューマー グループの特定のパーティションからユーザーが最後に正常に処理したイベントを表します。

function updateCheckpoint(eventData: ReceivedEventData): Promise<void>

パラメーター

eventData

ReceivedEventData

チェックポイントを更新するイベント。

戻り値

Promise<void>