Indexers | @azure/search

Class representing a Indexers.

Hierarchy

Indexers

Index

Constructors

constructor

Methods

Constructors

constructor

new Indexers(client: SearchServiceClientContext): Indexers

- Defined in generated/service/operations/indexers.ts:19
Create a Indexers.

Parameters
- client: SearchServiceClientContext
  
  Reference to the service client.
Returns Indexers

Methods

create

create(indexer: Indexer, options?: Models.IndexersCreateOptionalParams): Promise<Models.IndexersCreateResponse>
create(indexer: Indexer, callback: coreHttp.ServiceCallback<Indexer>): void
create(indexer: Indexer, options: IndexersCreateOptionalParams, callback: coreHttp.ServiceCallback<Indexer>): void

- Defined in generated/service/operations/indexers.ts:203
Creates a new indexer.

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

Promise<Models.IndexersCreateResponse>
- Defined in generated/service/operations/indexers.ts:208
Parameters
- indexer: Indexer
  
  The definition of the indexer to create.
- callback: coreHttp.ServiceCallback<Indexer>
  
  The callback
Returns void
- Defined in generated/service/operations/indexers.ts:214
Parameters
- indexer: Indexer
  
  The definition of the indexer to create.
- options: IndexersCreateOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<Indexer>
  
  The callback
Returns void

createOrUpdate

createOrUpdate(indexerName: string, indexer: Indexer, options?: Models.IndexersCreateOrUpdateOptionalParams): Promise<Models.IndexersCreateOrUpdateResponse>
createOrUpdate(indexerName: string, indexer: Indexer, callback: coreHttp.ServiceCallback<Indexer>): void
createOrUpdate(indexerName: string, indexer: Indexer, options: IndexersCreateOrUpdateOptionalParams, callback: coreHttp.ServiceCallback<Indexer>): void

- Defined in generated/service/operations/indexers.ts:92
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: Indexer
  
  The definition of the indexer to create or update.
- Optional options: Models.IndexersCreateOrUpdateOptionalParams
Returns Promise<Models.IndexersCreateOrUpdateResponse>

Promise<Models.IndexersCreateOrUpdateResponse>
- Defined in generated/service/operations/indexers.ts:98
Parameters
- indexerName: string
  
  The name of the indexer to create or update.
- indexer: Indexer
  
  The definition of the indexer to create or update.
- callback: coreHttp.ServiceCallback<Indexer>
  
  The callback
Returns void
- Defined in generated/service/operations/indexers.ts:105
Parameters
- indexerName: string
  
  The name of the indexer to create or update.
- indexer: Indexer
  
  The definition of the indexer to create or update.
- options: IndexersCreateOrUpdateOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<Indexer>
  
  The callback
Returns void

deleteMethod

deleteMethod(indexerName: string, options?: Models.IndexersDeleteMethodOptionalParams): Promise<coreHttp.RestResponse>
deleteMethod(indexerName: string, callback: coreHttp.ServiceCallback<void>): void
deleteMethod(indexerName: string, options: IndexersDeleteMethodOptionalParams, callback: coreHttp.ServiceCallback<void>): void

- Defined in generated/service/operations/indexers.ts:123
Deletes an indexer.

Parameters
- indexerName: string
  
  The name of the indexer to delete.
- Optional options: Models.IndexersDeleteMethodOptionalParams
Returns Promise<coreHttp.RestResponse>

Promise<coreHttp.RestResponse>
- Defined in generated/service/operations/indexers.ts:128
Parameters
- indexerName: string
  
  The name of the indexer to delete.
- callback: coreHttp.ServiceCallback<void>
  
  The callback
Returns void
- Defined in generated/service/operations/indexers.ts:134
Parameters
- indexerName: string
  
  The name of the indexer to delete.
- options: IndexersDeleteMethodOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<void>
  
  The callback
Returns void

get

get(indexerName: string, options?: Models.IndexersGetOptionalParams): Promise<Models.IndexersGetResponse>
get(indexerName: string, callback: coreHttp.ServiceCallback<Indexer>): void
get(indexerName: string, options: IndexersGetOptionalParams, callback: coreHttp.ServiceCallback<Indexer>): void

- Defined in generated/service/operations/indexers.ts:151
Retrieves an indexer definition.

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

Promise<Models.IndexersGetResponse>
- Defined in generated/service/operations/indexers.ts:156
Parameters
- indexerName: string
  
  The name of the indexer to retrieve.
- callback: coreHttp.ServiceCallback<Indexer>
  
  The callback
Returns void
- Defined in generated/service/operations/indexers.ts:162
Parameters
- indexerName: string
  
  The name of the indexer to retrieve.
- options: IndexersGetOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<Indexer>
  
  The callback
Returns void

getStatus

getStatus(indexerName: string, options?: Models.IndexersGetStatusOptionalParams): Promise<Models.IndexersGetStatusResponse>
getStatus(indexerName: string, callback: coreHttp.ServiceCallback<IndexerExecutionInfo>): void
getStatus(indexerName: string, options: IndexersGetStatusOptionalParams, callback: coreHttp.ServiceCallback<IndexerExecutionInfo>): void

- Defined in generated/service/operations/indexers.ts:231
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: Models.IndexersGetStatusOptionalParams
Returns Promise<Models.IndexersGetStatusResponse>

Promise<Models.IndexersGetStatusResponse>
- Defined in generated/service/operations/indexers.ts:236
Parameters
- indexerName: string
  
  The name of the indexer for which to retrieve status.
- callback: coreHttp.ServiceCallback<IndexerExecutionInfo>
  
  The callback
Returns void
- Defined in generated/service/operations/indexers.ts:242
Parameters
- indexerName: string
  
  The name of the indexer for which to retrieve status.
- options: IndexersGetStatusOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<IndexerExecutionInfo>
  
  The callback
Returns void

list

list(options?: Models.IndexersListOptionalParams): Promise<Models.IndexersListResponse>
list(callback: coreHttp.ServiceCallback<ListIndexersResult>): void
list(options: IndexersListOptionalParams, callback: coreHttp.ServiceCallback<ListIndexersResult>): void

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

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

Promise<Models.IndexersListResponse>
- Defined in generated/service/operations/indexers.ts:182
Parameters
- callback: coreHttp.ServiceCallback<ListIndexersResult>
  
  The callback
Returns void
- Defined in generated/service/operations/indexers.ts:187
Parameters
- options: IndexersListOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<ListIndexersResult>
  
  The callback
Returns void

reset

reset(indexerName: string, options?: Models.IndexersResetOptionalParams): Promise<coreHttp.RestResponse>
reset(indexerName: string, callback: coreHttp.ServiceCallback<void>): void
reset(indexerName: string, options: IndexersResetOptionalParams, callback: coreHttp.ServiceCallback<void>): void

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

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

Promise<coreHttp.RestResponse>
- Defined in generated/service/operations/indexers.ts:40
Parameters
- indexerName: string
  
  The name of the indexer to reset.
- callback: coreHttp.ServiceCallback<void>
  
  The callback
Returns void
- Defined in generated/service/operations/indexers.ts:46
Parameters
- indexerName: string
  
  The name of the indexer to reset.
- options: IndexersResetOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<void>
  
  The callback
Returns void

run

run(indexerName: string, options?: Models.IndexersRunOptionalParams): Promise<coreHttp.RestResponse>
run(indexerName: string, callback: coreHttp.ServiceCallback<void>): void
run(indexerName: string, options: IndexersRunOptionalParams, callback: coreHttp.ServiceCallback<void>): void

- Defined in generated/service/operations/indexers.ts:63
Runs an indexer on-demand.

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

Promise<coreHttp.RestResponse>
- Defined in generated/service/operations/indexers.ts:68
Parameters
- indexerName: string
  
  The name of the indexer to run.
- callback: coreHttp.ServiceCallback<void>
  
  The callback
Returns void
- Defined in generated/service/operations/indexers.ts:74
Parameters
- indexerName: string
  
  The name of the indexer to run.
- options: IndexersRunOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<void>
  
  The callback
Returns void

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: SearchServiceClientContext

Returns Indexers

Methods

create

Parameters

indexer: Indexer

Optional options: Models.IndexersCreateOptionalParams

Returns Promise<Models.IndexersCreateResponse>

Parameters

indexer: Indexer

callback: coreHttp.ServiceCallback<Indexer>

Returns void

Parameters

indexer: Indexer

options: IndexersCreateOptionalParams

callback: coreHttp.ServiceCallback<Indexer>

Returns void

createOrUpdate

Parameters

indexerName: string

indexer: Indexer

Optional options: Models.IndexersCreateOrUpdateOptionalParams

Returns Promise<Models.IndexersCreateOrUpdateResponse>

Parameters

indexerName: string

indexer: Indexer

callback: coreHttp.ServiceCallback<Indexer>

Returns void

Parameters

indexerName: string

indexer: Indexer

options: IndexersCreateOrUpdateOptionalParams

callback: coreHttp.ServiceCallback<Indexer>

Returns void

deleteMethod

Parameters

indexerName: string

Optional options: Models.IndexersDeleteMethodOptionalParams

Returns Promise<coreHttp.RestResponse>

Parameters

indexerName: string

callback: coreHttp.ServiceCallback<void>

Returns void

Parameters

indexerName: string

options: IndexersDeleteMethodOptionalParams

callback: coreHttp.ServiceCallback<void>

Returns void

get

Parameters

indexerName: string

Optional options: Models.IndexersGetOptionalParams

Returns Promise<Models.IndexersGetResponse>

Parameters

indexerName: string

callback: coreHttp.ServiceCallback<Indexer>

Returns void

Parameters

indexerName: string

options: IndexersGetOptionalParams

callback: coreHttp.ServiceCallback<Indexer>

Returns void

getStatus

Parameters

indexerName: string

Optional options: Models.IndexersGetStatusOptionalParams

Returns Promise<Models.IndexersGetStatusResponse>

Parameters

indexerName: string

callback: coreHttp.ServiceCallback<IndexerExecutionInfo>

Returns void

Parameters

indexerName: string