SearchIndexerStatus Class

Package:
com.azure.search.documents.indexes.models
Maven Artifact:
com.azure:azure-search-documents:12.0.0
  • java.lang.Object
    • com.azure.search.documents.indexes.models.SearchIndexerStatus

Implements

JsonSerializable<SearchIndexerStatus>

public final class SearchIndexerStatus
implements JsonSerializable<SearchIndexerStatus>

Represents the current status and execution history of an indexer.

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.
String getName()

Get the name property: The name of the indexer.
IndexerStatus getStatus()

Get the status property: Overall indexer status.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

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<IndexerExecutionResult> 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.

getName

public String getName()

Get the name property: The name of the indexer.

Returns:

the name 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