ChangeFeedProcessorBuilder.WithMaxItems(Int32) Method

Reference

Definition

Namespace:: Microsoft.Azure.Cosmos

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

Package:: Microsoft.Azure.Cosmos v3.39.0

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

Sets the maximum number of items to be returned in the enumeration operation in the Azure Cosmos DB service.

public Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder WithMaxItems (int maxItemCount);

member this.WithMaxItems : int -> Microsoft.Azure.Cosmos.ChangeFeedProcessorBuilder

Public Function WithMaxItems (maxItemCount As Integer) As ChangeFeedProcessorBuilder

Parameters

maxItemCount: Int32

Maximum amount of items to be returned in a Change Feed request.

Returns

ChangeFeedProcessorBuilder

An instance of ChangeFeedProcessorBuilder.

Remarks

This is just a hint to the server which can return less or more items per page. If operations in the container are performed through stored procedures or transactional batch, transaction scope is preserved when reading items from the Change Feed. As a result, the number of items received could be higher than the specified value so that the items changed by the same transaction are returned as part of one atomic batch.

Applies to