IndexerExecutionResult interface

Package:

@azure/search-documents

Represents the result of an individual indexer execution.

Properties

endTime	The end time of this indexer execution, if the execution has already completed. NOTE: This property will not be serialized. It can only be populated by the server.
errorMessage	The error message indicating the top-level error, if any. NOTE: This property will not be serialized. It can only be populated by the server.
errors	The item-level indexing errors. NOTE: This property will not be serialized. It can only be populated by the server.
failedItemCount	The number of items that failed to be indexed during this indexer execution. NOTE: This property will not be serialized. It can only be populated by the server.
finalTrackingState	Change tracking state with which an indexer execution finished. NOTE: This property will not be serialized. It can only be populated by the server.
initialTrackingState	Change tracking state with which an indexer execution started. NOTE: This property will not be serialized. It can only be populated by the server.
itemCount	The number of items that were processed during this indexer execution. This includes both successfully processed items and items where indexing was attempted but failed. NOTE: This property will not be serialized. It can only be populated by the server.
startTime	The start time of this indexer execution. NOTE: This property will not be serialized. It can only be populated by the server.
status	The outcome of this indexer execution. NOTE: This property will not be serialized. It can only be populated by the server.
warnings	The item-level indexing warnings. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

endTime

The end time of this indexer execution, if the execution has already completed. NOTE: This property will not be serialized. It can only be populated by the server.

endTime?: Date

Property Value

Date

errorMessage

The error message indicating the top-level error, if any. NOTE: This property will not be serialized. It can only be populated by the server.

errorMessage?: string

Property Value

string

errors

The item-level indexing errors. NOTE: This property will not be serialized. It can only be populated by the server.

errors: SearchIndexerError[]

Property Value

SearchIndexerError[]

failedItemCount

The number of items that failed to be indexed during this indexer execution. NOTE: This property will not be serialized. It can only be populated by the server.

failedItemCount: number

Property Value

number

finalTrackingState

Change tracking state with which an indexer execution finished. NOTE: This property will not be serialized. It can only be populated by the server.

finalTrackingState?: string

Property Value

string

initialTrackingState

Change tracking state with which an indexer execution started. NOTE: This property will not be serialized. It can only be populated by the server.

initialTrackingState?: string

Property Value

string

itemCount

The number of items that were processed during this indexer execution. This includes both successfully processed items and items where indexing was attempted but failed. NOTE: This property will not be serialized. It can only be populated by the server.

itemCount: number

Property Value

number

startTime

The start time of this indexer execution. NOTE: This property will not be serialized. It can only be populated by the server.

startTime?: Date

Property Value

Date

status

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

status: IndexerExecutionStatus

Property Value

IndexerExecutionStatus

warnings

The item-level indexing warnings. NOTE: This property will not be serialized. It can only be populated by the server.

warnings: SearchIndexerWarning[]

Property Value

SearchIndexerWarning[]