Class SynchronizationState

java.lang.Object
com.azure.search.documents.indexes.models.SynchronizationState
All Implemented Interfaces:
com.azure.json.JsonSerializable<SynchronizationState>
public final class SynchronizationState extends Object implements com.azure.json.JsonSerializable<SynchronizationState>
Represents the current state of an ongoing synchronization that spans multiple indexer runs.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SynchronizationState(OffsetDateTime startTime, int itemsUpdatesProcessed, int itemsUpdatesFailed, int itemsSkipped)
    Creates an instance of SynchronizationState class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static SynchronizationState
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of SynchronizationState from the JsonReader.
    int
    getItemsSkipped()
    Get the itemsSkipped property: The number of items skipped in the current synchronization.
    int
    getItemsUpdatesFailed()
    Get the itemsUpdatesFailed property: The number of item updates that failed in the current synchronization.
    int
    getItemsUpdatesProcessed()
    Get the itemsUpdatesProcessed property: The number of item updates successfully processed in the current synchronization.
    OffsetDateTime
    getStartTime()
    Get the startTime property: The start time of the current synchronization.
    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

    • SynchronizationState

      public SynchronizationState(OffsetDateTime startTime, int itemsUpdatesProcessed, int itemsUpdatesFailed, int itemsSkipped)
      Creates an instance of SynchronizationState class.
      Parameters:
      startTime - the startTime value to set.
      itemsUpdatesProcessed - the itemsUpdatesProcessed value to set.
      itemsUpdatesFailed - the itemsUpdatesFailed value to set.
      itemsSkipped - the itemsSkipped value to set.

  • Method Details

    • getStartTime

      public OffsetDateTime getStartTime()
      Get the startTime property: The start time of the current synchronization.
      Returns:
      the startTime value.

    • getItemsUpdatesProcessed

      public int getItemsUpdatesProcessed()
      Get the itemsUpdatesProcessed property: The number of item updates successfully processed in the current synchronization.
      Returns:
      the itemsUpdatesProcessed value.

    • getItemsUpdatesFailed

      public int getItemsUpdatesFailed()
      Get the itemsUpdatesFailed property: The number of item updates that failed in the current synchronization.
      Returns:
      the itemsUpdatesFailed value.

    • getItemsSkipped

      public int getItemsSkipped()
      Get the itemsSkipped property: The number of items skipped in the current synchronization.
      Returns:
      the itemsSkipped value.

    • toJson

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

    • fromJson

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