Class KnowledgeSourceStatus

java.lang.Object
com.azure.search.documents.indexes.models.KnowledgeSourceStatus
All Implemented Interfaces:
com.azure.json.JsonSerializable<KnowledgeSourceStatus>
public final class KnowledgeSourceStatus extends Object implements com.azure.json.JsonSerializable<KnowledgeSourceStatus>
Represents the status and synchronization history of a knowledge source.

  • Constructor Details

    • KnowledgeSourceStatus

      public KnowledgeSourceStatus(KnowledgeSourceSynchronizationStatus synchronizationStatus)
      Creates an instance of KnowledgeSourceStatus class.
      Parameters:
      synchronizationStatus - the synchronizationStatus value to set.

  • Method Details

    • getSynchronizationStatus

      public KnowledgeSourceSynchronizationStatus getSynchronizationStatus()
      Get the synchronizationStatus property: The current synchronization status of the knowledge source.
      Returns:
      the synchronizationStatus value.

    • getSynchronizationInterval

      public String getSynchronizationInterval()
      Get the synchronizationInterval property: The synchronization interval (e.g., '1d' for daily). Null if no schedule is configured.
      Returns:
      the synchronizationInterval value.

    • setSynchronizationInterval

      public KnowledgeSourceStatus setSynchronizationInterval(String synchronizationInterval)
      Set the synchronizationInterval property: The synchronization interval (e.g., '1d' for daily). Null if no schedule is configured.
      Parameters:
      synchronizationInterval - the synchronizationInterval value to set.
      Returns:
      the KnowledgeSourceStatus object itself.

    • getCurrentSynchronizationState

      public SynchronizationState getCurrentSynchronizationState()
      Get the currentSynchronizationState property: Current synchronization state that spans multiple indexer runs.
      Returns:
      the currentSynchronizationState value.

    • setCurrentSynchronizationState

      public KnowledgeSourceStatus setCurrentSynchronizationState(SynchronizationState currentSynchronizationState)
      Set the currentSynchronizationState property: Current synchronization state that spans multiple indexer runs.
      Parameters:
      currentSynchronizationState - the currentSynchronizationState value to set.
      Returns:
      the KnowledgeSourceStatus object itself.

    • getLastSynchronizationState

      public CompletedSynchronizationState getLastSynchronizationState()
      Get the lastSynchronizationState property: Details of the last completed synchronization. Null on first sync.
      Returns:
      the lastSynchronizationState value.

    • setLastSynchronizationState

      public KnowledgeSourceStatus setLastSynchronizationState(CompletedSynchronizationState lastSynchronizationState)
      Set the lastSynchronizationState property: Details of the last completed synchronization. Null on first sync.
      Parameters:
      lastSynchronizationState - the lastSynchronizationState value to set.
      Returns:
      the KnowledgeSourceStatus object itself.

    • getStatistics

      public KnowledgeSourceStatistics getStatistics()
      Get the statistics property: Statistical information about the knowledge source synchronization history. Null on first sync.
      Returns:
      the statistics value.

    • setStatistics

      public KnowledgeSourceStatus setStatistics(KnowledgeSourceStatistics statistics)
      Set the statistics property: Statistical information about the knowledge source synchronization history. Null on first sync.
      Parameters:
      statistics - the statistics value to set.
      Returns:
      the KnowledgeSourceStatus object itself.

    • toJson

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

    • fromJson

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