-
Notifications
You must be signed in to change notification settings - Fork 180
/
Checkpoint.yml
103 lines (95 loc) · 2.83 KB
/
Checkpoint.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
### YamlMime:TSType
name: Checkpoint
uid: '@azure/event-hubs.Checkpoint'
package: '@azure/event-hubs'
summary: >-
A checkpoint is meant to represent the last successfully processed event by
the user from a particular
partition of a consumer group in an Event Hub instance.
When the `updateCheckpoint()` method on the `PartitionProcessor` class is
called by the user, a
`Checkpoint` is created internally. It is then stored in the storage solution
implemented by the
`CheckpointManager` chosen by the user when creating an `EventProcessor`.
Users are never expected to interact with `Checkpoint` directly. This
interface exists to support the
internal workings of `EventProcessor` and `CheckpointManager`.
fullName: Checkpoint
remarks: ''
isDeprecated: false
type: interface
properties:
- name: consumerGroup
uid: '@azure/event-hubs.Checkpoint.consumerGroup'
package: '@azure/event-hubs'
summary: The consumer group name
fullName: consumerGroup
remarks: ''
isDeprecated: false
syntax:
content: 'consumerGroup: string'
return:
description: ''
type: string
- name: eventHubName
uid: '@azure/event-hubs.Checkpoint.eventHubName'
package: '@azure/event-hubs'
summary: The event hub name
fullName: eventHubName
remarks: ''
isDeprecated: false
syntax:
content: 'eventHubName: string'
return:
description: ''
type: string
- name: fullyQualifiedNamespace
uid: '@azure/event-hubs.Checkpoint.fullyQualifiedNamespace'
package: '@azure/event-hubs'
summary: |-
The fully qualified Event Hubs namespace. This is likely to be similar to
<yournamespace>.servicebus.windows.net
fullName: fullyQualifiedNamespace
remarks: ''
isDeprecated: false
syntax:
content: 'fullyQualifiedNamespace: string'
return:
description: ''
type: string
- name: offset
uid: '@azure/event-hubs.Checkpoint.offset'
package: '@azure/event-hubs'
summary: The offset of the event.
fullName: offset
remarks: ''
isDeprecated: false
syntax:
content: 'offset: number'
return:
description: ''
type: number
- name: partitionId
uid: '@azure/event-hubs.Checkpoint.partitionId'
package: '@azure/event-hubs'
summary: The identifier of the Event Hub partition
fullName: partitionId
remarks: ''
isDeprecated: false
syntax:
content: 'partitionId: string'
return:
description: ''
type: string
- name: sequenceNumber
uid: '@azure/event-hubs.Checkpoint.sequenceNumber'
package: '@azure/event-hubs'
summary: The sequence number of the event
fullName: sequenceNumber
remarks: ''
isDeprecated: false
syntax:
content: 'sequenceNumber: number'
return:
description: ''
type: number