Class KnowledgeSourceStatistics

java.lang.Object
com.azure.search.documents.indexes.models.KnowledgeSourceStatistics
All Implemented Interfaces:
com.azure.json.JsonSerializable<KnowledgeSourceStatistics>
public final class KnowledgeSourceStatistics extends Object implements com.azure.json.JsonSerializable<KnowledgeSourceStatistics>
Statistical information about knowledge source synchronization history.

  • Constructor Summary

    Constructors
    Constructor
    Description
    KnowledgeSourceStatistics(int totalSynchronization, String averageSynchronizationDuration, int averageItemsProcessedPerSynchronization)
    Creates an instance of KnowledgeSourceStatistics class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static KnowledgeSourceStatistics
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of KnowledgeSourceStatistics from the JsonReader.
    int
    getAverageItemsProcessedPerSynchronization()
    Get the averageItemsProcessedPerSynchronization property: The average number of items processed per synchronization.
    String
    getAverageSynchronizationDuration()
    Get the averageSynchronizationDuration property: The average duration of synchronizations in HH:MM:SS format.
    int
    getTotalSynchronization()
    Get the totalSynchronization property: The total number of synchronizations completed.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class 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

    • KnowledgeSourceStatistics

      public KnowledgeSourceStatistics(int totalSynchronization, String averageSynchronizationDuration, int averageItemsProcessedPerSynchronization)
      Creates an instance of KnowledgeSourceStatistics class.
      Parameters:
      totalSynchronization - the totalSynchronization value to set.
      averageSynchronizationDuration - the averageSynchronizationDuration value to set.
      averageItemsProcessedPerSynchronization - the averageItemsProcessedPerSynchronization value to set.

  • Method Details

    • getTotalSynchronization

      public int getTotalSynchronization()
      Get the totalSynchronization property: The total number of synchronizations completed.
      Returns:
      the totalSynchronization value.

    • getAverageSynchronizationDuration

      public String getAverageSynchronizationDuration()
      Get the averageSynchronizationDuration property: The average duration of synchronizations in HH:MM:SS format.
      Returns:
      the averageSynchronizationDuration value.

    • getAverageItemsProcessedPerSynchronization

      public int getAverageItemsProcessedPerSynchronization()
      Get the averageItemsProcessedPerSynchronization property: The average number of items processed per synchronization.
      Returns:
      the averageItemsProcessedPerSynchronization value.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<KnowledgeSourceStatistics>
      Throws:
      IOException

    • fromJson

      public static KnowledgeSourceStatistics fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of KnowledgeSourceStatistics from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of KnowledgeSourceStatistics 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 KnowledgeSourceStatistics.