SearchIndexerClient 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.SearchIndexerClient

public final class SearchIndexerClient

Initializes a new instance of the synchronous SearchIndexerClient type.

Method Summary

Modifier and Type	Method and Description
SearchIndexerDataSourceConnection	createDataSourceConnection(SearchIndexerDataSourceConnection dataSourceConnection) Creates a new datasource.
Response<SearchIndexerDataSourceConnection>	createDataSourceConnectionWithResponse(SearchIndexerDataSourceConnection dataSourceConnection, RequestOptions requestOptions) Creates a new datasource.
SearchIndexer	createIndexer(SearchIndexer indexer) Creates a new indexer.
Response<SearchIndexer>	createIndexerWithResponse(SearchIndexer indexer, RequestOptions requestOptions) Creates a new indexer.
SearchIndexerDataSourceConnection	createOrUpdateDataSourceConnection(SearchIndexerDataSourceConnection dataSource) Creates a new datasource or updates a datasource if it already exists.
Response<SearchIndexerDataSourceConnection>	createOrUpdateDataSourceConnectionWithResponse(SearchIndexerDataSourceConnection dataSource, RequestOptions requestOptions) Creates a new datasource or updates a datasource if it already exists.
SearchIndexer	createOrUpdateIndexer(SearchIndexer indexer) Creates a new indexer or updates an indexer if it already exists.
Response<SearchIndexer>	createOrUpdateIndexerWithResponse(SearchIndexer indexer, RequestOptions requestOptions) Creates a new indexer or updates an indexer if it already exists.
SearchIndexerSkillset	createOrUpdateSkillset(SearchIndexerSkillset skillset) Creates a new skillset in a search service or updates the skillset if it already exists.
Response<SearchIndexerSkillset>	createOrUpdateSkillsetWithResponse(SearchIndexerSkillset skillset, RequestOptions requestOptions) Creates a new skillset in a search service or updates the skillset if it already exists.
SearchIndexerSkillset	createSkillset(SearchIndexerSkillset skillset) Creates a new skillset in a search service.
Response<SearchIndexerSkillset>	createSkillsetWithResponse(SearchIndexerSkillset skillset, RequestOptions requestOptions) Creates a new skillset in a search service.
void	deleteDataSourceConnection(String name) Deletes a datasource.
void	deleteDataSourceConnection(String name, MatchConditions matchConditions) Deletes a datasource.
Response<Void>	deleteDataSourceConnectionWithResponse(String name, RequestOptions requestOptions) Deletes a datasource.
void	deleteIndexer(String name) Deletes an indexer.
void	deleteIndexer(String name, MatchConditions matchConditions) Deletes an indexer.
Response<Void>	deleteIndexerWithResponse(String name, RequestOptions requestOptions) Deletes an indexer.
void	deleteSkillset(String name) Deletes a skillset in a search service.
void	deleteSkillset(String name, MatchConditions matchConditions) Deletes a skillset in a search service.
Response<Void>	deleteSkillsetWithResponse(String name, RequestOptions requestOptions) Deletes a skillset in a search service.
SearchIndexerDataSourceConnection	getDataSourceConnection(String name) Retrieves a datasource definition.
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.
SearchIndexer	getIndexer(String name) Retrieves an indexer definition.
SearchIndexerStatus	getIndexerStatus(String name) Returns the current status and execution history of an indexer.
Response<SearchIndexerStatus>	getIndexerStatusWithResponse(String name, RequestOptions requestOptions) Returns the current status and execution history of an indexer.
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.
SearchIndexerSkillset	getSkillset(String name) Retrieves a skillset in a search service.
Response<SearchIndexerSkillset>	getSkillsetWithResponse(String name, RequestOptions requestOptions) Retrieves a skillset in a search service.
PagedIterable<String>	listDataSourceConnectionNames() Lists the names of all datasources available for a search service.
PagedIterable<SearchIndexerDataSourceConnection>	listDataSourceConnections() Lists all datasources available for a search service.
PagedIterable<String>	listIndexerNames() Lists the names of all indexers available for a search service.
PagedIterable<SearchIndexer>	listIndexers() Lists all indexers available for a search service.
PagedIterable<String>	listSkillsetNames() Lists the names of all skillsets in a search service.
PagedIterable<SearchIndexerSkillset>	listSkillsets() List all skillsets in a search service.
void	resetIndexer(String name) Resets the change tracking state associated with an indexer.
Response<Void>	resetIndexerWithResponse(String name, RequestOptions requestOptions) Resets the change tracking state associated with an indexer.
void	runIndexer(String name) Runs an indexer on-demand.
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 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.

createDataSourceConnectionWithResponse

public 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>.

createIndexer

public SearchIndexer createIndexer(SearchIndexer indexer)

Creates a new indexer.

Parameters:

indexer - The definition of the indexer to create.

Returns:

represents an indexer.

createIndexerWithResponse

public 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>.

createOrUpdateDataSourceConnection

public 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.

createOrUpdateDataSourceConnectionWithResponse

public 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>.

createOrUpdateIndexer

public 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.

createOrUpdateIndexerWithResponse

public 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>.

createOrUpdateSkillset

public 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.

createOrUpdateSkillsetWithResponse

public 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>.

createSkillset

public 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.

createSkillsetWithResponse

public 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>.

deleteDataSourceConnection

public void deleteDataSourceConnection(String name)

Deletes a datasource.

Parameters:

name - The name of the datasource.

deleteDataSourceConnection

public void deleteDataSourceConnection(String name, MatchConditions matchConditions)

Deletes a datasource.

Parameters:

name - The name of the datasource.

matchConditions - Specifies HTTP options for conditional requests.

deleteDataSourceConnectionWithResponse

public 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>.

deleteIndexer

public void deleteIndexer(String name)

Deletes an indexer.

Parameters:

name - The name of the indexer.

deleteIndexer

public void deleteIndexer(String name, MatchConditions matchConditions)

Deletes an indexer.

Parameters:

name - The name of the indexer.

matchConditions - Specifies HTTP options for conditional requests.

deleteIndexerWithResponse

public 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>.

deleteSkillset

public void deleteSkillset(String name)

Deletes a skillset in a search service.

Parameters:

name - The name of the skillset.

deleteSkillset

public 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.

deleteSkillsetWithResponse

public 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>.

getDataSourceConnection

public 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.

getDataSourceConnectionWithResponse

public 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>.

getEndpoint

public String getEndpoint()

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

Returns:

The endpoint.

getIndexer

public SearchIndexer getIndexer(String name)

Retrieves an indexer definition.

Parameters:

name - The name of the indexer.

Returns:

represents an indexer.

getIndexerStatus

public 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.

getIndexerStatusWithResponse

public 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>.

getIndexerWithResponse

public 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>.

getServiceVersion

public SearchServiceVersion getServiceVersion()

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

Returns:

The service version.

getSkillset

public SearchIndexerSkillset getSkillset(String name)

Retrieves a skillset in a search service.

Parameters:

name - The name of the skillset.

Returns:

a list of skills.

getSkillsetWithResponse

public 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>.

listDataSourceConnectionNames

public PagedIterable<String> listDataSourceConnectionNames()

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

Returns:

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

listDataSourceConnections

public PagedIterable<SearchIndexerDataSourceConnection> listDataSourceConnections()

Lists all datasources available for a search service.

Returns:

all datasources as paginated response with PagedIterable<T>.

listIndexerNames

public PagedIterable<String> listIndexerNames()

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

Returns:

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

listIndexers

public PagedIterable<SearchIndexer> listIndexers()

Lists all indexers available for a search service.

Returns:

all indexers as paginated response with PagedIterable<T>.

listSkillsetNames

public PagedIterable<String> listSkillsetNames()

Lists the names of all skillsets in a search service.

Returns:

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

listSkillsets

public PagedIterable<SearchIndexerSkillset> listSkillsets()

List all skillsets in a search service.

Returns:

all skillsets as paginated response with PagedIterable<T>.

resetIndexer

public void resetIndexer(String name)

Resets the change tracking state associated with an indexer.

Parameters:

name - The name of the indexer.

resetIndexerWithResponse

public 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>.

runIndexer

public void runIndexer(String name)

Runs an indexer on-demand.

Parameters:

name - The name of the indexer.

runIndexerWithResponse

public 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>.