Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Indexes

Package version

Class representing a Indexes.

Hierarchy

  • Indexes

Index

Constructors

Methods

Constructors

constructor

Methods

analyze

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

  • 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: coreHttp.RequestOptionsBase

    Returns Promise<Models.IndexesAnalyzeResponse>

    Promise<Models.IndexesAnalyzeResponse>

  • 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

  • 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: coreHttp.RequestOptionsBase

      The optional parameters

    • callback: coreHttp.ServiceCallback<AnalyzeResult>

      The callback

    Returns void

create

  • create(index: SearchIndex, options?: coreHttp.RequestOptionsBase): Promise<Models.IndexesCreateResponse>
  • create(index: SearchIndex, callback: coreHttp.ServiceCallback<SearchIndex>): void
  • create(index: SearchIndex, options: coreHttp.RequestOptionsBase, callback: coreHttp.ServiceCallback<SearchIndex>): void

createOrUpdate

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

  • Deletes a search index and all the documents it contains. This operation is permanent, with no recovery option. Make sure you have a master copy of your index definition, data ingestion code, and a backup of the primary data source in case you need to re-build the index.

    Parameters

    • indexName: string

      The name of the index to delete.

    • Optional options: Models.IndexesDeleteMethodOptionalParams

    Returns Promise<coreHttp.RestResponse>

    Promise<coreHttp.RestResponse>

  • Parameters

    • indexName: string

      The name of the index to delete.

    • callback: coreHttp.ServiceCallback<void>

      The callback

    Returns void

  • 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?: coreHttp.RequestOptionsBase): Promise<Models.IndexesGetResponse>
  • get(indexName: string, callback: coreHttp.ServiceCallback<SearchIndex>): void
  • get(indexName: string, options: coreHttp.RequestOptionsBase, callback: coreHttp.ServiceCallback<SearchIndex>): void

getStatistics

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

  • 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: coreHttp.RequestOptionsBase

    Returns Promise<Models.IndexesGetStatisticsResponse>

    Promise<Models.IndexesGetStatisticsResponse>

  • Parameters

    • indexName: string

      The name of the index for which to retrieve statistics.

    • callback: coreHttp.ServiceCallback<GetIndexStatisticsResult>

      The callback

    Returns void

  • Parameters

    • indexName: string

      The name of the index for which to retrieve statistics.

    • options: coreHttp.RequestOptionsBase

      The optional parameters

    • callback: coreHttp.ServiceCallback<GetIndexStatisticsResult>

      The callback

    Returns void

list

Generated using TypeDoc