FeedRange Interface

public interface FeedRange

Represents a feed range.

Method Summary

Modifier and Type Method and Description
static FeedRange forFullRange()

Creates a range for an entire container

static FeedRange forLogicalPartition(PartitionKey partitionKey)

Creates a range for a certain logical partition

static FeedRange fromString(String json)

Creates a range from a previously obtained string representation.

abstract String toString()

Gets a json representation of the feed range - the returned json string can be used to create a new feed range instance from it - (use factory method fromJsonString to do so)

Method Details

forFullRange

public static FeedRange forFullRange()

Creates a range for an entire container

Returns:

A feed range for an entire container

forLogicalPartition

public static FeedRange forLogicalPartition(PartitionKey partitionKey)

Creates a range for a certain logical partition

Parameters:

partitionKey - the logical partition key value

Returns:

A feed range for a certain logical partition

fromString

public static FeedRange fromString(String json)

Creates a range from a previously obtained string representation.

Parameters:

json - A string representation of a feed range

Returns:

A feed range

toString

public abstract String toString()

Gets a json representation of the feed range - the returned json string can be used to create a new feed range instance from it - (use factory method fromJsonString to do so)

Overrides:

FeedRange.toString()

Returns:

a JSON string representing the feed range

Applies to