GetIndexStatisticsResult Class

Package:
com.azure.search.documents.indexes.models
Maven Artifact:
com.azure:azure-search-documents:12.0.0
  • java.lang.Object
    • com.azure.search.documents.indexes.models.GetIndexStatisticsResult

Implements

JsonSerializable<GetIndexStatisticsResult>

public final class GetIndexStatisticsResult
implements JsonSerializable<GetIndexStatisticsResult>

Statistics for a given index. Statistics are collected periodically and are not guaranteed to always be up-to-date.

Constructor Summary

Constructor Description
GetIndexStatisticsResult()

Creates an instance of GetIndexStatisticsResult class.

Method Summary

Modifier and Type Method and Description
static GetIndexStatisticsResult fromJson(JsonReader jsonReader)

Reads an instance of GetIndexStatisticsResult from the JsonReader.
long getDocumentCount()

Get the documentCount property: The number of documents in the index.
long getStorageSize()

Get the storageSize property: The amount of storage in bytes consumed by the index.
long getVectorIndexSizeInBytes()

Get the vectorIndexSizeInBytes property: The amount of memory in bytes consumed by vectors in the index.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

GetIndexStatisticsResult

public GetIndexStatisticsResult()

Creates an instance of GetIndexStatisticsResult class.

Method Details

fromJson

public static GetIndexStatisticsResult fromJson(JsonReader jsonReader)

Reads an instance of GetIndexStatisticsResult from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of GetIndexStatisticsResult if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

getDocumentCount

public long getDocumentCount()

Get the documentCount property: The number of documents in the index.

Returns:

the documentCount value.

getStorageSize

public long getStorageSize()

Get the storageSize property: The amount of storage in bytes consumed by the index.

Returns:

the storageSize value.

getVectorIndexSizeInBytes

public long getVectorIndexSizeInBytes()

Get the vectorIndexSizeInBytes property: The amount of memory in bytes consumed by vectors in the index.

Returns:

the vectorIndexSizeInBytes value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to