PartitionKeyDefinition Class

Definition

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.

public class PartitionKeyDefinition extends JsonSerializable
Inheritance
java.lang.Object
Serializable
PartitionKeyDefinition

Inherited Members

Constructors

PartitionKeyDefinition()

Constructor. Creates a new instance of the PartitionKeyDefinition object.

PartitionKeyDefinition(JSONObject jsonObject)

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

PartitionKeyDefinition(String jsonString)

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

Methods

getKind()

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

getPaths()

Gets the document property paths for the partition key.

setKind(PartitionKind kind)

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

setPaths(Collection<String> paths)

Sets the document property paths for the partition key.

Applies to