Class ChangeFeedStartFrom

Namespace

Microsoft.Azure.Cosmos

Assembly

Microsoft.Azure.Cosmos.Client.dll

Base class for where to start a ChangeFeed operation in ChangeFeedRequestOptions.

public abstract class ChangeFeedStartFrom

Inheritance

object

ChangeFeedStartFrom

Inherited Members

object.GetType()

object.MemberwiseClone()

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)

Remarks

Use one of the static constructors to generate a StartFrom option.

Methods

Beginning()

Creates a ChangeFeedStartFrom that tells the ChangeFeed operation to start from the beginning of time.

public static ChangeFeedStartFrom Beginning()

Returns

ChangeFeedStartFrom

A ChangeFeedStartFrom that tells the ChangeFeed operation to start reading changes from the beginning of time.

Beginning(FeedRange)

Creates a ChangeFeedStartFrom that tells the ChangeFeed operation to start from the beginning of time.

public static ChangeFeedStartFrom Beginning(FeedRange feedRange)

Parameters

feedRange FeedRange

The range to start from.

Returns

ChangeFeedStartFrom

A ChangeFeedStartFrom that tells the ChangeFeed operation to start reading changes from the beginning of time.

ContinuationToken(string)

Creates a ChangeFeedStartFrom that tells the ChangeFeed operation to start reading changes from a save point.

public static ChangeFeedStartFrom ContinuationToken(string continuationToken)

Parameters

continuationToken string

The continuation to resume from.

Returns

ChangeFeedStartFrom

A ChangeFeedStartFrom that tells the ChangeFeed operation to start reading changes from a save point.

Now()

Creates a ChangeFeedStartFrom that tells the ChangeFeed operation to start reading changes from this moment onward.

public static ChangeFeedStartFrom Now()

Returns

ChangeFeedStartFrom

A ChangeFeedStartFrom that tells the ChangeFeed operation to start reading changes from this moment onward.

Now(FeedRange)

Creates a ChangeFeedStartFrom that tells the ChangeFeed operation to start reading changes from this moment onward.

public static ChangeFeedStartFrom Now(FeedRange feedRange)

Parameters

feedRange FeedRange

The range to start from.

Returns

ChangeFeedStartFrom

A ChangeFeedStartFrom that tells the ChangeFeed operation to start reading changes from this moment onward.

Time(DateTime)

Creates a ChangeFeedStartFrom that tells the ChangeFeed operation to start reading changes from some point in time onward.

public static ChangeFeedStartFrom Time(DateTime dateTimeUtc)

Parameters

dateTimeUtc DateTime

The time (in UTC) to start reading from.

Returns

ChangeFeedStartFrom

A ChangeFeedStartFrom that tells the ChangeFeed operation to start reading changes from some point in time onward.

Time(DateTime, FeedRange)

Creates a ChangeFeedStartFrom that tells the ChangeFeed operation to start reading changes from some point in time onward.

public static ChangeFeedStartFrom Time(DateTime dateTimeUtc, FeedRange feedRange)

Parameters

dateTimeUtc DateTime

The time to start reading from.

feedRange FeedRange

The range to start from.

Returns

ChangeFeedStartFrom

A ChangeFeedStartFrom that tells the ChangeFeed operation to start reading changes from some point in time onward.