Share via

IndexingSchedule Class

  • Reference
Package:
com.azure.search.documents.indexes.models
Maven Artifact:
com.azure:azure-search-documents:11.7.3
  • java.lang.Object
    • com.azure.search.documents.indexes.models.IndexingSchedule

Implements

JsonSerializable<IndexingSchedule>

public final class IndexingSchedule
implements JsonSerializable<IndexingSchedule>

Represents a schedule for indexer execution.

Constructor Summary

Constructor Description
IndexingSchedule(Duration interval)

Creates an instance of IndexingSchedule class.

Method Summary

Modifier and Type Method and Description
static IndexingSchedule fromJson(JsonReader jsonReader)

Reads an instance of IndexingSchedule from the JsonReader.
Duration getInterval()

Get the interval property: The interval of time between indexer executions.
OffsetDateTime getStartTime()

Get the startTime property: The time when an indexer should start running.
IndexingSchedule setStartTime(OffsetDateTime startTime)

Set the startTime property: The time when an indexer should start running.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

IndexingSchedule

public IndexingSchedule(Duration interval)

Creates an instance of IndexingSchedule class.

Parameters:

interval - the interval value to set.

Method Details

fromJson

public static IndexingSchedule fromJson(JsonReader jsonReader)

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:

IOException

 - If the deserialized JSON object was missing any required properties.

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 JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to