Interface Indexers

Package version

Interface representing a Indexers.

Hierarchy

Indexers

Implemented by

IndexersImpl

Index

Methods

Methods

create

create(indexer: SearchIndexer, options?: IndexersCreateOptionalParams): Promise<IndexersCreateResponse>

- Defined in generated/service/operationsInterfaces/indexers.ts:92
Creates a new indexer.

Parameters
- indexer: SearchIndexer
  
  The definition of the indexer to create.
- Optional options: IndexersCreateOptionalParams
  
  The options parameters.
Returns Promise<IndexersCreateResponse>

createOrUpdate

createOrUpdate(indexerName: string, indexer: SearchIndexer, options?: IndexersCreateOrUpdateOptionalParams): Promise<IndexersCreateOrUpdateResponse>

- Defined in generated/service/operationsInterfaces/indexers.ts:59
Creates a new indexer or updates an indexer if it already exists.

Parameters
- indexerName: string
  
  The name of the indexer to create or update.
- indexer: SearchIndexer
  
  The definition of the indexer to create or update.
- Optional options: IndexersCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<IndexersCreateOrUpdateResponse>

delete

delete(indexerName: string, options?: IndexersDeleteOptionalParams): Promise<void>

- Defined in generated/service/operationsInterfaces/indexers.ts:69
Deletes an indexer.

Parameters
- indexerName: string
  
  The name of the indexer to delete.
- Optional options: IndexersDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

get(indexerName: string, options?: IndexersGetOptionalParams): Promise<IndexersGetResponse>

- Defined in generated/service/operationsInterfaces/indexers.ts:78
Retrieves an indexer definition.

Parameters
- indexerName: string
  
  The name of the indexer to retrieve.
- Optional options: IndexersGetOptionalParams
  
  The options parameters.
Returns Promise<IndexersGetResponse>

getStatus

getStatus(indexerName: string, options?: IndexersGetStatusOptionalParams): Promise<IndexersGetStatusResponse>

- Defined in generated/service/operationsInterfaces/indexers.ts:101
Returns the current status and execution history of an indexer.

Parameters
- indexerName: string
  
  The name of the indexer for which to retrieve status.
- Optional options: IndexersGetStatusOptionalParams
  
  The options parameters.
Returns Promise<IndexersGetStatusResponse>

list

list(options?: IndexersListOptionalParams): Promise<IndexersListResponse>

- Defined in generated/service/operationsInterfaces/indexers.ts:86
Lists all indexers available for a search service.

Parameters
- Optional options: IndexersListOptionalParams
  
  The options parameters.
Returns Promise<IndexersListResponse>

reset

reset(indexerName: string, options?: IndexersResetOptionalParams): Promise<void>

- Defined in generated/service/operationsInterfaces/indexers.ts:34
Resets the change tracking state associated with an indexer.

Parameters
- indexerName: string
  
  The name of the indexer to reset.
- Optional options: IndexersResetOptionalParams
  
  The options parameters.
Returns Promise<void>

resetDocs

resetDocs(indexerName: string, options?: IndexersResetDocsOptionalParams): Promise<void>

- Defined in generated/service/operationsInterfaces/indexers.ts:43
Resets specific documents in the datasource to be selectively re-ingested by the indexer.

Parameters
- indexerName: string
  
  The name of the indexer to reset documents for.
- Optional options: IndexersResetDocsOptionalParams
  
  The options parameters.
Returns Promise<void>

run

run(indexerName: string, options?: IndexersRunOptionalParams): Promise<void>

- Defined in generated/service/operationsInterfaces/indexers.ts:52
Runs an indexer on-demand.

Parameters
- indexerName: string
  
  The name of the indexer to run.
- Optional options: IndexersRunOptionalParams
  
  The options parameters.
Returns Promise<void>

Generated using TypeDoc