Package com.azure.search.documents.indexes.models

Class IndexStatisticsSummary

java.lang.Object
com.azure.search.documents.indexes.models.IndexStatisticsSummary
All Implemented Interfaces:
com.azure.json.JsonSerializable<IndexStatisticsSummary>
public final class IndexStatisticsSummary extends Object implements com.azure.json.JsonSerializable<IndexStatisticsSummary>
Statistics for a given index. Statistics are collected periodically and are not guaranteed to always be up-to-date.

  • Constructor Summary

    Constructors
    Constructor
    Description
    IndexStatisticsSummary(String name, long documentCount, long storageSize, long vectorIndexSize)
    Creates an instance of IndexStatisticsSummary class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static IndexStatisticsSummary
    fromJson(com.azure.json.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.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • IndexStatisticsSummary

      public IndexStatisticsSummary(String name, long documentCount, long storageSize, long vectorIndexSize)
      Creates an instance of IndexStatisticsSummary class.
      Parameters:
      name - the name value to set.
      documentCount - the documentCount value to set.
      storageSize - the storageSize value to set.
      vectorIndexSize - the vectorIndexSize value to set.

  • Method Details

    • getName

      public String getName()
      Get the name property: The name of the index.
      Returns:
      the name value.

    • 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 com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<IndexStatisticsSummary>
      Throws:
      IOException

    • fromJson

      public static IndexStatisticsSummary fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      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:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the IndexStatisticsSummary.