PartitionKeyStatistics Class

Package:

com.microsoft.azure.documentdb

• java.lang.Object
• • Serializable
  • • JsonSerializable
    • • com.microsoft.azure.documentdb.PartitionKeyStatistics

public class PartitionKeyStatistics extends JsonSerializable

Represents the statistics of a logical partition key in the Azure Cosmos DB service.

Constructor Summary

Constructor	Description
PartitionKeyStatistics(JSONObject jsonObject)	Constructor.
PartitionKeyStatistics(String jsonString)	Initialize a PartitionKeyStatistics object using the input JSON string.

Method Summary

Modifier and Type	Method and Description
PartitionKey	getPartitionKey()
long	getSizeInKB() Gets the sizeInKB property.
String	toString() Serialize the PartitionKeyStatistics object to a JSON string.

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(Collection<String> propertyNames) JsonSerializable.getString(String propertyName) JsonSerializable.has(String propertyName) JsonSerializable.JsonSerializable() JsonSerializable.JsonSerializable(String jsonString, ObjectMapper objectMapper) JsonSerializable.JsonSerializable(String jsonString) JsonSerializable.JsonSerializable(JSONObject jsonObject) JsonSerializable.remove(String propertyName) JsonSerializable.toJson() JsonSerializable.toJson(SerializationFormattingPolicy formattingPolicy) JsonSerializable.toString(int indentFactor)

Constructor Details

PartitionKeyStatistics

public PartitionKeyStatistics(JSONObject jsonObject)

Constructor.

Parameters:

jsonObject - the json object that represents the Partition Key Statistics for the logical key within a physical partition.

PartitionKeyStatistics

public PartitionKeyStatistics(String jsonString)

Initialize a PartitionKeyStatistics object using the input JSON string.

Parameters:

jsonString - the json string that represents the Partition Key Statistics for the logical key within a physical partition.

Method Details

getPartitionKey

public PartitionKey getPartitionKey()

getSizeInKB

public long getSizeInKB()

Gets the sizeInKB property.

Returns:

the size (in KB) of the logical partition key value.

toString

public String toString()

Serialize the PartitionKeyStatistics object to a JSON string.

Returns:

the string representation of this PartitionKeyStatistics object.