SearchIndexerAsyncClient Class

Package:
com.azure.search.documents.indexes
Maven Artifact:
com.azure:azure-search-documents:12.0.0
  • java.lang.Object
    • com.azure.search.documents.indexes.SearchIndexerAsyncClient

public final class SearchIndexerAsyncClient

Initializes a new instance of the asynchronous SearchIndexerClient type.

Method Summary

Modifier and Type Method and Description
Mono<SearchIndexerDataSourceConnection> createDataSourceConnection(SearchIndexerDataSourceConnection dataSourceConnection)

Creates a new datasource.
Mono<Response<SearchIndexerDataSourceConnection>> createDataSourceConnectionWithResponse(SearchIndexerDataSourceConnection dataSourceConnection, RequestOptions requestOptions)

Creates a new datasource.
Mono<SearchIndexer> createIndexer(SearchIndexer indexer)

Creates a new indexer.
Mono<Response<SearchIndexer>> createIndexerWithResponse(SearchIndexer indexer, RequestOptions requestOptions)

Creates a new indexer.
Mono<SearchIndexerDataSourceConnection> createOrUpdateDataSourceConnection(SearchIndexerDataSourceConnection dataSource)

Creates a new datasource or updates a datasource if it already exists.
Mono<Response<SearchIndexerDataSourceConnection>> createOrUpdateDataSourceConnectionWithResponse(SearchIndexerDataSourceConnection dataSource, RequestOptions requestOptions)

Creates a new datasource or updates a datasource if it already exists.
Mono<SearchIndexer> createOrUpdateIndexer(SearchIndexer indexer)

Creates a new indexer or updates an indexer if it already exists.
Mono<Response<SearchIndexer>> createOrUpdateIndexerWithResponse(SearchIndexer indexer, RequestOptions requestOptions)

Creates a new indexer or updates an indexer if it already exists.
Mono<SearchIndexerSkillset> createOrUpdateSkillset(SearchIndexerSkillset skillset)

Creates a new skillset in a search service or updates the skillset if it already exists.
Mono<Response<SearchIndexerSkillset>> createOrUpdateSkillsetWithResponse(SearchIndexerSkillset skillset, RequestOptions requestOptions)

Creates a new skillset in a search service or updates the skillset if it already exists.
Mono<SearchIndexerSkillset> createSkillset(SearchIndexerSkillset skillset)

Creates a new skillset in a search service.
Mono<Response<SearchIndexerSkillset>> createSkillsetWithResponse(SearchIndexerSkillset skillset, RequestOptions requestOptions)

Creates a new skillset in a search service.
Mono<Void> deleteDataSourceConnection(String name)

Deletes a datasource.
Mono<Void> deleteDataSourceConnection(String name, MatchConditions matchConditions)

Deletes a datasource.
Mono<Response<Void>> deleteDataSourceConnectionWithResponse(String name, RequestOptions requestOptions)

Deletes a datasource.
Mono<Void> deleteIndexer(String name)

Deletes an indexer.
Mono<Void> deleteIndexer(String name, MatchConditions matchConditions)

Deletes an indexer.
Mono<Response<Void>> deleteIndexerWithResponse(String name, RequestOptions requestOptions)

Deletes an indexer.
Mono<Void> deleteSkillset(String name)

Deletes a skillset in a search service.
Mono<Void> deleteSkillset(String name, MatchConditions matchConditions)

Deletes a skillset in a search service.
Mono<Response<Void>> deleteSkillsetWithResponse(String name, RequestOptions requestOptions)

Deletes a skillset in a search service.
Mono<SearchIndexerDataSourceConnection> getDataSourceConnection(String name)

Retrieves a datasource definition.
Mono<Response<SearchIndexerDataSourceConnection>> getDataSourceConnectionWithResponse(String name, RequestOptions requestOptions)

Retrieves a datasource definition.
String getEndpoint()

Gets the endpoint used to communicate with the Azure AI Search service.
Mono<SearchIndexer> getIndexer(String name)

Retrieves an indexer definition.
Mono<SearchIndexerStatus> getIndexerStatus(String name)

Returns the current status and execution history of an indexer.
Mono<Response<SearchIndexerStatus>> getIndexerStatusWithResponse(String name, RequestOptions requestOptions)

Returns the current status and execution history of an indexer.
Mono<Response<SearchIndexer>> getIndexerWithResponse(String name, RequestOptions requestOptions)

Retrieves an indexer definition.
SearchServiceVersion getServiceVersion()

Gets the SearchServiceVersion used to communicate with the Azure AI Search service.
Mono<SearchIndexerSkillset> getSkillset(String name)

Retrieves a skillset in a search service.
Mono<Response<SearchIndexerSkillset>> getSkillsetWithResponse(String name, RequestOptions requestOptions)

Retrieves a skillset in a search service.
PagedFlux<String> listDataSourceConnectionNames()

Lists the names of all datasources available for a search service.
PagedFlux<SearchIndexerDataSourceConnection> listDataSourceConnections()

Lists all datasources available for a search service.
PagedFlux<String> listIndexerNames()

Lists the names of all indexers available for a search service.
PagedFlux<SearchIndexer> listIndexers()

Lists all indexers available for a search service.
PagedFlux<String> listSkillsetNames()

Lists the names of all skillsets in a search service.
PagedFlux<SearchIndexerSkillset> listSkillsets()

List all skillsets in a search service.
Mono<Void> resetIndexer(String name)

Resets the change tracking state associated with an indexer.
Mono<Response<Void>> resetIndexerWithResponse(String name, RequestOptions requestOptions)

Resets the change tracking state associated with an indexer.
Mono<Void> runIndexer(String name)

Runs an indexer on-demand.
Mono<Response<Void>> runIndexerWithResponse(String name, RequestOptions requestOptions)

Runs an indexer on-demand.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

createDataSourceConnection

public Mono<SearchIndexerDataSourceConnection> createDataSourceConnection(SearchIndexerDataSourceConnection dataSourceConnection)

Creates a new datasource.

Parameters:

dataSourceConnection - The definition of the datasource to create.

Returns:

represents a datasource definition, which can be used to configure an indexer on successful completion of Mono.

createDataSourceConnectionWithResponse

public Mono<Response<SearchIndexerDataSourceConnection>> createDataSourceConnectionWithResponse(SearchIndexerDataSourceConnection dataSourceConnection, RequestOptions requestOptions)

Creates a new datasource.

Parameters:

dataSourceConnection - The definition of the datasource to create.
requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

represents a datasource definition, which can be used to configure an indexer along with Response<T> on successful completion of Mono.

createIndexer

public Mono<SearchIndexer> createIndexer(SearchIndexer indexer)

Creates a new indexer.

Parameters:

indexer - The definition of the indexer to create.

Returns:

represents an indexer on successful completion of Mono.

createIndexerWithResponse

public Mono<Response<SearchIndexer>> createIndexerWithResponse(SearchIndexer indexer, RequestOptions requestOptions)

Creates a new indexer.

Parameters:

indexer - The definition of the indexer to create.
requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

represents an indexer along with Response<T> on successful completion of Mono.

createOrUpdateDataSourceConnection

public Mono<SearchIndexerDataSourceConnection> createOrUpdateDataSourceConnection(SearchIndexerDataSourceConnection dataSource)

Creates a new datasource or updates a datasource if it already exists.

Parameters:

dataSource - The definition of the datasource to create or update.

Returns:

represents a datasource definition, which can be used to configure an indexer on successful completion of Mono.

createOrUpdateDataSourceConnectionWithResponse

public Mono<Response<SearchIndexerDataSourceConnection>> createOrUpdateDataSourceConnectionWithResponse(SearchIndexerDataSourceConnection dataSource, RequestOptions requestOptions)

Creates a new datasource or updates a datasource if it already exists.

Query Parameters

| ----------------------- | ------- | -------- | --------------------------------- |
| Name                    | Type    | Required | Description                       |
| ignoreResetRequirements | Boolean | No       | Ignores cache reset requirements. |

You can add these to a request with RequestOptions#addQueryParam

Header Parameters

| ------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Name          | Type   | Required | Description                                                                                                                    |
| If-Match      | String | No       | Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.             |
| If-None-Match | String | No       | Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. |

You can add these to a request with RequestOptions#addHeader

Parameters:

dataSource - The definition of the datasource to create or update.
requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

represents a datasource definition, which can be used to configure an indexer along with Response<T> on successful completion of Mono.

createOrUpdateIndexer

public Mono<SearchIndexer> createOrUpdateIndexer(SearchIndexer indexer)

Creates a new indexer or updates an indexer if it already exists.

Parameters:

indexer - The definition of the indexer to create or update.

Returns:

represents an indexer on successful completion of Mono.

createOrUpdateIndexerWithResponse

public Mono<Response<SearchIndexer>> createOrUpdateIndexerWithResponse(SearchIndexer indexer, RequestOptions requestOptions)

Creates a new indexer or updates an indexer if it already exists.

Query Parameters

| --------------------------------------- | ------- | -------- | --------------------------------------------- |
| Name                                    | Type    | Required | Description                                   |
| ignoreResetRequirements                 | Boolean | No       | Ignores cache reset requirements.             |
| disableCacheReprocessingChangeDetection | Boolean | No       | Disables cache reprocessing change detection. |

You can add these to a request with RequestOptions#addQueryParam

Header Parameters

| ------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Name          | Type   | Required | Description                                                                                                                    |
| If-Match      | String | No       | Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.             |
| If-None-Match | String | No       | Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. |

You can add these to a request with RequestOptions#addHeader

Parameters:

indexer - The definition of the indexer to create or update.
requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

represents an indexer along with Response<T> on successful completion of Mono.

createOrUpdateSkillset

public Mono<SearchIndexerSkillset> createOrUpdateSkillset(SearchIndexerSkillset skillset)

Creates a new skillset in a search service or updates the skillset if it already exists.

Parameters:

skillset - The skillset containing one or more skills to create or update in a search service.

Returns:

a list of skills on successful completion of Mono.

createOrUpdateSkillsetWithResponse

public Mono<Response<SearchIndexerSkillset>> createOrUpdateSkillsetWithResponse(SearchIndexerSkillset skillset, RequestOptions requestOptions)

Creates a new skillset in a search service or updates the skillset if it already exists.

Query Parameters

| --------------------------------------- | ------- | -------- | --------------------------------------------- |
| Name                                    | Type    | Required | Description                                   |
| ignoreResetRequirements                 | Boolean | No       | Ignores cache reset requirements.             |
| disableCacheReprocessingChangeDetection | Boolean | No       | Disables cache reprocessing change detection. |

You can add these to a request with RequestOptions#addQueryParam

Header Parameters

| ------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Name          | Type   | Required | Description                                                                                                                    |
| If-Match      | String | No       | Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.             |
| If-None-Match | String | No       | Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. |

You can add these to a request with RequestOptions#addHeader

Parameters:

skillset - The skillset containing one or more skills to create or update in a search service.
requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

a list of skills along with Response<T> on successful completion of Mono.

createSkillset

public Mono<SearchIndexerSkillset> createSkillset(SearchIndexerSkillset skillset)

Creates a new skillset in a search service.

Parameters:

skillset - The skillset containing one or more skills to create in a search service.

Returns:

a list of skills on successful completion of Mono.

createSkillsetWithResponse

public Mono<Response<SearchIndexerSkillset>> createSkillsetWithResponse(SearchIndexerSkillset skillset, RequestOptions requestOptions)

Creates a new skillset in a search service.

Parameters:

skillset - The skillset containing one or more skills to create in a search service.
requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

a list of skills along with Response<T> on successful completion of Mono.

deleteDataSourceConnection

public Mono<Void> deleteDataSourceConnection(String name)

Deletes a datasource.

Parameters:

name - The name of the datasource.

Returns:

A Mono that completes when a successful response is received.

deleteDataSourceConnection

public Mono<Void> deleteDataSourceConnection(String name, MatchConditions matchConditions)

Deletes a datasource.

Parameters:

name - The name of the datasource.
matchConditions - Specifies HTTP options for conditional requests.

Returns:

A Mono that completes when a successful response is received.

deleteDataSourceConnectionWithResponse

public Mono<Response<Void>> deleteDataSourceConnectionWithResponse(String name, RequestOptions requestOptions)

Deletes a datasource.

Header Parameters

| ------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Name          | Type   | Required | Description                                                                                                                    |
| If-Match      | String | No       | Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.             |
| If-None-Match | String | No       | Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. |

You can add these to a request with RequestOptions#addHeader

Parameters:

name - The name of the datasource.
requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response<T> on successful completion of Mono.

deleteIndexer

public Mono<Void> deleteIndexer(String name)

Deletes an indexer.

Parameters:

name - The name of the indexer.

Returns:

A Mono that completes when a successful response is received.

deleteIndexer

public Mono<Void> deleteIndexer(String name, MatchConditions matchConditions)

Deletes an indexer.

Parameters:

name - The name of the indexer.
matchConditions - Specifies HTTP options for conditional requests.

Returns:

A Mono that completes when a successful response is received.

deleteIndexerWithResponse

public Mono<Response<Void>> deleteIndexerWithResponse(String name, RequestOptions requestOptions)

Deletes an indexer.

Header Parameters

| ------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Name          | Type   | Required | Description                                                                                                                    |
| If-Match      | String | No       | Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.             |
| If-None-Match | String | No       | Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. |

You can add these to a request with RequestOptions#addHeader

Parameters:

name - The name of the indexer.
requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response<T> on successful completion of Mono.

deleteSkillset

public Mono<Void> deleteSkillset(String name)

Deletes a skillset in a search service.

Parameters:

name - The name of the skillset.

Returns:

A Mono that completes when a successful response is received.

deleteSkillset

public Mono<Void> deleteSkillset(String name, MatchConditions matchConditions)

Deletes a skillset in a search service.

Parameters:

name - The name of the skillset.
matchConditions - Specifies HTTP options for conditional requests.

Returns:

A Mono that completes when a successful response is received.

deleteSkillsetWithResponse

public Mono<Response<Void>> deleteSkillsetWithResponse(String name, RequestOptions requestOptions)

Deletes a skillset in a search service.

Header Parameters

| ------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Name          | Type   | Required | Description                                                                                                                    |
| If-Match      | String | No       | Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.             |
| If-None-Match | String | No       | Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. |

You can add these to a request with RequestOptions#addHeader

Parameters:

name - The name of the skillset.
requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response<T> on successful completion of Mono.

getDataSourceConnection

public Mono<SearchIndexerDataSourceConnection> getDataSourceConnection(String name)

Retrieves a datasource definition.

Parameters:

name - The name of the datasource.

Returns:

represents a datasource definition, which can be used to configure an indexer on successful completion of Mono.

getDataSourceConnectionWithResponse

public Mono<Response<SearchIndexerDataSourceConnection>> getDataSourceConnectionWithResponse(String name, RequestOptions requestOptions)

Retrieves a datasource definition.

Parameters:

name - The name of the datasource.
requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

represents a datasource definition, which can be used to configure an indexer along with Response<T> on successful completion of Mono.

getEndpoint

public String getEndpoint()

Gets the endpoint used to communicate with the Azure AI Search service.

Returns:

The endpoint.

getIndexer

public Mono<SearchIndexer> getIndexer(String name)

Retrieves an indexer definition.

Parameters:

name - The name of the indexer.

Returns:

represents an indexer on successful completion of Mono.

getIndexerStatus

public Mono<SearchIndexerStatus> getIndexerStatus(String name)

Returns the current status and execution history of an indexer.

Parameters:

name - The name of the indexer.

Returns:

represents the current status and execution history of an indexer on successful completion of Mono.

getIndexerStatusWithResponse

public Mono<Response<SearchIndexerStatus>> getIndexerStatusWithResponse(String name, RequestOptions requestOptions)

Returns the current status and execution history of an indexer.

Parameters:

name - The name of the indexer.
requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

represents the current status and execution history of an indexer along with Response<T> on successful completion of Mono.

getIndexerWithResponse

public Mono<Response<SearchIndexer>> getIndexerWithResponse(String name, RequestOptions requestOptions)

Retrieves an indexer definition.

Parameters:

name - The name of the indexer.
requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

represents an indexer along with Response<T> on successful completion of Mono.

getServiceVersion

public SearchServiceVersion getServiceVersion()

Gets the SearchServiceVersion used to communicate with the Azure AI Search service.

Returns:

The service version.

getSkillset

public Mono<SearchIndexerSkillset> getSkillset(String name)

Retrieves a skillset in a search service.

Parameters:

name - The name of the skillset.

Returns:

a list of skills on successful completion of Mono.

getSkillsetWithResponse

public Mono<Response<SearchIndexerSkillset>> getSkillsetWithResponse(String name, RequestOptions requestOptions)

Retrieves a skillset in a search service.

Parameters:

name - The name of the skillset.
requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

a list of skills along with Response<T> on successful completion of Mono.

listDataSourceConnectionNames

public PagedFlux<String> listDataSourceConnectionNames()

Lists the names of all datasources available for a search service.

Returns:

the names of all datasources as paginated response with PagedFlux<T>.

listDataSourceConnections

public PagedFlux<SearchIndexerDataSourceConnection> listDataSourceConnections()

Lists all datasources available for a search service.

Returns:

all datasources as paginated response with PagedFlux<T>.

listIndexerNames

public PagedFlux<String> listIndexerNames()

Lists the names of all indexers available for a search service.

Returns:

the names of all indexers as paginated response with PagedFlux<T>.

listIndexers

public PagedFlux<SearchIndexer> listIndexers()

Lists all indexers available for a search service.

Returns:

all indexers as paginated response with PagedFlux<T>.

listSkillsetNames

public PagedFlux<String> listSkillsetNames()

Lists the names of all skillsets in a search service.

Returns:

the names of all skillsets as paginated response with PagedFlux<T>.

listSkillsets

public PagedFlux<SearchIndexerSkillset> listSkillsets()

List all skillsets in a search service.

Returns:

all skillsets as paginated response with PagedFlux<T>.

resetIndexer

public Mono<Void> resetIndexer(String name)

Resets the change tracking state associated with an indexer.

Parameters:

name - The name of the indexer.

Returns:

A Mono that completes when a successful response is received.

resetIndexerWithResponse

public Mono<Response<Void>> resetIndexerWithResponse(String name, RequestOptions requestOptions)

Resets the change tracking state associated with an indexer.

Parameters:

name - The name of the indexer.
requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response<T> on successful completion of Mono.

runIndexer

public Mono<Void> runIndexer(String name)

Runs an indexer on-demand.

Parameters:

name - The name of the indexer.

Returns:

A Mono that completes when a successful response is received.

runIndexerWithResponse

public Mono<Response<Void>> runIndexerWithResponse(String name, RequestOptions requestOptions)

Runs an indexer on-demand.

Parameters:

name - The name of the indexer.
requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response<T> on successful completion of Mono.

Applies to