Share via

PartitionKeyDefinition Class

  • Reference
Package:
com.microsoft.azure.cosmosdb
  • java.lang.Object

public 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

Constructor Description
PartitionKeyDefinition()

Constructor. Creates a new instance of the PartitionKeyDefinition object.

PartitionKeyDefinition(String jsonString)

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

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)

Inherited Members

JsonSerializable.get(String propertyName) JsonSerializable.getBoolean(String propertyName) JsonSerializable.getCollection(String propertyName) JsonSerializable.getDouble(String propertyName) JsonSerializable.getHashMap() JsonSerializable.getInt(String propertyName) JsonSerializable.getLogger() JsonSerializable.getLong(String propertyName) JsonSerializable.getMapper() JsonSerializable.getObject(String propertyName) JsonSerializable.getObjectByPath(List<String> propertyNames) JsonSerializable.getString(String propertyName) JsonSerializable.has(String propertyName) JsonSerializable.JsonSerializable() JsonSerializable.JsonSerializable(String jsonString, ObjectMapper objectMapper) JsonSerializable.JsonSerializable(String jsonString) JsonSerializable.remove(String propertyName) JsonSerializable.toJson() JsonSerializable.toJson(SerializationFormattingPolicy formattingPolicy) JsonSerializable.toString()

Constructor Details

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 Details

getKind

public PartitionKind getKind()

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

Returns:

the partition algorithm.

getPaths

public List getPaths()

Gets the document property paths for the partition key.

Returns:

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

getVersion

public PartitionKeyDefinitionVersion getVersion()

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.

setPaths

public void setPaths(List paths)

Sets the document property paths for the partition key.

Parameters:

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

setVersion

public void setVersion(PartitionKeyDefinitionVersion version)

Parameters:

version

Applies to