-
Notifications
You must be signed in to change notification settings - Fork 258
/
ChangeFeedProcessorState.xml
122 lines (122 loc) · 6.91 KB
/
ChangeFeedProcessorState.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
<Type Name="ChangeFeedProcessorState" FullName="Microsoft.Azure.Cosmos.ChangeFeedProcessorState">
<TypeSignature Language="C#" Value="public sealed class ChangeFeedProcessorState" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit ChangeFeedProcessorState extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Cosmos.ChangeFeedProcessorState" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class ChangeFeedProcessorState" />
<TypeSignature Language="F#" Value="type ChangeFeedProcessorState = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.36.0.0</AssemblyVersion>
<AssemblyVersion>3.38.1.0</AssemblyVersion>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Change Feed processor state for a particular range of partition keys.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ChangeFeedProcessorState (string leaseToken, long estimatedLag, string instanceName);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string leaseToken, int64 estimatedLag, string instanceName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.ChangeFeedProcessorState.#ctor(System.String,System.Int64,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (leaseToken As String, estimatedLag As Long, instanceName As String)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Cosmos.ChangeFeedProcessorState : string * int64 * string -> Microsoft.Azure.Cosmos.ChangeFeedProcessorState" Usage="new Microsoft.Azure.Cosmos.ChangeFeedProcessorState (leaseToken, estimatedLag, instanceName)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="leaseToken" Type="System.String" />
<Parameter Name="estimatedLag" Type="System.Int64" />
<Parameter Name="instanceName" Type="System.String" />
</Parameters>
<Docs>
<param name="leaseToken">The lease token that identifies this lease.</param>
<param name="estimatedLag">The amount of documents remaining to be processed</param>
<param name="instanceName">The instance currently owning the lease.</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Azure.Cosmos.ChangeFeedProcessorState" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EstimatedLag">
<MemberSignature Language="C#" Value="public long EstimatedLag { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 EstimatedLag" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.ChangeFeedProcessorState.EstimatedLag" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property EstimatedLag As Long" />
<MemberSignature Language="F#" Value="member this.EstimatedLag : int64" Usage="Microsoft.Azure.Cosmos.ChangeFeedProcessorState.EstimatedLag" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets an approximation of the difference between the last processed transaction in the feed container and the latest transaction recorded.
</summary>
<value>To be added.</value>
<remarks>
The estimation over the Change Feed identifies volumes of transactions. If operations in the container are performed through stored procedures, transactional batch or bulk, a group of operations may share the same <see href="https://docs.microsoft.com/azure/cosmos-db/stored-procedures-triggers-udfs#transactions">transaction scope</see> and represented by a single transaction.
In those cases, the estimation might not exactly represent number of items, but it is still valid to understand if the pending volume is increasing, decreasing, or on a steady state.
</remarks>
</Docs>
</Member>
<Member MemberName="InstanceName">
<MemberSignature Language="C#" Value="public string InstanceName { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string InstanceName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.ChangeFeedProcessorState.InstanceName" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property InstanceName As String" />
<MemberSignature Language="F#" Value="member this.InstanceName : string" Usage="Microsoft.Azure.Cosmos.ChangeFeedProcessorState.InstanceName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the name of the instance currently owning the lease.
</summary>
<value>To be added.</value>
<remarks>
Leases can be in a released state and not being owned by any instance on a particular moment in time, in which case, this value is null.
</remarks>
</Docs>
</Member>
<Member MemberName="LeaseToken">
<MemberSignature Language="C#" Value="public string LeaseToken { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string LeaseToken" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.ChangeFeedProcessorState.LeaseToken" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property LeaseToken As String" />
<MemberSignature Language="F#" Value="member this.LeaseToken : string" Usage="Microsoft.Azure.Cosmos.ChangeFeedProcessorState.LeaseToken" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the lease token for which the state is calculated
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>