PartitionKeyRangeStatistics Class

Package:

com.microsoft.azure.documentdb

Maven Artifact:

com.microsoft.azure:azure-documentdb:2.4.7

• java.lang.Object
• • com.microsoft.azure.documentdb.JsonSerializable
  • • com.microsoft.azure.documentdb.PartitionKeyRangeStatistics

public class PartitionKeyRangeStatistics
extends JsonSerializable

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
long	getDocumentCount() Gets the documentCount property.
java.lang.String	getId() Gets the partitionKeyRangeId property.
java.util.Collection<PartitionKeyStatistics>	getPartitionKeyStatistics() Gets the partitionKeyStatistics property.
long	getSizeInKB() Gets the sizeInKB property.

Methods inherited from JsonSerializable

<T>getCollection <T>getObject <T>set <T>toObject get getBoolean getCollection getDouble getHashMap getInt getLogger getLong getMapper getObject getObjectByPath getString has remove toJson toJson toString toString

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

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.

PartitionKeyRangeStatistics

public PartitionKeyRangeStatistics(JSONObject jsonObject)

Constructor.

Parameters:

jsonObject - the json object 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.