-
Notifications
You must be signed in to change notification settings - Fork 180
/
BlobCheckpointStore.yml
127 lines (122 loc) · 4.75 KB
/
BlobCheckpointStore.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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
### YamlMime:TSType
name: BlobCheckpointStore
uid: '@azure/eventhubs-checkpointstore-blob.BlobCheckpointStore'
package: '@azure/eventhubs-checkpointstore-blob'
summary: >-
An implementation of CheckpointStore that uses Azure Blob Storage to persist
checkpoint data.
fullName: BlobCheckpointStore
remarks: ''
isDeprecated: false
type: class
constructors:
- name: BlobCheckpointStore(ContainerClient)
uid: '@azure/eventhubs-checkpointstore-blob.BlobCheckpointStore.constructor'
package: '@azure/eventhubs-checkpointstore-blob'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: 'new BlobCheckpointStore(containerClient: ContainerClient)'
parameters:
- id: containerClient
type: <xref uid="@azure/storage-blob.ContainerClient" />
description: ''
methods:
- name: claimOwnership(PartitionOwnership[])
uid: '@azure/eventhubs-checkpointstore-blob.BlobCheckpointStore.claimOwnership'
package: '@azure/eventhubs-checkpointstore-blob'
summary: >-
Claim ownership of a list of partitions. This will return the list of
partitions that were
successfully claimed.
remarks: ''
isDeprecated: false
syntax:
content: >-
function claimOwnership(partitionOwnership: PartitionOwnership[]):
Promise<PartitionOwnership[]>
parameters:
- id: partitionOwnership
type: <xref uid="@azure/event-hubs.PartitionOwnership" />[]
description: The list of partition ownership this instance is claiming to own.
return:
description: A list partitions this instance successfully claimed ownership.
type: Promise<<xref uid="@azure/event-hubs.PartitionOwnership" />[]>
- name: listCheckpoints(string, string, string)
uid: '@azure/eventhubs-checkpointstore-blob.BlobCheckpointStore.listCheckpoints'
package: '@azure/eventhubs-checkpointstore-blob'
summary: >-
Lists all the checkpoints in a data store for a given namespace, eventhub
and consumer group.
remarks: ''
isDeprecated: false
syntax:
content: >-
function listCheckpoints(fullyQualifiedNamespace: string, eventHubName:
string, consumerGroup: string): Promise<Checkpoint[]>
parameters:
- id: fullyQualifiedNamespace
type: string
description: >-
The fully qualified Event Hubs namespace. This is likely to be
similar to
<yournamespace>.servicebus.windows.net.
- id: eventHubName
type: string
description: The event hub name.
- id: consumerGroup
type: string
description: The consumer group name.
return:
description: ''
type: Promise<<xref uid="@azure/event-hubs.Checkpoint" />[]>
- name: listOwnership(string, string, string)
uid: '@azure/eventhubs-checkpointstore-blob.BlobCheckpointStore.listOwnership'
package: '@azure/eventhubs-checkpointstore-blob'
summary: >-
Get the list of all existing partition ownership from the underlying data
store. May return empty
results if there are is no existing ownership information.
Partition Ownership contains the information on which
`EventHubConsumerClient` subscribe call is currently processing the
partition.
remarks: ''
isDeprecated: false
syntax:
content: >-
function listOwnership(fullyQualifiedNamespace: string, eventHubName:
string, consumerGroup: string): Promise<PartitionOwnership[]>
parameters:
- id: fullyQualifiedNamespace
type: string
description: >-
The fully qualified Event Hubs namespace. This is likely to be
similar to
<yournamespace>.servicebus.windows.net.
- id: eventHubName
type: string
description: The event hub name.
- id: consumerGroup
type: string
description: The consumer group name.
return:
description: >-
Partition ownership details of all the partitions that have had an
owner.
type: Promise<<xref uid="@azure/event-hubs.PartitionOwnership" />[]>
- name: updateCheckpoint(Checkpoint)
uid: '@azure/eventhubs-checkpointstore-blob.BlobCheckpointStore.updateCheckpoint'
package: '@azure/eventhubs-checkpointstore-blob'
summary: Updates the checkpoint in the data store for a partition.
remarks: ''
isDeprecated: false
syntax:
content: 'function updateCheckpoint(checkpoint: Checkpoint): Promise<void>'
parameters:
- id: checkpoint
type: <xref uid="@azure/event-hubs.Checkpoint" />
description: The checkpoint.
return:
description: The new etag on successful update.
type: Promise<void>