### YamlMime:JavaType
uid: "com.microsoft.azure.documentdb.PartitionKeyDefinition"
fullName: "com.microsoft.azure.documentdb.PartitionKeyDefinition"
name: "PartitionKeyDefinition"
nameWithType: "PartitionKeyDefinition"
summary: "Represents a partition key definition in the Azure Cosmos DB database service."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable?alt=com.microsoft.azure.documentdb.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />"
  methodsRef:
  - "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.<T>getCollection(java.lang.String,java.lang.Class<T>)?alt=com.microsoft.azure.documentdb.JsonSerializable.<T>getCollection&text=<T>getCollection\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.<T>getObject(java.lang.String,java.lang.Class<T>)?alt=com.microsoft.azure.documentdb.JsonSerializable.<T>getObject&text=<T>getObject\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.<T>set(java.lang.String,T)?alt=com.microsoft.azure.documentdb.JsonSerializable.<T>set&text=<T>set\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.<T>toObject(java.lang.Class<T>)?alt=com.microsoft.azure.documentdb.JsonSerializable.<T>toObject&text=<T>toObject\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.get(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.get&text=get\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getBoolean(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getBoolean&text=getBoolean\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getCollection(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getCollection&text=getCollection\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getDouble(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getDouble&text=getDouble\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getHashMap()?alt=com.microsoft.azure.documentdb.JsonSerializable.getHashMap&text=getHashMap\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getInt(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getInt&text=getInt\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getLogger()?alt=com.microsoft.azure.documentdb.JsonSerializable.getLogger&text=getLogger\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getLong(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getLong&text=getLong\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getMapper()?alt=com.microsoft.azure.documentdb.JsonSerializable.getMapper&text=getMapper\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getObject(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getObject&text=getObject\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getObjectByPath(java.util.Collection<java.lang.String>)?alt=com.microsoft.azure.documentdb.JsonSerializable.getObjectByPath&text=getObjectByPath\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getString(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getString&text=getString\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.has(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.has&text=has\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.remove(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.remove&text=remove\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.toJson()?alt=com.microsoft.azure.documentdb.JsonSerializable.toJson&text=toJson\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.toJson(com.microsoft.azure.documentdb.SerializationFormattingPolicy)?alt=com.microsoft.azure.documentdb.JsonSerializable.toJson&text=toJson\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.toString()?alt=com.microsoft.azure.documentdb.JsonSerializable.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.toString(int)?alt=com.microsoft.azure.documentdb.JsonSerializable.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
  methodsRef:
  - "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
syntax: "public final class **PartitionKeyDefinition**</br> extends <xref href=\"com.microsoft.azure.documentdb.JsonSerializable?alt=com.microsoft.azure.documentdb.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.microsoft.azure.documentdb.PartitionKeyDefinition.PartitionKeyDefinition()"
  fullName: "com.microsoft.azure.documentdb.PartitionKeyDefinition.PartitionKeyDefinition()"
  name: "PartitionKeyDefinition()"
  nameWithType: "PartitionKeyDefinition.PartitionKeyDefinition()"
  summary: "Constructor."
  syntax: "public PartitionKeyDefinition()"
  desc: "Constructor. Creates a new instance of the PartitionKeyDefinition object."
- uid: "com.microsoft.azure.documentdb.PartitionKeyDefinition.PartitionKeyDefinition(java.lang.String)"
  fullName: "com.microsoft.azure.documentdb.PartitionKeyDefinition.PartitionKeyDefinition(String jsonString)"
  name: "PartitionKeyDefinition(String jsonString)"
  nameWithType: "PartitionKeyDefinition.PartitionKeyDefinition(String jsonString)"
  summary: "Constructor."
  parameters:
  - description: "the JSON string that represents the partition key definition."
    name: "jsonString"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public PartitionKeyDefinition(String jsonString)"
  desc: "Constructor. Creates a new instance of the PartitionKeyDefinition object from a JSON string."
- uid: "com.microsoft.azure.documentdb.PartitionKeyDefinition.PartitionKeyDefinition(org.json.JSONObject)"
  fullName: "com.microsoft.azure.documentdb.PartitionKeyDefinition.PartitionKeyDefinition(JSONObject jsonObject)"
  name: "PartitionKeyDefinition(JSONObject jsonObject)"
  nameWithType: "PartitionKeyDefinition.PartitionKeyDefinition(JSONObject jsonObject)"
  summary: "Constructor."
  parameters:
  - description: "the JSON object that represents the partition key definition."
    name: "jsonObject"
    type: "<xref href=\"org.json.JSONObject?alt=org.json.JSONObject&text=JSONObject\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public PartitionKeyDefinition(JSONObject jsonObject)"
  desc: "Constructor. Creates a new instance of the PartitionKeyDefinition object from a JSON object."
methods:
- uid: "com.microsoft.azure.documentdb.PartitionKeyDefinition.getKind()"
  fullName: "com.microsoft.azure.documentdb.PartitionKeyDefinition.getKind()"
  name: "getKind()"
  nameWithType: "PartitionKeyDefinition.getKind()"
  summary: "Sets the partition algorithm used to calculate the partition id given a partition key."
  syntax: "public PartitionKind getKind()"
  desc: "Sets the partition algorithm used to calculate the partition id given a partition key."
  returns:
    description: "the partition algorithm."
    type: "<xref href=\"com.microsoft.azure.documentdb.PartitionKind?alt=com.microsoft.azure.documentdb.PartitionKind&text=PartitionKind\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.PartitionKeyDefinition.getPaths()"
  fullName: "com.microsoft.azure.documentdb.PartitionKeyDefinition.getPaths()"
  name: "getPaths()"
  nameWithType: "PartitionKeyDefinition.getPaths()"
  summary: "Gets the document property paths for the partition key."
  syntax: "public Collection<String> getPaths()"
  desc: "Gets the document property paths for the partition key."
  returns:
    description: "the paths to the document properties that form the partition key."
    type: "<xref href=\"java.util.Collection?alt=java.util.Collection&text=Collection\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.documentdb.PartitionKeyDefinition.getVersion()"
  fullName: "com.microsoft.azure.documentdb.PartitionKeyDefinition.getVersion()"
  name: "getVersion()"
  nameWithType: "PartitionKeyDefinition.getVersion()"
  syntax: "public PartitionKeyDefinitionVersion getVersion()"
  returns:
    type: "<xref href=\"com.microsoft.azure.documentdb.PartitionKeyDefinitionVersion?alt=com.microsoft.azure.documentdb.PartitionKeyDefinitionVersion&text=PartitionKeyDefinitionVersion\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.PartitionKeyDefinition.setKind(com.microsoft.azure.documentdb.PartitionKind)"
  fullName: "com.microsoft.azure.documentdb.PartitionKeyDefinition.setKind(PartitionKind kind)"
  name: "setKind(PartitionKind kind)"
  nameWithType: "PartitionKeyDefinition.setKind(PartitionKind kind)"
  summary: "Sets the partition algorithm used to calculate the partition id given a partition key."
  parameters:
  - description: "the partition algorithm."
    name: "kind"
    type: "<xref href=\"com.microsoft.azure.documentdb.PartitionKind?alt=com.microsoft.azure.documentdb.PartitionKind&text=PartitionKind\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public void setKind(PartitionKind kind)"
  desc: "Sets the partition algorithm used to calculate the partition id given a partition key."
- uid: "com.microsoft.azure.documentdb.PartitionKeyDefinition.setPaths(java.util.Collection<java.lang.String>)"
  fullName: "com.microsoft.azure.documentdb.PartitionKeyDefinition.setPaths(Collection<String> paths)"
  name: "setPaths(Collection<String> paths)"
  nameWithType: "PartitionKeyDefinition.setPaths(Collection<String> paths)"
  summary: "Sets the document property paths for the partition key."
  parameters:
  - description: "the paths to document properties that form the partition key."
    name: "paths"
    type: "<xref href=\"java.util.Collection?alt=java.util.Collection&text=Collection\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />&gt;"
  syntax: "public void setPaths(Collection<String> paths)"
  desc: "Sets the document property paths for the partition key."
- uid: "com.microsoft.azure.documentdb.PartitionKeyDefinition.setVersion(com.microsoft.azure.documentdb.PartitionKeyDefinitionVersion)"
  fullName: "com.microsoft.azure.documentdb.PartitionKeyDefinition.setVersion(PartitionKeyDefinitionVersion version)"
  name: "setVersion(PartitionKeyDefinitionVersion version)"
  nameWithType: "PartitionKeyDefinition.setVersion(PartitionKeyDefinitionVersion version)"
  parameters:
  - name: "version"
    type: "<xref href=\"com.microsoft.azure.documentdb.PartitionKeyDefinitionVersion?alt=com.microsoft.azure.documentdb.PartitionKeyDefinitionVersion&text=PartitionKeyDefinitionVersion\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public void setVersion(PartitionKeyDefinitionVersion version)"
type: "class"
desc: "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."
metadata: {}
package: "com.microsoft.azure.documentdb"
artifact: com.microsoft.azure:azure-documentdb:2.4.7