Class ChangeFeedRequestOptions

Namespace

Microsoft.Azure.Cosmos

Assembly

Microsoft.Azure.Cosmos.Client.dll

The Cosmos Change Feed request options

public sealed class ChangeFeedRequestOptions : RequestOptions

Inheritance

object

RequestOptions

ChangeFeedRequestOptions

Inherited Members

RequestOptions.ShallowCopy()

RequestOptions.IfMatchEtag

RequestOptions.IfNoneMatchEtag

RequestOptions.Properties

RequestOptions.AddRequestHeaders

RequestOptions.PriorityLevel

RequestOptions.CosmosThresholdOptions

RequestOptions.ExcludeRegions

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

CosmosLinqExtensions.DocumentId(object)

CosmosLinqExtensions.IsArray(object)

CosmosLinqExtensions.IsBool(object)

CosmosLinqExtensions.IsDefined(object)

CosmosLinqExtensions.IsNull(object)

CosmosLinqExtensions.IsNumber(object)

CosmosLinqExtensions.IsObject(object)

CosmosLinqExtensions.IsPrimitive(object)

CosmosLinqExtensions.IsString(object)

CosmosLinqExtensions.RegexMatch(object, string, string)

CosmosLinqExtensions.RegexMatch(object, string)

Constructors

ChangeFeedRequestOptions()

public ChangeFeedRequestOptions()

Properties

PageSizeHint

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

public int? PageSizeHint { get; set; }

Property Value

int?

The maximum number of items to be returned in the enumeration operation.

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.