Package version:

Interface SearchIndexerStatus

Represents the current status and execution history of an indexer.

interface SearchIndexerStatus {
    currentState?: IndexerState;
    executionHistory: IndexerExecutionResult[];
    lastResult?: IndexerExecutionResult;
    limits: SearchIndexerLimits;
    name: string;
    runtime: IndexerRuntime;
    status: IndexerStatus;
}

Properties

currentState? executionHistory lastResult? limits name runtime status

Properties

Optional ReadonlycurrentState

currentState?: IndexerState

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.

ReadonlyexecutionHistory

executionHistory: IndexerExecutionResult[]

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.

Optional ReadonlylastResult

lastResult?: IndexerExecutionResult

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.

Readonlylimits

limits: SearchIndexerLimits

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

Readonlyname

name: string

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

Readonlyruntime

runtime: IndexerRuntime

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.

Readonlystatus

status: IndexerStatus

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

Settings

Member Visibility