Share via

PartitionKeyRangeStatistics Class

  • Reference
Package:
com.microsoft.azure.documentdb
  • java.lang.Object
    • Serializable

public class PartitionKeyRangeStatistics extends JsonSerializable

Constructor Summary

Constructor Description
PartitionKeyRangeStatistics(JSONObject jsonObject)

Constructor.
PartitionKeyRangeStatistics(String jsonString)

Initialize a PartitionKeyRangeStatistics object using the input JSON string.

Method Summary

Modifier and Type Method and Description
long getDocumentCount()

Gets the documentCount property.
String getId()

Gets the partitionKeyRangeId property.
Collection<PartitionKeyStatistics> getPartitionKeyStatistics()

Gets the partitionKeyStatistics property.
long getSizeInKB()

Gets the sizeInKB property.

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() JsonSerializable.toString(int indentFactor)

Constructor Details

PartitionKeyRangeStatistics

public PartitionKeyRangeStatistics(JSONObject jsonObject)

Constructor.

Parameters:

jsonObject - the json object that represents the Partition Key Statistics for the physical partition.

PartitionKeyRangeStatistics

public PartitionKeyRangeStatistics(String jsonString)

Initialize a PartitionKeyRangeStatistics object using the input JSON string.

Parameters:

jsonString - the json string that represents the Partition Key Statistics for the physical partition.

Method Details

getDocumentCount

public long getDocumentCount()

Gets the documentCount property.

Returns:

the count of documents in the partition.

getId

public String getId()

Gets the partitionKeyRangeId property.

Returns:

the value of the partition key range id.

getPartitionKeyStatistics

public Collection getPartitionKeyStatistics()

Gets the partitionKeyStatistics property.

Returns:

the size (in KB) of the top logical partition keys within each physical partition of the collection.

getSizeInKB

public long getSizeInKB()

Gets the sizeInKB property.

Returns:

the size (in KB) of the partition.

Applies to