com.microsoft.azure.cosmosdb

Class PartitionKeyDefinition

java.lang.Object

com.microsoft.azure.cosmosdb.JsonSerializable

com.microsoft.azure.cosmosdb.PartitionKeyDefinition

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.

Constructor Summary

Constructors

Constructor and Description
PartitionKeyDefinition() 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.
List<String>	getPaths() Gets the document property paths for the partition key.
PartitionKeyDefinitionVersion	getVersion()
void	setKind(PartitionKind kind) Sets the partition algorithm used to calculate the partition id given a partition key.
void	setPaths(List<String> paths) Sets the document property paths for the partition key.
void	setVersion(PartitionKeyDefinitionVersion version)

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

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.

getVersion

public PartitionKeyDefinitionVersion getVersion()

setVersion

public void setVersion(PartitionKeyDefinitionVersion version)

getPaths

public List<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(List<String> paths)

Sets the document property paths for the partition key.

Parameters:

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