ChangeFeedEstimator.xml

<Type Name="ChangeFeedEstimator" FullName="Microsoft.Azure.Cosmos.ChangeFeedEstimator">
  <TypeSignature Language="C#" Value="public abstract class ChangeFeedEstimator" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit ChangeFeedEstimator extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Azure.Cosmos.ChangeFeedEstimator" />
  <TypeSignature Language="VB.NET" Value="Public MustInherit Class ChangeFeedEstimator" />
  <TypeSignature Language="F#" Value="type ChangeFeedEstimator = 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>
            Used to estimate the pending work remaining to be read by a <see cref="T:Microsoft.Azure.Cosmos.ChangeFeedProcessor" /> deployment.
            </summary>
    <remarks>
            The estimator is meant to monitor an existing deployment of <see cref="T:Microsoft.Azure.Cosmos.ChangeFeedProcessor" /> instances that are currently running.
            </remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected ChangeFeedEstimator ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.ChangeFeedEstimator.#ctor" />
      <MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
        <AssemblyVersion>3.39.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetCurrentStateIterator">
      <MemberSignature Language="C#" Value="public abstract Microsoft.Azure.Cosmos.FeedIterator&lt;Microsoft.Azure.Cosmos.ChangeFeedProcessorState&gt; GetCurrentStateIterator (Microsoft.Azure.Cosmos.ChangeFeedEstimatorRequestOptions changeFeedEstimatorRequestOptions = default);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Azure.Cosmos.FeedIterator`1&lt;class Microsoft.Azure.Cosmos.ChangeFeedProcessorState&gt; GetCurrentStateIterator(class Microsoft.Azure.Cosmos.ChangeFeedEstimatorRequestOptions changeFeedEstimatorRequestOptions) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.ChangeFeedEstimator.GetCurrentStateIterator(Microsoft.Azure.Cosmos.ChangeFeedEstimatorRequestOptions)" />
      <MemberSignature Language="VB.NET" Value="Public MustOverride Function GetCurrentStateIterator (Optional changeFeedEstimatorRequestOptions As ChangeFeedEstimatorRequestOptions = Nothing) As FeedIterator(Of ChangeFeedProcessorState)" />
      <MemberSignature Language="F#" Value="abstract member GetCurrentStateIterator : Microsoft.Azure.Cosmos.ChangeFeedEstimatorRequestOptions -&gt; Microsoft.Azure.Cosmos.FeedIterator&lt;Microsoft.Azure.Cosmos.ChangeFeedProcessorState&gt;" Usage="changeFeedEstimator.GetCurrentStateIterator changeFeedEstimatorRequestOptions" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
        <AssemblyVersion>3.39.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Azure.Cosmos.FeedIterator&lt;Microsoft.Azure.Cosmos.ChangeFeedProcessorState&gt;</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="changeFeedEstimatorRequestOptions" Type="Microsoft.Azure.Cosmos.ChangeFeedEstimatorRequestOptions" />
      </Parameters>
      <Docs>
        <param name="changeFeedEstimatorRequestOptions">(Optional) Customize the estimation iterator.</param>
        <summary>
            Gets the estimation per lease in the lease container.
            </summary>
        <returns>An iterator that yields an estimation of pending work in amount of transactions per distributed lease token.</returns>
        <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>
  </Members>
</Type>