IndexerCurrentState | @azure/search-documents

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

Hierarchy

IndexerCurrentState

Index

Properties

Optional allDocsFinalChangeTrackingState

allDocsFinalChangeTrackingState: undefined | string

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.

Optional allDocsInitialChangeTrackingState

allDocsInitialChangeTrackingState: undefined | string

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.

Optional mode

mode: IndexingMode

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

Optional resetDatasourceDocumentIds

resetDatasourceDocumentIds: string[]

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.

Optional resetDocsFinalChangeTrackingState

resetDocsFinalChangeTrackingState: undefined | string

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.

Optional resetDocsInitialChangeTrackingState

resetDocsInitialChangeTrackingState: undefined | string

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.

Optional resetDocumentKeys

resetDocumentKeys: string[]

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.