ChangeFeedEstimator.GetCurrentStateIterator Method

Reference

Definition

Namespace:: Microsoft.Azure.Cosmos

Assembly:: Microsoft.Azure.Cosmos.Client.dll

Package:: Microsoft.Azure.Cosmos v3.39.0

Source:: ChangeFeedEstimator.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets the estimation per lease in the lease container.

public abstract Microsoft.Azure.Cosmos.FeedIterator<Microsoft.Azure.Cosmos.ChangeFeedProcessorState> GetCurrentStateIterator (Microsoft.Azure.Cosmos.ChangeFeedEstimatorRequestOptions changeFeedEstimatorRequestOptions = default);

abstract member GetCurrentStateIterator : Microsoft.Azure.Cosmos.ChangeFeedEstimatorRequestOptions -> Microsoft.Azure.Cosmos.FeedIterator<Microsoft.Azure.Cosmos.ChangeFeedProcessorState>

Public MustOverride Function GetCurrentStateIterator (Optional changeFeedEstimatorRequestOptions As ChangeFeedEstimatorRequestOptions = Nothing) As FeedIterator(Of ChangeFeedProcessorState)

Parameters

changeFeedEstimatorRequestOptions: ChangeFeedEstimatorRequestOptions

(Optional) Customize the estimation iterator.

Returns

FeedIterator<ChangeFeedProcessorState>

An iterator that yields an estimation of pending work in amount of transactions per distributed lease token.

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 transaction scope 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.

Applies to

Aracılığıyla paylaş