PartitionContext interface
SubscriptionEventHandlersの一部である各関数に渡されるコンテキストを記述するインターフェイス。 これらの関数のいずれかを実装する場合は、コンテキスト オブジェクトを使用して、パーティションに関する情報とチェックポイント機能を取得します。
プロパティ
| consumer |
コンシューマー グループ名。 |
| event |
イベント ハブ名。 |
| fully |
完全修飾 Event Hubs 名前空間。 これは <yournamespace>.servicebus.windows.net に似ている可能性があります。 |
| last |
処理中のパーティション内の最後にエンキューされたイベントに関する情報。
このプロパティは、EventProcessor のインスタンスの作成時に |
| partition |
イベント ハブ パーティションの識別子。 |
メソッド
| update |
イベント データを使用してチェックポイントを更新します。 チェックポイントは、Event Hub インスタンス内のコンシューマー グループの特定のパーティションからユーザーが最後に正常に処理したイベントを表します。 |
プロパティの詳細
consumerGroup
コンシューマー グループ名。
consumerGroup: string
プロパティ値
string
eventHubName
イベント ハブ名。
eventHubName: string
プロパティ値
string
fullyQualifiedNamespace
完全修飾 Event Hubs 名前空間。 これは <yournamespace>.servicebus.windows.net に似ている可能性があります。
fullyQualifiedNamespace: string
プロパティ値
string
lastEnqueuedEventProperties
処理中のパーティション内の最後にエンキューされたイベントに関する情報。
このプロパティは、EventProcessor のインスタンスの作成時に trackLastEnqueuedEventProperties オプションが true に設定されている場合にのみ更新されます。
lastEnqueuedEventProperties?: LastEnqueuedEventProperties
プロパティ値
partitionId
イベント ハブ パーティションの識別子。
partitionId: string
プロパティ値
string
メソッドの詳細
updateCheckpoint(ReceivedEventData)
イベント データを使用してチェックポイントを更新します。
チェックポイントは、Event Hub インスタンス内のコンシューマー グループの特定のパーティションからユーザーが最後に正常に処理したイベントを表します。
function updateCheckpoint(eventData: ReceivedEventData): Promise<void>
パラメーター
- eventData
- ReceivedEventData
チェックポイントを更新するイベント。
戻り値
Promise<void>