com.microsoft.azure.cosmosdb

Class PartitionKeyRange

java.lang.Object

com.microsoft.azure.cosmosdb.JsonSerializable

com.microsoft.azure.cosmosdb.Resource

com.microsoft.azure.cosmosdb.PartitionKeyRange

public class PartitionKeyRange
extends Resource

Represent a partition key range in the Azure Cosmos DB database service.

Field Summary

Fields

Modifier and Type	Field and Description
static String	MASTER_PARTITION_KEY_RANGE_ID
static String	MAXIMUM_EXCLUSIVE_EFFECTIVE_PARTITION_KEY
static String	MINIMUM_INCLUSIVE_EFFECTIVE_PARTITION_KEY

Constructor Summary

Constructors

Constructor and Description
PartitionKeyRange() Initialize a partition key range object.
PartitionKeyRange(String jsonString) Initialize a partition key range object from json string.
PartitionKeyRange(String id, String minInclusive, String maxExclusive)
PartitionKeyRange(String id, String minInclusive, String maxExclusive, List<String> parents)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getMaxExclusive()
String	getMinInclusive()
List<String>	getParents() Used internally to indicate the ID of the parent range
int	hashCode()
void	setMaxExclusive(String maxExclusive)
void	setMinInclusive(String minInclusive)
com.microsoft.azure.cosmosdb.internal.routing.Range<String>	toRange()

Methods inherited from class com.microsoft.azure.cosmosdb.Resource

getETag, getId, getResourceId, getSelfLink, getTimestamp, setId, setResourceId

Methods inherited from class com.microsoft.azure.cosmosdb.JsonSerializable

get, getBoolean, getCollection, getCollection, getDouble, getHashMap, getInt, getList, getLogger, getLong, getMapper, getObject, getObject, getObjectByPath, getString, has, remove, set, toJson, toJson, toObject, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MINIMUM_INCLUSIVE_EFFECTIVE_PARTITION_KEY

public static final String MINIMUM_INCLUSIVE_EFFECTIVE_PARTITION_KEY

See Also:

Constant Field Values

MAXIMUM_EXCLUSIVE_EFFECTIVE_PARTITION_KEY

public static final String MAXIMUM_EXCLUSIVE_EFFECTIVE_PARTITION_KEY

See Also:

Constant Field Values

MASTER_PARTITION_KEY_RANGE_ID

public static final String MASTER_PARTITION_KEY_RANGE_ID

See Also:

Constant Field Values

Constructor Detail

PartitionKeyRange

public PartitionKeyRange()

Initialize a partition key range object.

PartitionKeyRange

public PartitionKeyRange(String jsonString)

Initialize a partition key range object from json string.

Parameters:

jsonString - the json string that represents the partition key range object.

PartitionKeyRange

public PartitionKeyRange(String id,
                         String minInclusive,
                         String maxExclusive)

PartitionKeyRange

public PartitionKeyRange(String id,
                         String minInclusive,
                         String maxExclusive,
                         List<String> parents)

Method Detail

getMinInclusive

public String getMinInclusive()

setMinInclusive

public void setMinInclusive(String minInclusive)

getMaxExclusive

public String getMaxExclusive()

setMaxExclusive

public void setMaxExclusive(String maxExclusive)

toRange

public com.microsoft.azure.cosmosdb.internal.routing.Range<String> toRange()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getParents

public List<String> getParents()

Used internally to indicate the ID of the parent range

Returns:

a list partition key range ID