SearchIndexerStatus Class

  • java.lang.Object
    • com.azure.search.documents.indexes.models.SearchIndexerStatus

Implements

public final class SearchIndexerStatus
implements JsonSerializable<SearchIndexerStatus>

Represents the current status and execution history of an indexer.

Constructor Summary

Constructor Description
SearchIndexerStatus(IndexerStatus status, List<IndexerExecutionResult> executionHistory, SearchIndexerLimits limits)

Creates an instance of SearchIndexerStatus class.

Method Summary

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

Reads an instance of SearchIndexerStatus from the JsonReader.

List<IndexerExecutionResult> getExecutionHistory()

Get the executionHistory property: History of the recent indexer executions, sorted in reverse chronological order.

IndexerExecutionResult getLastResult()

Get the lastResult property: The result of the most recent or an in-progress indexer execution.

SearchIndexerLimits getLimits()

Get the limits property: The execution limits for the indexer.

IndexerStatus getStatus()

Get the status property: Overall indexer status.

JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

Constructor Details

SearchIndexerStatus

public SearchIndexerStatus(IndexerStatus status, List executionHistory, SearchIndexerLimits limits)

Creates an instance of SearchIndexerStatus class.

Parameters:

status - the status value to set.
executionHistory - the executionHistory value to set.
limits - the limits value to set.

Method Details

fromJson

public static SearchIndexerStatus fromJson(JsonReader jsonReader)

Reads an instance of SearchIndexerStatus from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of SearchIndexerStatus 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.

getExecutionHistory

public List getExecutionHistory()

Get the executionHistory property: History of the recent indexer executions, sorted in reverse chronological order.

Returns:

the executionHistory value.

getLastResult

public IndexerExecutionResult getLastResult()

Get the lastResult property: The result of the most recent or an in-progress indexer execution.

Returns:

the lastResult value.

getLimits

public SearchIndexerLimits getLimits()

Get the limits property: The execution limits for the indexer.

Returns:

the limits value.

getStatus

public IndexerStatus getStatus()

Get the status property: Overall indexer status.

Returns:

the status value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to