IndexerState interface

Package:

@azure/search-documents

Represents all of the state that defines and dictates the indexer's current execution.

Properties

allDocsFinalTrackingState	Change tracking state value when indexing finishes on all documents in the datasource. NOTE: This property will not be serialized. It can only be populated by the server.
allDocsInitialTrackingState	Change tracking state used when indexing starts on all documents in the datasource. NOTE: This property will not be serialized. It can only be populated by the server.
mode	The mode the indexer is running in. NOTE: This property will not be serialized. It can only be populated by the server.
resetDatasourceDocumentIds	The list of datasource document ids that have been reset. The datasource document id is the unique identifier for the data in the datasource. The indexer will prioritize selectively re-ingesting these ids. NOTE: This property will not be serialized. It can only be populated by the server.
resetDocsFinalTrackingState	Change tracking state value when indexing finishes on select, reset documents in the datasource. NOTE: This property will not be serialized. It can only be populated by the server.
resetDocsInitialTrackingState	Change tracking state used when indexing starts on select, reset documents in the datasource. NOTE: This property will not be serialized. It can only be populated by the server.
resetDocumentKeys	The list of document keys that have been reset. The document key is the document's unique identifier for the data in the search index. The indexer will prioritize selectively re-ingesting these keys. NOTE: This property will not be serialized. It can only be populated by the server.
resyncFinalTrackingState	Change tracking state value when indexing finishes on selective options from the datasource. NOTE: This property will not be serialized. It can only be populated by the server.
resyncInitialTrackingState	Change tracking state used when indexing starts on selective options from the datasource. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

allDocsFinalTrackingState

Change tracking state value when indexing finishes on all documents in the datasource. NOTE: This property will not be serialized. It can only be populated by the server.

allDocsFinalTrackingState?: string

Property Value

string

allDocsInitialTrackingState

Change tracking state used when indexing starts on all documents in the datasource. NOTE: This property will not be serialized. It can only be populated by the server.

allDocsInitialTrackingState?: string

Property Value

string

mode

The mode the indexer is running in. NOTE: This property will not be serialized. It can only be populated by the server.

mode?: string

Property Value

string

resetDatasourceDocumentIds

The list of datasource document ids that have been reset. The datasource document id is the unique identifier for the data in the datasource. The indexer will prioritize selectively re-ingesting these ids. NOTE: This property will not be serialized. It can only be populated by the server.

resetDatasourceDocumentIds?: string[]

Property Value

string[]

resetDocsFinalTrackingState

Change tracking state value when indexing finishes on select, reset documents in the datasource. NOTE: This property will not be serialized. It can only be populated by the server.

resetDocsFinalTrackingState?: string

Property Value

string

resetDocsInitialTrackingState

Change tracking state used when indexing starts on select, reset documents in the datasource. NOTE: This property will not be serialized. It can only be populated by the server.

resetDocsInitialTrackingState?: string

Property Value

string

resetDocumentKeys

The list of document keys that have been reset. The document key is the document's unique identifier for the data in the search index. The indexer will prioritize selectively re-ingesting these keys. NOTE: This property will not be serialized. It can only be populated by the server.

resetDocumentKeys?: string[]

Property Value

string[]

resyncFinalTrackingState

Change tracking state value when indexing finishes on selective options from the datasource. NOTE: This property will not be serialized. It can only be populated by the server.

resyncFinalTrackingState?: string

Property Value

string

resyncInitialTrackingState

Change tracking state used when indexing starts on selective options from the datasource. NOTE: This property will not be serialized. It can only be populated by the server.

resyncInitialTrackingState?: string

Property Value

string