SearchIndexStatistics Class

  • Reference
Package:
com.azure.search.documents.indexes.models
Maven Artifact:
com.azure:azure-search-documents:11.6.4
  • java.lang.Object
    • com.azure.search.documents.indexes.models.SearchIndexStatistics

Implements

JsonSerializable<SearchIndexStatistics>

public final class SearchIndexStatistics
implements JsonSerializable<SearchIndexStatistics>

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

Constructor Summary

Constructor Description
SearchIndexStatistics(long documentCount, long storageSize)

Creates an instance of SearchIndexStatistics class.

Method Summary

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

Reads an instance of SearchIndexStatistics 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 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

Constructor Details

SearchIndexStatistics

public SearchIndexStatistics(long documentCount, long storageSize)

Creates an instance of SearchIndexStatistics class.

Parameters:

documentCount - the documentCount value to set.
storageSize - the storageSize value to set.

Method Details

fromJson

public static SearchIndexStatistics fromJson(JsonReader jsonReader)

Reads an instance of SearchIndexStatistics from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

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