IndexStatisticsSummary Class

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

Implements

JsonSerializable<IndexStatisticsSummary>

public final class IndexStatisticsSummary
implements JsonSerializable<IndexStatisticsSummary>

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

Method Summary

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

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

Get the documentCount property: The number of documents in the index.
String getName()

Get the name property: The name of the index.
long getStorageSize()

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

Get the vectorIndexSize 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

Method Details

fromJson

public static IndexStatisticsSummary fromJson(JsonReader jsonReader)

Reads an instance of IndexStatisticsSummary from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of IndexStatisticsSummary 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.

getName

public String getName()

Get the name property: The name of the index.

Returns:

the name value.

getStorageSize

public long getStorageSize()

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

Returns:

the storageSize value.

getVectorIndexSize

public long getVectorIndexSize()

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

Returns:

the vectorIndexSize value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to