-
Notifications
You must be signed in to change notification settings - Fork 262
/
ILease.xml
182 lines (182 loc) · 10 KB
/
ILease.xml
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
<Type Name="ILease" FullName="Microsoft.Azure.Documents.ChangeFeedProcessor.PartitionManagement.ILease">
<TypeSignature Language="C#" Value="public interface ILease" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract ILease" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Documents.ChangeFeedProcessor.PartitionManagement.ILease" />
<TypeSignature Language="VB.NET" Value="Public Interface ILease" />
<TypeSignature Language="F#" Value="type ILease = interface" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.ChangeFeedProcessor</AssemblyName>
<AssemblyVersion>2.3.2.0</AssemblyVersion>
<AssemblyVersion>2.4.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<summary>
Represents a lease that is persisted as a document in the lease collection.
Leases are used to:
* Keep track of the <see cref="T:Microsoft.Azure.Documents.ChangeFeedProcessor.PartitionManagement.IChangeFeedProcessor" /> progress for a particular Partition Key Range.
* Distribute load between different instances of <see cref="T:Microsoft.Azure.Documents.ChangeFeedProcessor.PartitionManagement.IChangeFeedProcessor" />.
* Ensure reliable recovery for cases when an instance of <see cref="T:Microsoft.Azure.Documents.ChangeFeedProcessor.PartitionManagement.IChangeFeedProcessor" /> gets disconnected, hangs or crashes.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="ConcurrencyToken">
<MemberSignature Language="C#" Value="public string ConcurrencyToken { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ConcurrencyToken" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.ChangeFeedProcessor.PartitionManagement.ILease.ConcurrencyToken" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ConcurrencyToken As String" />
<MemberSignature Language="F#" Value="member this.ConcurrencyToken : string" Usage="Microsoft.Azure.Documents.ChangeFeedProcessor.PartitionManagement.ILease.ConcurrencyToken" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.ChangeFeedProcessor</AssemblyName>
<AssemblyVersion>2.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the Concurrency Token.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ContinuationToken">
<MemberSignature Language="C#" Value="public string ContinuationToken { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ContinuationToken" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.ChangeFeedProcessor.PartitionManagement.ILease.ContinuationToken" />
<MemberSignature Language="VB.NET" Value="Public Property ContinuationToken As String" />
<MemberSignature Language="F#" Value="member this.ContinuationToken : string with get, set" Usage="Microsoft.Azure.Documents.ChangeFeedProcessor.PartitionManagement.ILease.ContinuationToken" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.ChangeFeedProcessor</AssemblyName>
<AssemblyVersion>2.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the Continuation Token.
Continuation Token is used to determine the last processed point of the Change Feed.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Id">
<MemberSignature Language="C#" Value="public string Id { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Id" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.ChangeFeedProcessor.PartitionManagement.ILease.Id" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Id As String" />
<MemberSignature Language="F#" Value="member this.Id : string" Usage="Microsoft.Azure.Documents.ChangeFeedProcessor.PartitionManagement.ILease.Id" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.ChangeFeedProcessor</AssemblyName>
<AssemblyVersion>2.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the lease Id.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Owner">
<MemberSignature Language="C#" Value="public string Owner { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Owner" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.ChangeFeedProcessor.PartitionManagement.ILease.Owner" />
<MemberSignature Language="VB.NET" Value="Public Property Owner As String" />
<MemberSignature Language="F#" Value="member this.Owner : string with get, set" Usage="Microsoft.Azure.Documents.ChangeFeedProcessor.PartitionManagement.ILease.Owner" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.ChangeFeedProcessor</AssemblyName>
<AssemblyVersion>2.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the host name owner of the lease.
The Owner keeps track which <see cref="T:Microsoft.Azure.Documents.ChangeFeedProcessor.PartitionManagement.IChangeFeedProcessor" /> is currently processing that Partition Key Range.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PartitionId">
<MemberSignature Language="C#" Value="public string PartitionId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string PartitionId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.ChangeFeedProcessor.PartitionManagement.ILease.PartitionId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property PartitionId As String" />
<MemberSignature Language="F#" Value="member this.PartitionId : string" Usage="Microsoft.Azure.Documents.ChangeFeedProcessor.PartitionManagement.ILease.PartitionId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.ChangeFeedProcessor</AssemblyName>
<AssemblyVersion>2.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the partition associated with the lease.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Properties">
<MemberSignature Language="C#" Value="public System.Collections.Generic.Dictionary<string,string> Properties { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.Dictionary`2<string, string> Properties" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.ChangeFeedProcessor.PartitionManagement.ILease.Properties" />
<MemberSignature Language="VB.NET" Value="Public Property Properties As Dictionary(Of String, String)" />
<MemberSignature Language="F#" Value="member this.Properties : System.Collections.Generic.Dictionary<string, string> with get, set" Usage="Microsoft.Azure.Documents.ChangeFeedProcessor.PartitionManagement.ILease.Properties" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.ChangeFeedProcessor</AssemblyName>
<AssemblyVersion>2.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.Dictionary<System.String,System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets custom lease properties which can be managed from <see cref="T:Microsoft.Azure.Documents.ChangeFeedProcessor.PartitionManagement.IParitionLoadBalancingStrategy" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Timestamp">
<MemberSignature Language="C#" Value="public DateTime Timestamp { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime Timestamp" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.ChangeFeedProcessor.PartitionManagement.ILease.Timestamp" />
<MemberSignature Language="VB.NET" Value="Public Property Timestamp As DateTime" />
<MemberSignature Language="F#" Value="member this.Timestamp : DateTime with get, set" Usage="Microsoft.Azure.Documents.ChangeFeedProcessor.PartitionManagement.ILease.Timestamp" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.ChangeFeedProcessor</AssemblyName>
<AssemblyVersion>2.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the Timestamp of the lease.
Timestamp is used to determine lease expiration.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>