com.azure.cosmos.models

Interface FeedRange

@Beta(value=V4_9_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public interface FeedRange

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.
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 Detail

fromString

@Beta(value=V4_9_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
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

@Beta(value=V4_9_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
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:

toString in class Object

Returns:

a JSON string representing the feed range

forLogicalPartition

@Beta(value=V4_12_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
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

forFullRange

@Beta(value=V4_12_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
static FeedRange forFullRange()

Creates a range for an entire container

Returns:

A feed range for an entire container