public final class SearchServiceAsyncClient extends Object
Modifier and Type | Method and Description |
---|---|
PagedFlux<TokenInfo> |
analyzeText(String indexName,
AnalyzeRequest analyzeRequest)
Shows how an analyzer breaks text into tokens.
|
PagedFlux<TokenInfo> |
analyzeText(String indexName,
AnalyzeRequest analyzeRequest,
RequestOptions requestOptions)
Shows how an analyzer breaks text into tokens.
|
Mono<DataSource> |
createDataSource(DataSource dataSource)
Creates a new Azure Cognitive Search data source
|
Mono<Response<DataSource>> |
createDataSourceWithResponse(DataSource dataSource,
RequestOptions requestOptions)
Creates a new Azure Cognitive Search data source
|
Mono<Index> |
createIndex(Index index)
Creates a new Azure Cognitive Search index.
|
Mono<Indexer> |
createIndexer(Indexer indexer)
Creates a new Azure Cognitive Search indexer.
|
Mono<Response<Indexer>> |
createIndexerWithResponse(Indexer indexer,
RequestOptions requestOptions)
Creates a new Azure Cognitive Search indexer.
|
Mono<Response<Index>> |
createIndexWithResponse(Index index,
RequestOptions requestOptions)
Creates a new Azure Cognitive Search index.
|
Mono<DataSource> |
createOrUpdateDataSource(DataSource dataSource)
Creates a new Azure Cognitive Search data source or updates a data source if it already exists.
|
Mono<Response<DataSource>> |
createOrUpdateDataSourceWithResponse(DataSource dataSource,
MatchConditions accessCondition,
RequestOptions requestOptions)
Creates a new Azure Cognitive Search data source or updates a data source if it already exists.
|
Mono<Index> |
createOrUpdateIndex(Index index)
Creates a new Azure Cognitive Search index or updates an index if it already exists.
|
Mono<Indexer> |
createOrUpdateIndexer(Indexer indexer)
Creates a new Azure Cognitive Search indexer or updates an indexer if it already exists.
|
Mono<Response<Indexer>> |
createOrUpdateIndexerWithResponse(Indexer indexer,
MatchConditions accessCondition,
RequestOptions requestOptions)
Creates a new Azure Cognitive Search indexer or updates an indexer if it already exists.
|
Mono<Response<Index>> |
createOrUpdateIndexWithResponse(Index index,
boolean allowIndexDowntime,
MatchConditions accessCondition,
RequestOptions requestOptions)
Creates a new Azure Cognitive Search index or updates an index if it already exists.
|
Mono<Skillset> |
createOrUpdateSkillset(Skillset skillset)
Creates a new Azure Cognitive Search skillset or updates a skillset if it already exists.
|
Mono<Response<Skillset>> |
createOrUpdateSkillsetWithResponse(Skillset skillset,
MatchConditions accessCondition,
RequestOptions requestOptions)
Creates a new Azure Cognitive Search skillset or updates a skillset if it already exists.
|
Mono<SynonymMap> |
createOrUpdateSynonymMap(SynonymMap synonymMap)
Creates a new Azure Cognitive Search synonym map or updates a synonym map if it already exists.
|
Mono<Response<SynonymMap>> |
createOrUpdateSynonymMapWithResponse(SynonymMap synonymMap,
MatchConditions accessCondition,
RequestOptions requestOptions)
Creates a new Azure Cognitive Search synonym map or updates a synonym map if it already exists.
|
Mono<Skillset> |
createSkillset(Skillset skillset)
Creates a new skillset in an Azure Cognitive Search service.
|
Mono<Response<Skillset>> |
createSkillsetWithResponse(Skillset skillset,
RequestOptions requestOptions)
Creates a new skillset in an Azure Cognitive Search service.
|
Mono<SynonymMap> |
createSynonymMap(SynonymMap synonymMap)
Creates a new Azure Cognitive Search synonym map.
|
Mono<Response<SynonymMap>> |
createSynonymMapWithResponse(SynonymMap synonymMap,
RequestOptions requestOptions)
Creates a new Azure Cognitive Search synonym map.
|
Mono<Void> |
deleteDataSource(String dataSourceName)
Delete a DataSource
|
Mono<Response<Void>> |
deleteDataSourceWithResponse(String dataSourceName,
MatchConditions accessCondition,
RequestOptions requestOptions)
Deletes an Azure Cognitive Search data source.
|
Mono<Void> |
deleteIndex(String indexName)
Deletes an Azure Cognitive Search index and all the documents it contains.
|
Mono<Void> |
deleteIndexer(String indexerName)
Deletes an Azure Cognitive Search indexer.
|
Mono<Response<Void>> |
deleteIndexerWithResponse(String indexerName,
MatchConditions accessCondition,
RequestOptions requestOptions)
Deletes an Azure Cognitive Search indexer.
|
Mono<Response<Void>> |
deleteIndexWithResponse(String indexName,
MatchConditions accessCondition,
RequestOptions requestOptions)
Deletes an Azure Cognitive Search index and all the documents it contains.
|
Mono<Void> |
deleteSkillset(String skillsetName)
Deletes a cognitive skillset in an Azure Cognitive Search service.
|
Mono<Response<Void>> |
deleteSkillsetWithResponse(String skillsetName,
MatchConditions accessCondition,
RequestOptions requestOptions)
Deletes a cognitive skillset in an Azure Cognitive Search service.
|
Mono<Void> |
deleteSynonymMap(String synonymMapName)
Deletes an Azure Cognitive Search synonym map.
|
Mono<Response<Void>> |
deleteSynonymMapWithResponse(String synonymMapName,
MatchConditions accessCondition,
RequestOptions requestOptions)
Deletes an Azure Cognitive Search synonym map.
|
Mono<DataSource> |
getDataSource(String dataSourceName)
Retrieves a DataSource from an Azure Cognitive Search service.
|
Mono<Response<DataSource>> |
getDataSourceWithResponse(String dataSourceName,
RequestOptions requestOptions)
Retrieves a DataSource from an Azure Cognitive Search service.
|
String |
getEndpoint()
Gets the endpoint for the Azure Cognitive Search service.
|
Mono<Index> |
getIndex(String indexName)
Retrieves an index definition from the Azure Cognitive Search.
|
SearchIndexAsyncClient |
getIndexClient(String indexName)
Initializes a new
SearchIndexAsyncClient using the given Index name and the same configuration as the
SearchServiceAsyncClient. |
Mono<Indexer> |
getIndexer(String indexerName)
Retrieves an indexer definition.
|
Mono<IndexerExecutionInfo> |
getIndexerStatus(String indexerName)
Returns the current status and execution history of an indexer.
|
Mono<Response<IndexerExecutionInfo>> |
getIndexerStatusWithResponse(String indexerName,
RequestOptions requestOptions)
Returns the current status and execution history of an indexer.
|
Mono<Response<Indexer>> |
getIndexerWithResponse(String indexerName,
RequestOptions requestOptions)
Retrieves an indexer definition.
|
Mono<GetIndexStatisticsResult> |
getIndexStatistics(String indexName)
Returns statistics for the given index, including a document count and storage usage.
|
Mono<Response<GetIndexStatisticsResult>> |
getIndexStatisticsWithResponse(String indexName,
RequestOptions requestOptions)
Returns statistics for the given index, including a document count and storage usage.
|
Mono<Response<Index>> |
getIndexWithResponse(String indexName,
RequestOptions requestOptions)
Retrieves an index definition from the Azure Cognitive Search.
|
Mono<ServiceStatistics> |
getServiceStatistics()
Returns service level statistics for a search service, including service counters and limits.
|
Mono<Response<ServiceStatistics>> |
getServiceStatisticsWithResponse(RequestOptions requestOptions)
Returns service level statistics for a search service, including service counters and limits.
|
SearchServiceVersion |
getServiceVersion()
Gets search service version.
|
Mono<Skillset> |
getSkillset(String skillsetName)
Retrieves a skillset definition.
|
Mono<Response<Skillset>> |
getSkillsetWithResponse(String skillsetName,
RequestOptions requestOptions)
Retrieves a skillset definition.
|
Mono<SynonymMap> |
getSynonymMap(String synonymMapName)
Retrieves a synonym map definition.
|
Mono<Response<SynonymMap>> |
getSynonymMapWithResponse(String synonymMapName,
RequestOptions requestOptions)
Retrieves a synonym map definition.
|
PagedFlux<DataSource> |
listDataSources()
List all DataSources from an Azure Cognitive Search service.
|
PagedFlux<DataSource> |
listDataSources(String select,
RequestOptions requestOptions)
List all DataSources from an Azure Cognitive Search service.
|
PagedFlux<Indexer> |
listIndexers() |
PagedFlux<Indexer> |
listIndexers(String select,
RequestOptions requestOptions)
Lists all indexers available for an Azure Cognitive Search service.
|
PagedFlux<Index> |
listIndexes()
Lists all indexes available for an Azure Cognitive Search service.
|
PagedFlux<Index> |
listIndexes(String select,
RequestOptions requestOptions)
Lists all indexes available for an Azure Cognitive Search service.
|
PagedFlux<Skillset> |
listSkillsets()
Lists all skillsets available for an Azure Cognitive Search service.
|
PagedFlux<Skillset> |
listSkillsets(String select,
RequestOptions requestOptions)
Lists all skillsets available for an Azure Cognitive Search service.
|
PagedFlux<SynonymMap> |
listSynonymMaps()
Lists all synonym maps available for an Azure Cognitive Search service.
|
PagedFlux<SynonymMap> |
listSynonymMaps(String select,
RequestOptions requestOptions)
Lists all synonym maps available for an Azure Cognitive Search service.
|
Mono<Void> |
resetIndexer(String indexerName)
Resets the change tracking state associated with an indexer.
|
Mono<Response<Void>> |
resetIndexerWithResponse(String indexerName,
RequestOptions requestOptions)
Resets the change tracking state associated with an indexer.
|
Mono<Void> |
runIndexer(String indexerName)
Runs an indexer on-demand.
|
Mono<Response<Void>> |
runIndexerWithResponse(String indexerName,
RequestOptions requestOptions)
Runs an indexer on-demand.
|
public SearchIndexAsyncClient getIndexClient(String indexName)
SearchIndexAsyncClient
using the given Index name and the same configuration as the
SearchServiceAsyncClient.indexName
- the name of the Index for the clientSearchIndexAsyncClient
created from the service client configurationpublic SearchServiceVersion getServiceVersion()
public String getEndpoint()
public Mono<DataSource> createOrUpdateDataSource(DataSource dataSource)
dataSource
- the definition of the data source to create or updatepublic Mono<Response<DataSource>> createOrUpdateDataSourceWithResponse(DataSource dataSource, MatchConditions accessCondition, RequestOptions requestOptions)
dataSource
- The definition of the data source to create or update.accessCondition
- the condition where the operation will be performed if the ETag on the server matches or
doesn't match specified valuesrequestOptions
- additional parameters for the operation. Contains the tracking ID sent with the request to
help with debuggingpublic Mono<DataSource> createDataSource(DataSource dataSource)
dataSource
- The definition of the dataSource to create.public Mono<Response<DataSource>> createDataSourceWithResponse(DataSource dataSource, RequestOptions requestOptions)
dataSource
- The definition of the data source to create.requestOptions
- Additional parameters for the operation. Contains the tracking ID sent with the request to
help with debugging.public Mono<DataSource> getDataSource(String dataSourceName)
dataSourceName
- the name of the data source to retrievepublic Mono<Response<DataSource>> getDataSourceWithResponse(String dataSourceName, RequestOptions requestOptions)
dataSourceName
- the name of the data source to retrieverequestOptions
- additional parameters for the operation. Contains the tracking ID sent with the request to
help with debugging.public PagedFlux<DataSource> listDataSources()
public PagedFlux<DataSource> listDataSources(String select, RequestOptions requestOptions)
select
- Selects which top-level properties of DataSource definitions to retrieve. Specified as a
comma-separated list of JSON property names, or '*' for all properties. The default is all properties.requestOptions
- Additional parameters for the operation. Contains the tracking ID sent with the request to
help with debugging.public Mono<Void> deleteDataSource(String dataSourceName)
dataSourceName
- the name of the data source for deletionpublic Mono<Response<Void>> deleteDataSourceWithResponse(String dataSourceName, MatchConditions accessCondition, RequestOptions requestOptions)
dataSourceName
- The name of the data source to delete.accessCondition
- the condition where the operation will be performed if the ETag on the server matches or
doesn't match specified valuesrequestOptions
- additional parameters for the operation. Contains the tracking ID sent with the request to
help with debuggingpublic Mono<Indexer> createIndexer(Indexer indexer)
indexer
- definition of the indexer to create.public Mono<Response<Indexer>> createIndexerWithResponse(Indexer indexer, RequestOptions requestOptions)
indexer
- definition of the indexer to createrequestOptions
- additional parameters for the operation. Contains the tracking ID sent with the request to
help with debuggingpublic Mono<Indexer> createOrUpdateIndexer(Indexer indexer)
indexer
- The definition of the indexer to create or update.public Mono<Response<Indexer>> createOrUpdateIndexerWithResponse(Indexer indexer, MatchConditions accessCondition, RequestOptions requestOptions)
indexer
- the definition of the indexer to create or updateaccessCondition
- the condition where the operation will be performed if the ETag on the server matches or
doesn't match specified valuesrequestOptions
- additional parameters for the operation Contains the tracking ID sent with the request to
help with debuggingpublic Mono<Indexer> getIndexer(String indexerName)
indexerName
- the name of the indexer to retrievepublic Mono<Response<Indexer>> getIndexerWithResponse(String indexerName, RequestOptions requestOptions)
indexerName
- the name of the indexer to retrieverequestOptions
- additional parameters for the operation. Contains the tracking ID sent with the request to
help with debuggingpublic PagedFlux<Indexer> listIndexers()
public PagedFlux<Indexer> listIndexers(String select, RequestOptions requestOptions)
select
- Selects which top-level properties of the indexers to retrieve. Specified as a comma-separated list
of JSON property names, or '*' for all properties. The default is all properties.requestOptions
- Additional parameters for the operation.public Mono<Void> deleteIndexer(String indexerName)
indexerName
- the name of the indexer to deletepublic Mono<Response<Void>> deleteIndexerWithResponse(String indexerName, MatchConditions accessCondition, RequestOptions requestOptions)
indexerName
- the name of the indexer to deleteaccessCondition
- the condition where the operation will be performed if the ETag on the server matches or
doesn't match specified valuesrequestOptions
- additional parameters for the operation. Contains the tracking ID sent with the request to
help with debuggingpublic Mono<Void> resetIndexer(String indexerName)
indexerName
- the name of the indexer to resetpublic Mono<Response<Void>> resetIndexerWithResponse(String indexerName, RequestOptions requestOptions)
indexerName
- the name of the indexer to resetrequestOptions
- additional parameters for the operation. Contains the tracking ID sent with the request to
help with debuggingpublic Mono<Void> runIndexer(String indexerName)
indexerName
- the name of the indexer to runpublic Mono<Response<Void>> runIndexerWithResponse(String indexerName, RequestOptions requestOptions)
indexerName
- the name of the indexer to runrequestOptions
- additional parameters for the operation. Contains the tracking ID sent with the request to
help with debuggingpublic Mono<IndexerExecutionInfo> getIndexerStatus(String indexerName)
indexerName
- the name of the indexer for which to retrieve statuspublic Mono<Response<IndexerExecutionInfo>> getIndexerStatusWithResponse(String indexerName, RequestOptions requestOptions)
indexerName
- the name of the indexer for which to retrieve statusrequestOptions
- additional parameters for the operation. Contains the tracking ID sent with the request to
help with debuggingpublic Mono<Index> createIndex(Index index)
index
- definition of the index to create.public Mono<Response<Index>> createIndexWithResponse(Index index, RequestOptions requestOptions)
index
- definition of the index to createrequestOptions
- additional parameters for the operation. Contains the tracking ID sent with the request to
help with debuggingpublic Mono<Index> getIndex(String indexName)
indexName
- The name of the index to retrievepublic Mono<Response<Index>> getIndexWithResponse(String indexName, RequestOptions requestOptions)
indexName
- the name of the index to retrieverequestOptions
- additional parameters for the operation. Contains the tracking ID sent with the request to
help with debuggingpublic Mono<GetIndexStatisticsResult> getIndexStatistics(String indexName)
indexName
- the name of the index for which to retrieve statisticspublic Mono<Response<GetIndexStatisticsResult>> getIndexStatisticsWithResponse(String indexName, RequestOptions requestOptions)
indexName
- the name of the index for which to retrieve statisticsrequestOptions
- additional parameters for the operation. Contains the tracking ID sent with the request to
help with debuggingpublic PagedFlux<Index> listIndexes()
public PagedFlux<Index> listIndexes(String select, RequestOptions requestOptions)
select
- selects which top-level properties of the index definitions to retrieve. Specified as a
comma-separated list of JSON property names, or '*' for all properties. The default is all propertiesrequestOptions
- additional parameters for the operation. Contains the tracking ID sent with the request to
help with debuggingpublic Mono<Index> createOrUpdateIndex(Index index)
index
- the definition of the index to create or updatepublic Mono<Response<Index>> createOrUpdateIndexWithResponse(Index index, boolean allowIndexDowntime, MatchConditions accessCondition, RequestOptions requestOptions)
index
- the definition of the index to create or updateallowIndexDowntime
- allows new analyzers, tokenizers, token filters, or char filters to be added to an
index by taking the index offline for at least a few seconds. This temporarily causes indexing and query requests
to fail. Performance and write availability of the index can be impaired for several minutes after the index is
updated, or longer for very large indexesaccessCondition
- the condition where the operation will be performed if the ETag on the server matches or
doesn't match specified valuesrequestOptions
- additional parameters for the operation. Contains the tracking ID sent with the request to
help with debuggingpublic Mono<Void> deleteIndex(String indexName)
indexName
- the name of the index to deletepublic Mono<Response<Void>> deleteIndexWithResponse(String indexName, MatchConditions accessCondition, RequestOptions requestOptions)
indexName
- the name of the index to deleteaccessCondition
- the condition where the operation will be performed if the ETag on the server matches or
doesn't match specified valuesrequestOptions
- additional parameters for the operation. Contains the tracking ID sent with the request to
help with debuggingpublic PagedFlux<TokenInfo> analyzeText(String indexName, AnalyzeRequest analyzeRequest)
indexName
- the name of the index for which to test an analyzeranalyzeRequest
- the text and analyzer or analysis components to testpublic PagedFlux<TokenInfo> analyzeText(String indexName, AnalyzeRequest analyzeRequest, RequestOptions requestOptions)
indexName
- the name of the index for which to test an analyzeranalyzeRequest
- the text and analyzer or analysis components to testrequestOptions
- additional parameters for the operation. Contains the tracking ID sent with the request to
help with debuggingpublic Mono<Skillset> createSkillset(Skillset skillset)
skillset
- definition of the skillset containing one or more cognitive skillspublic Mono<Response<Skillset>> createSkillsetWithResponse(Skillset skillset, RequestOptions requestOptions)
skillset
- definition of the skillset containing one or more cognitive skillsrequestOptions
- additional parameters for the operation. Contains the tracking ID sent with the request to
help with debuggingpublic Mono<Skillset> getSkillset(String skillsetName)
skillsetName
- the name of the skillset to retrievepublic Mono<Response<Skillset>> getSkillsetWithResponse(String skillsetName, RequestOptions requestOptions)
skillsetName
- the name of the skillset to retrieverequestOptions
- additional parameters for the operation. Contains the tracking ID sent with the request to
help with debuggingpublic PagedFlux<Skillset> listSkillsets()
public PagedFlux<Skillset> listSkillsets(String select, RequestOptions requestOptions)
select
- selects which top-level properties of the skillset definitions to retrieve. Specified as a
comma-separated list of JSON property names, or '*' for all properties. The default is all propertiesrequestOptions
- additional parameters for the operation. Contains the tracking ID sent with the request to
help with debuggingpublic Mono<Skillset> createOrUpdateSkillset(Skillset skillset)
skillset
- the definition of the skillset to create or updatepublic Mono<Response<Skillset>> createOrUpdateSkillsetWithResponse(Skillset skillset, MatchConditions accessCondition, RequestOptions requestOptions)
skillset
- the definition of the skillset to create or updateaccessCondition
- the condition where the operation will be performed if the ETag on the server matches or
doesn't match specified valuesrequestOptions
- additional parameters for the operation. Contains the tracking ID sent with the request to
help with debuggingpublic Mono<Void> deleteSkillset(String skillsetName)
skillsetName
- the name of the skillset to deletepublic Mono<Response<Void>> deleteSkillsetWithResponse(String skillsetName, MatchConditions accessCondition, RequestOptions requestOptions)
skillsetName
- the name of the skillset to deleteaccessCondition
- the condition where the operation will be performed if the ETag on the server matches or
doesn't match specified valuesrequestOptions
- additional parameters for the operation. Contains the tracking ID sent with the request to
help with debuggingpublic Mono<SynonymMap> createSynonymMap(SynonymMap synonymMap)
synonymMap
- the definition of the synonym map to createSynonymMap
.public Mono<Response<SynonymMap>> createSynonymMapWithResponse(SynonymMap synonymMap, RequestOptions requestOptions)
synonymMap
- the definition of the synonym map to createrequestOptions
- additional parameters for the operation. Contains the tracking ID sent with the request to
help with debuggingpublic Mono<SynonymMap> getSynonymMap(String synonymMapName)
synonymMapName
- name of the synonym map to retrieveSynonymMap
definitionpublic Mono<Response<SynonymMap>> getSynonymMapWithResponse(String synonymMapName, RequestOptions requestOptions)
synonymMapName
- name of the synonym map to retrieverequestOptions
- additional parameters for the operation. Contains the tracking ID sent with the request to
help with debuggingpublic PagedFlux<SynonymMap> listSynonymMaps()
public PagedFlux<SynonymMap> listSynonymMaps(String select, RequestOptions requestOptions)
select
- selects which top-level properties of the synonym maps to retrieve. Specified as a comma-separated
list of JSON property names, or '*' for all properties. The default is all propertiesrequestOptions
- additional parameters for the operation. Contains the tracking ID sent with the request to
help with debuggingpublic Mono<SynonymMap> createOrUpdateSynonymMap(SynonymMap synonymMap)
synonymMap
- the definition of the synonym map to create or updatepublic Mono<Response<SynonymMap>> createOrUpdateSynonymMapWithResponse(SynonymMap synonymMap, MatchConditions accessCondition, RequestOptions requestOptions)
synonymMap
- the definition of the synonym map to create or updateaccessCondition
- the condition where the operation will be performed if the ETag on the server matches or
doesn't match specified valuesrequestOptions
- additional parameters for the operation. Contains the tracking ID sent with the request to
help with debuggingpublic Mono<Void> deleteSynonymMap(String synonymMapName)
synonymMapName
- the name of the synonym map to deletepublic Mono<Response<Void>> deleteSynonymMapWithResponse(String synonymMapName, MatchConditions accessCondition, RequestOptions requestOptions)
synonymMapName
- the name of the synonym map to deleteaccessCondition
- the condition where the operation will be performed if the ETag on the server matches or
doesn't match specified valuesrequestOptions
- additional parameters for the operation. Contains the tracking ID sent with the request to
help with debuggingpublic Mono<ServiceStatistics> getServiceStatistics()
Contains the tracking ID sent with the request to help with debugging
public Mono<Response<ServiceStatistics>> getServiceStatisticsWithResponse(RequestOptions requestOptions)
requestOptions
- additional parameters for the operation. Contains the tracking ID sent with the request to
help with debuggingCopyright © 2020 Microsoft Corporation. All rights reserved.