PartitionKey Class

Package:

com.microsoft.azure.documentdb

• java.lang.Object
• • com.microsoft.azure.documentdb.PartitionKey

public class PartitionKey

Represents a partition key value in the Azure Cosmos DB database service. A partition key identifies the partition where the document is stored in.

Constructor Summary

Constructor	Description
PartitionKey(final Object key)	Constructor. Create a new instance of the PartitionKey object.

Method Summary

Modifier and Type	Method and Description
PartitionKey	FromJsonString(String jsonString) Create a new instance of the PartitionKey object from a serialized JSON string.
PartitionKeyInternal	getInternalPartitionKey()
String	toString() Serialize the PartitionKey object to a JSON string.

Constructor Details

PartitionKey

public PartitionKey(final Object key)

Constructor. Create a new instance of the PartitionKey object.

Parameters:

key - the value of the partition key.

Method Details

FromJsonString

public static PartitionKey FromJsonString(String jsonString)

Create a new instance of the PartitionKey object from a serialized JSON string.

Parameters:

jsonString - the JSON string representation of this PartitionKey object.

Returns:

the PartitionKey instance.

getInternalPartitionKey

public PartitionKeyInternal getInternalPartitionKey()

toString

public String toString()

Serialize the PartitionKey object to a JSON string.

Returns:

the string representation of this PartitionKey object.