Indexes | @azure/search

Class representing a Indexes.

Hierarchy

Indexes

Index

Constructors

constructor

Methods

Constructors

constructor

new Indexes(client: SearchServiceClientContext): Indexes

- Defined in generated/service/operations/indexes.ts:19
Create a Indexes.

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

Methods

analyze

analyze(indexName: string, request: AnalyzeRequest, options?: Models.IndexesAnalyzeOptionalParams): Promise<Models.IndexesAnalyzeResponse>
analyze(indexName: string, request: AnalyzeRequest, callback: coreHttp.ServiceCallback<AnalyzeResult>): void
analyze(indexName: string, request: AnalyzeRequest, options: IndexesAnalyzeOptionalParams, callback: coreHttp.ServiceCallback<AnalyzeResult>): void

- Defined in generated/service/operations/indexes.ts:204
Shows how an analyzer breaks text into tokens.

Parameters
- indexName: string
  
  The name of the index for which to test an analyzer.
- request: AnalyzeRequest
  
  The text and analyzer or analysis components to test.
- Optional options: Models.IndexesAnalyzeOptionalParams
Returns Promise<Models.IndexesAnalyzeResponse>

Promise<Models.IndexesAnalyzeResponse>
- Defined in generated/service/operations/indexes.ts:210
Parameters
- indexName: string
  
  The name of the index for which to test an analyzer.
- request: AnalyzeRequest
  
  The text and analyzer or analysis components to test.
- callback: coreHttp.ServiceCallback<AnalyzeResult>
  
  The callback
Returns void
- Defined in generated/service/operations/indexes.ts:217
Parameters
- indexName: string
  
  The name of the index for which to test an analyzer.
- request: AnalyzeRequest
  
  The text and analyzer or analysis components to test.
- options: IndexesAnalyzeOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<AnalyzeResult>
  
  The callback
Returns void

create

create(index: Index, options?: Models.IndexesCreateOptionalParams): Promise<Models.IndexesCreateResponse>
create(index: Index, callback: coreHttp.ServiceCallback<Index>): void
create(index: Index, options: IndexesCreateOptionalParams, callback: coreHttp.ServiceCallback<Index>): void

- Defined in generated/service/operations/indexes.ts:35
Creates a new search index.

Parameters
- index: Index
  
  The definition of the index to create.
- Optional options: Models.IndexesCreateOptionalParams
Returns Promise<Models.IndexesCreateResponse>

Promise<Models.IndexesCreateResponse>
- Defined in generated/service/operations/indexes.ts:40
Parameters
- index: Index
  
  The definition of the index to create.
- callback: coreHttp.ServiceCallback<Index>
  
  The callback
Returns void
- Defined in generated/service/operations/indexes.ts:46
Parameters
- index: Index
  
  The definition of the index to create.
- options: IndexesCreateOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<Index>
  
  The callback
Returns void

createOrUpdate

createOrUpdate(indexName: string, index: Index, options?: Models.IndexesCreateOrUpdateOptionalParams): Promise<Models.IndexesCreateOrUpdateResponse>
createOrUpdate(indexName: string, index: Index, callback: coreHttp.ServiceCallback<Index>): void
createOrUpdate(indexName: string, index: Index, options: IndexesCreateOrUpdateOptionalParams, callback: coreHttp.ServiceCallback<Index>): void

- Defined in generated/service/operations/indexes.ts:88
Creates a new search index or updates an index if it already exists.

Parameters
- indexName: string
  
  The definition of the index to create or update.
- index: Index
  
  The definition of the index to create or update.
- Optional options: Models.IndexesCreateOrUpdateOptionalParams
Returns Promise<Models.IndexesCreateOrUpdateResponse>

Promise<Models.IndexesCreateOrUpdateResponse>
- Defined in generated/service/operations/indexes.ts:94
Parameters
- indexName: string
  
  The definition of the index to create or update.
- index: Index
  
  The definition of the index to create or update.
- callback: coreHttp.ServiceCallback<Index>
  
  The callback
Returns void
- Defined in generated/service/operations/indexes.ts:101
Parameters
- indexName: string
  
  The definition of the index to create or update.
- index: Index
  
  The definition of the index to create or update.
- options: IndexesCreateOrUpdateOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<Index>
  
  The callback
Returns void

deleteMethod

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

- Defined in generated/service/operations/indexes.ts:119
Deletes a search index and all the documents it contains.

Parameters
- indexName: string
  
  The name of the index to delete.
- Optional options: Models.IndexesDeleteMethodOptionalParams
Returns Promise<coreHttp.RestResponse>

Promise<coreHttp.RestResponse>
- Defined in generated/service/operations/indexes.ts:124
Parameters
- indexName: string
  
  The name of the index to delete.
- callback: coreHttp.ServiceCallback<void>
  
  The callback
Returns void
- Defined in generated/service/operations/indexes.ts:130
Parameters
- indexName: string
  
  The name of the index to delete.
- options: IndexesDeleteMethodOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<void>
  
  The callback
Returns void

get

get(indexName: string, options?: Models.IndexesGetOptionalParams): Promise<Models.IndexesGetResponse>
get(indexName: string, callback: coreHttp.ServiceCallback<Index>): void
get(indexName: string, options: IndexesGetOptionalParams, callback: coreHttp.ServiceCallback<Index>): void

- Defined in generated/service/operations/indexes.ts:147
Retrieves an index definition.

Parameters
- indexName: string
  
  The name of the index to retrieve.
- Optional options: Models.IndexesGetOptionalParams
Returns Promise<Models.IndexesGetResponse>

Promise<Models.IndexesGetResponse>
- Defined in generated/service/operations/indexes.ts:152
Parameters
- indexName: string
  
  The name of the index to retrieve.
- callback: coreHttp.ServiceCallback<Index>
  
  The callback
Returns void
- Defined in generated/service/operations/indexes.ts:158
Parameters
- indexName: string
  
  The name of the index to retrieve.
- options: IndexesGetOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<Index>
  
  The callback
Returns void

getStatistics

getStatistics(indexName: string, options?: Models.IndexesGetStatisticsOptionalParams): Promise<Models.IndexesGetStatisticsResponse>
getStatistics(indexName: string, callback: coreHttp.ServiceCallback<GetIndexStatisticsResult>): void
getStatistics(indexName: string, options: IndexesGetStatisticsOptionalParams, callback: coreHttp.ServiceCallback<GetIndexStatisticsResult>): void

- Defined in generated/service/operations/indexes.ts:175
Returns statistics for the given index, including a document count and storage usage.

Parameters
- indexName: string
  
  The name of the index for which to retrieve statistics.
- Optional options: Models.IndexesGetStatisticsOptionalParams
Returns Promise<Models.IndexesGetStatisticsResponse>

Promise<Models.IndexesGetStatisticsResponse>
- Defined in generated/service/operations/indexes.ts:180
Parameters
- indexName: string
  
  The name of the index for which to retrieve statistics.
- callback: coreHttp.ServiceCallback<GetIndexStatisticsResult>
  
  The callback
Returns void
- Defined in generated/service/operations/indexes.ts:186
Parameters
- indexName: string
  
  The name of the index for which to retrieve statistics.
- options: IndexesGetStatisticsOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<GetIndexStatisticsResult>
  
  The callback
Returns void

list

list(options?: Models.IndexesListOptionalParams): Promise<Models.IndexesListResponse>
list(callback: coreHttp.ServiceCallback<ListIndexesResult>): void
list(options: IndexesListOptionalParams, callback: coreHttp.ServiceCallback<ListIndexesResult>): void

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

Parameters
- Optional options: Models.IndexesListOptionalParams
Returns Promise<Models.IndexesListResponse>

Promise<Models.IndexesListResponse>
- Defined in generated/service/operations/indexes.ts:66
Parameters
- callback: coreHttp.ServiceCallback<ListIndexesResult>
  
  The callback
Returns void
- Defined in generated/service/operations/indexes.ts:71
Parameters
- options: IndexesListOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<ListIndexesResult>
  
  The callback
Returns void

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: SearchServiceClientContext

Returns Indexes

Methods

analyze

Parameters

indexName: string

request: AnalyzeRequest

Optional options: Models.IndexesAnalyzeOptionalParams

Returns Promise<Models.IndexesAnalyzeResponse>

Parameters

indexName: string

request: AnalyzeRequest

callback: coreHttp.ServiceCallback<AnalyzeResult>

Returns void

Parameters

indexName: string

request: AnalyzeRequest

options: IndexesAnalyzeOptionalParams

callback: coreHttp.ServiceCallback<AnalyzeResult>

Returns void

create

Parameters

index: Index

Optional options: Models.IndexesCreateOptionalParams

Returns Promise<Models.IndexesCreateResponse>

Parameters

index: Index

callback: coreHttp.ServiceCallback<Index>

Returns void

Parameters

index: Index

options: IndexesCreateOptionalParams

callback: coreHttp.ServiceCallback<Index>

Returns void

createOrUpdate

Parameters

indexName: string

index: Index

Optional options: Models.IndexesCreateOrUpdateOptionalParams

Returns Promise<Models.IndexesCreateOrUpdateResponse>

Parameters

indexName: string

index: Index

callback: coreHttp.ServiceCallback<Index>

Returns void

Parameters

indexName: string

index: Index

options: IndexesCreateOrUpdateOptionalParams

callback: coreHttp.ServiceCallback<Index>

Returns void

deleteMethod

Parameters

indexName: string

Optional options: Models.IndexesDeleteMethodOptionalParams

Returns Promise<coreHttp.RestResponse>

Parameters

indexName: string

callback: coreHttp.ServiceCallback<void>

Returns void

Parameters

indexName: string

options: IndexesDeleteMethodOptionalParams

callback: coreHttp.ServiceCallback<void>

Returns void

get

Parameters

indexName: string

Optional options: Models.IndexesGetOptionalParams

Returns Promise<Models.IndexesGetResponse>

Parameters

indexName: string

callback: coreHttp.ServiceCallback<Index>