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

Class IndexingSchedule

java.lang.Object
com.azure.search.documents.indexes.models.IndexingSchedule
All Implemented Interfaces:
com.azure.json.JsonSerializable<IndexingSchedule>
public final class IndexingSchedule extends Object implements com.azure.json.JsonSerializable<IndexingSchedule>
Represents a schedule for indexer execution.

  • Constructor Details

    • IndexingSchedule

      public IndexingSchedule(Duration interval)
      Creates an instance of IndexingSchedule class.
      Parameters:
      interval - the interval value to set.

  • Method Details

    • getInterval

      public Duration getInterval()
      Get the interval property: The interval of time between indexer executions.
      Returns:
      the interval value.

    • getStartTime

      public OffsetDateTime getStartTime()
      Get the startTime property: The time when an indexer should start running.
      Returns:
      the startTime value.

    • setStartTime

      public IndexingSchedule setStartTime(OffsetDateTime startTime)
      Set the startTime property: The time when an indexer should start running.
      Parameters:
      startTime - the startTime value to set.
      Returns:
      the IndexingSchedule 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<IndexingSchedule>
      Throws:
      IOException

    • fromJson

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