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

Class IndexerCurrentState

java.lang.Object
com.azure.search.documents.indexes.models.IndexerCurrentState
All Implemented Interfaces:
com.azure.json.JsonSerializable<IndexerCurrentState>
public final class IndexerCurrentState extends Object implements com.azure.json.JsonSerializable<IndexerCurrentState>
Represents all of the state that defines and dictates the indexer's current execution.

  • Constructor Details

    • IndexerCurrentState

      public IndexerCurrentState()
      Creates an instance of IndexerCurrentState class.

  • Method Details

    • getMode

      public IndexingMode getMode()
      Get the mode property: The mode the indexer is running in.
      Returns:
      the mode value.

    • getAllDocsInitialTrackingState

      public String getAllDocsInitialTrackingState()
      Get the allDocsInitialTrackingState property: Change tracking state used when indexing starts on all documents in the datasource.
      Returns:
      the allDocsInitialTrackingState value.

    • getAllDocsFinalTrackingState

      public String getAllDocsFinalTrackingState()
      Get the allDocsFinalTrackingState property: Change tracking state value when indexing finishes on all documents in the datasource.
      Returns:
      the allDocsFinalTrackingState value.

    • getResetDocsInitialTrackingState

      public String getResetDocsInitialTrackingState()
      Get the resetDocsInitialTrackingState property: Change tracking state used when indexing starts on select, reset documents in the datasource.
      Returns:
      the resetDocsInitialTrackingState value.

    • getResetDocsFinalTrackingState

      public String getResetDocsFinalTrackingState()
      Get the resetDocsFinalTrackingState property: Change tracking state value when indexing finishes on select, reset documents in the datasource.
      Returns:
      the resetDocsFinalTrackingState value.

    • getResetDocumentKeys

      public List<String> getResetDocumentKeys()
      Get the resetDocumentKeys property: The list of document keys that have been reset. The document key is the document's unique identifier for the data in the search index. The indexer will prioritize selectively re-ingesting these keys.
      Returns:
      the resetDocumentKeys value.

    • getResetDatasourceDocumentIds

      public List<String> getResetDatasourceDocumentIds()
      Get the resetDatasourceDocumentIds property: The list of datasource document ids that have been reset. The datasource document id is the unique identifier for the data in the datasource. The indexer will prioritize selectively re-ingesting these ids.
      Returns:
      the resetDatasourceDocumentIds value.

    • getResyncInitialTrackingState

      public String getResyncInitialTrackingState()
      Get the resyncInitialTrackingState property: Change tracking state used when indexing starts on selective options from the datasource.
      Returns:
      the resyncInitialTrackingState value.

    • getResyncFinalTrackingState

      public String getResyncFinalTrackingState()
      Get the resyncFinalTrackingState property: Change tracking state value when indexing finishes on selective options from the datasource.
      Returns:
      the resyncFinalTrackingState value.

    • toJson

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

    • fromJson

      public static IndexerCurrentState fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of IndexerCurrentState from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of IndexerCurrentState if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the IndexerCurrentState.