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

Class SearchIndexerStatus

java.lang.Object

com.azure.search.documents.indexes.models.SearchIndexerStatus

All Implemented Interfaces:

com.azure.json.JsonSerializable<SearchIndexerStatus>

public final class SearchIndexerStatus
extends Object
implements com.azure.json.JsonSerializable<SearchIndexerStatus>

Represents the current status and execution history of an indexer.

Constructor Summary

Constructors

Constructor	Description
SearchIndexerStatus(IndexerStatus status, List<IndexerExecutionResult> executionHistory, SearchIndexerLimits limits)	Creates an instance of SearchIndexerStatus class.

Method Summary

Modifier and Type	Method	Description
static SearchIndexerStatus	fromJson(com.azure.json.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.
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.azure.json.JsonSerializable

toJson, toJson, toJsonBytes, toJsonString

Constructor Details

SearchIndexerStatus

public SearchIndexerStatus(IndexerStatus status,
 List<IndexerExecutionResult> 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

getStatus

public IndexerStatus getStatus()

Get the status property: Overall indexer status.

Returns:

the status 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.

getExecutionHistory

public List<IndexerExecutionResult> getExecutionHistory()

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

Returns:

the executionHistory value.

getLimits

public SearchIndexerLimits getLimits()

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

Returns:

the limits value.

toJson

public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter)
                                 throws IOException

Specified by:

toJson in interface com.azure.json.JsonSerializable<SearchIndexerStatus>

Throws:

IOException

fromJson

public static SearchIndexerStatus fromJson(com.azure.json.JsonReader jsonReader)
                                    throws IOException

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:

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

IOException - If an error occurs while reading the SearchIndexerStatus.