com.azure.cosmos

Class PartitionKeyDefinition

java.lang.Object

com.azure.cosmos.JsonSerializable

com.azure.cosmos.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.

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

Methods inherited from class com.azure.cosmos.JsonSerializable

get, getBoolean, getCollection, getDouble, getInt, getList, getLogger, getLong, getMap, getObject, getObjectByPath, getString, has, 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.

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 PartitionKeyDefinition setKind(PartitionKind kind)

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

Parameters:

kind - the partition algorithm.

Returns:

this PartitionKeyDefinition.

getVersion

public PartitionKeyDefinitionVersion getVersion()

setVersion

public PartitionKeyDefinition 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 PartitionKeyDefinition 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.

Returns:

this PartitionKeyDefinition.

Throws:

IllegalArgumentException - thrown if an error occurs