com.microsoft.azure.cosmosdb

Class PartitionKeyDefinition

java.lang.Object

com.microsoft.azure.cosmosdb.JsonSerializable

com.microsoft.azure.cosmosdb.PartitionKeyDefinition

All Implemented Interfaces:

Serializable

public final class PartitionKeyDefinition
extends JsonSerializable

Represents a partition key definition in the Azure Cosmos DB database service. A partition key definition specifies which document property is used as the partition key in a collection that has multiple partitions.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PartitionKeyDefinition() Constructor.
PartitionKeyDefinition(org.json.JSONObject jsonObject) Constructor.
PartitionKeyDefinition(String jsonString) Constructor.

Method Summary

Modifier and Type	Method and Description
PartitionKind	getKind() Sets the partition algorithm used to calculate the partition id given a partition key.
Collection<String>	getPaths() Gets the document property paths for the partition key.
void	setKind(PartitionKind kind) Sets the partition algorithm used to calculate the partition id given a partition key.
void	setPaths(Collection<String> paths) Sets the document property paths for the partition key.

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

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PartitionKeyDefinition

public PartitionKeyDefinition()

Constructor. Creates a new instance of the PartitionKeyDefinition object.

PartitionKeyDefinition

public PartitionKeyDefinition(String jsonString)

Constructor. Creates a new instance of the PartitionKeyDefinition object from a JSON string.

Parameters:

jsonString - the JSON string that represents the partition key definition.

PartitionKeyDefinition

public PartitionKeyDefinition(org.json.JSONObject jsonObject)

Constructor. Creates a new instance of the PartitionKeyDefinition object from a JSON object.

Parameters:

jsonObject - the JSON object that represents the partition key definition.

Method Detail

getKind

public PartitionKind getKind()

Sets the partition algorithm used to calculate the partition id given a partition key.

Returns:

the partition algorithm.

setKind

public void setKind(PartitionKind kind)

Sets the partition algorithm used to calculate the partition id given a partition key.

Parameters:

kind - the partition algorithm.

getPaths

public Collection<String> getPaths()

Gets the document property paths for the partition key.

Returns:

the paths to the document properties that form the partition key.

setPaths

public void setPaths(Collection<String> paths)

Sets the document property paths for the partition key.

Parameters:

paths - the paths to document properties that form the partition key.