CheckpointStore interface
검사점 저장소는 이벤트 허브 인스턴스의 지정된 소비자 그룹에 있는 각 파티션에 대한 파티션 소유권 정보 및 검사점 세부 정보를 저장하고 검색합니다.
사용자는 를 구현 CheckpointStore하지 않습니다.
사용자는 이 인터페이스의 기존 구현을 선택하고 인스턴스화한 다음 클라이언트를 인스턴스화할 때 클래스 생성자에 전달해야 EventHubConsumerClient 합니다.
사용자는 검사점 저장소에서 메서드를 사용할 것으로 예상되지 않습니다. 이러한 메서드는 클라이언트에서 내부적으로 사용됩니다.
의 구현은 CheckpointStore 접두사 @azure/eventhub-checkpointstore-를 사용하여 패키지를 검색하여 npm에서 찾을 수 있습니다.
메서드
| claim |
파티션 목록의 소유권을 클레임하기 위해 호출됩니다. 그러면 성공적으로 소유된 파티션 목록이 반환됩니다. |
| list |
지정된 네임스페이스, eventhub 및 소비자 그룹에 대한 데이터 저장소의 모든 검사점을 나열합니다. |
| list |
기본 데이터 저장소에서 모든 기존 파티션 소유권 목록을 가져오기 위해 호출됩니다. 기존 소유권 정보가 없는 경우 빈 결과를 반환할 수 있습니다. |
| update |
파티션에 대한 데이터 저장소의 검사점을 업데이트. |
메서드 세부 정보
claimOwnership(PartitionOwnership[], OperationOptions)
파티션 목록의 소유권을 클레임하기 위해 호출됩니다. 그러면 성공적으로 소유된 파티션 목록이 반환됩니다.
function claimOwnership(partitionOwnership: PartitionOwnership[], options?: OperationOptions): Promise<PartitionOwnership[]>매개 변수
- partitionOwnership
이 인스턴스가 소유하고 있다고 주장하는 파티션 소유권 목록입니다.
- options
- OperationOptions
이 메서드의 동작에 영향을 주도록 지정할 수 있는 옵션 집합입니다.
-
abortSignal: 작업 취소를 요청하는 데 사용되는 신호입니다. -
tracingOptions: 추적을 구성하는 옵션입니다.
반환
Promise<PartitionOwnership[]>
이 인스턴스가 소유권을 성공적으로 클레임한 파티션 목록입니다.
listCheckpoints(string, string, string, OperationOptions)
지정된 네임스페이스, eventhub 및 소비자 그룹에 대한 데이터 저장소의 모든 검사점을 나열합니다.
function listCheckpoints(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<Checkpoint[]>매개 변수
- fullyQualifiedNamespace
-
string
정규화된 Event Hubs 네임스페이스입니다. 이는 .servicebus.windows.net 유사할 수 있습니다.
- eventHubName
-
string
이벤트 허브 이름입니다.
- consumerGroup
-
string
소비자 그룹 이름입니다.
- options
- OperationOptions
이 메서드의 동작에 영향을 주도록 지정할 수 있는 옵션 집합입니다.
-
abortSignal: 작업 취소를 요청하는 데 사용되는 신호입니다. -
tracingOptions: 추적을 구성하는 옵션입니다.
반환
Promise<Checkpoint[]>
지정된 네임스페이스, eventhub 및 소비자 그룹에 대한 검사점 목록입니다.
listOwnership(string, string, string, OperationOptions)
기본 데이터 저장소에서 모든 기존 파티션 소유권 목록을 가져오기 위해 호출됩니다. 기존 소유권 정보가 없는 경우 빈 결과를 반환할 수 있습니다.
function listOwnership(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<PartitionOwnership[]>매개 변수
- fullyQualifiedNamespace
-
string
정규화된 Event Hubs 네임스페이스입니다. 이는 .servicebus.windows.net 유사할 수 있습니다.
- eventHubName
-
string
이벤트 허브 이름입니다.
- consumerGroup
-
string
소비자 그룹 이름입니다.
- options
- OperationOptions
이 메서드의 동작에 영향을 주도록 지정할 수 있는 옵션 집합입니다.
-
abortSignal: 작업 취소를 요청하는 데 사용되는 신호입니다. -
tracingOptions: 추적을 구성하는 옵션입니다.
반환
Promise<PartitionOwnership[]>
소유자가 있고 있는 모든 파티션의 파티션 소유권 세부 정보 목록입니다.
updateCheckpoint(Checkpoint, OperationOptions)
파티션에 대한 데이터 저장소의 검사점을 업데이트.
function updateCheckpoint(checkpoint: Checkpoint, options?: OperationOptions): Promise<void>매개 변수
- checkpoint
- Checkpoint
검사점입니다.
- options
- OperationOptions
이 메서드의 동작에 영향을 주도록 지정할 수 있는 옵션 집합입니다.
-
abortSignal: 작업 취소를 요청하는 데 사용되는 신호입니다. -
tracingOptions: 추적을 구성하는 옵션입니다.
반환
Promise<void>