SearchIndexerStatus interface

Package:

@azure/search-documents

Represents the current status and execution history of an indexer.

Properties

currentState	All of the state that defines and dictates the indexer's current execution. NOTE: This property will not be serialized. It can only be populated by the server.
executionHistory	History of the recent indexer executions, sorted in reverse chronological order. NOTE: This property will not be serialized. It can only be populated by the server.
lastResult	The result of the most recent or an in-progress indexer execution. NOTE: This property will not be serialized. It can only be populated by the server.
limits	The execution limits for the indexer. NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the indexer. NOTE: This property will not be serialized. It can only be populated by the server.
runtime	Snapshot of the indexer’s cumulative runtime consumption for the service over the current UTC period. NOTE: This property will not be serialized. It can only be populated by the server.
status	Overall indexer status. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

currentState

All of the state that defines and dictates the indexer's current execution. NOTE: This property will not be serialized. It can only be populated by the server.

currentState?: IndexerState

Property Value

IndexerState

executionHistory

History of the recent indexer executions, sorted in reverse chronological order. NOTE: This property will not be serialized. It can only be populated by the server.

executionHistory: IndexerExecutionResult[]

Property Value

IndexerExecutionResult[]

lastResult

The result of the most recent or an in-progress indexer execution. NOTE: This property will not be serialized. It can only be populated by the server.

lastResult?: IndexerExecutionResult

Property Value

IndexerExecutionResult

limits

The execution limits for the indexer. NOTE: This property will not be serialized. It can only be populated by the server.

limits: SearchIndexerLimits

Property Value

SearchIndexerLimits

name

The name of the indexer. NOTE: This property will not be serialized. It can only be populated by the server.

name: string

Property Value

string

runtime

Snapshot of the indexer’s cumulative runtime consumption for the service over the current UTC period. NOTE: This property will not be serialized. It can only be populated by the server.

runtime: IndexerRuntime

Property Value

IndexerRuntime

status

Overall indexer status. NOTE: This property will not be serialized. It can only be populated by the server.

status: IndexerStatus

Property Value

IndexerStatus