Container.GetChangeFeedEstimatorBuilder Method

Reference

Definition

Namespace:: Microsoft.Azure.Cosmos

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

Package:: Microsoft.Azure.Cosmos v3.39.0

Source:: Container.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.

Initializes a ChangeFeedProcessorBuilder for change feed monitoring.

public abstract Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder GetChangeFeedEstimatorBuilder (string processorName, Microsoft.Azure.Cosmos.Container.ChangesEstimationHandler estimationDelegate, TimeSpan? estimationPeriod = default);

abstract member GetChangeFeedEstimatorBuilder : string * Microsoft.Azure.Cosmos.Container.ChangesEstimationHandler * Nullable<TimeSpan> -> Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder

Public MustOverride Function GetChangeFeedEstimatorBuilder (processorName As String, estimationDelegate As Container.ChangesEstimationHandler, Optional estimationPeriod As Nullable(Of TimeSpan) = Nothing) As ChangeFeedProcessorBuilder

Parameters

processorName: String

The name of the Processor the Estimator is going to measure.

estimationDelegate: Container.ChangesEstimationHandler

Delegate to receive estimation.

estimationPeriod: Nullable<TimeSpan>

Time interval on which to report the estimation. Default is 5 seconds.

Returns

ChangeFeedProcessorBuilder

An instance of ChangeFeedProcessorBuilder

Remarks

The goal of the Estimator is to measure progress of a particular processor. In order to do that, the processorName and other parameters, like the leases container, need to match that of the Processor to measure.

Applies to

Share via