SearchIndexerClient Class

Definition

Namespace:
Azure.Search.Documents.Indexes
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v12.0.0
Package:
Azure.Search.Documents v11.8.0-beta.1
Source:
SearchIndexerClient.cs
Source:
SearchIndexerClient.cs

The SearchIndexerClient.

public class SearchIndexerClient
type SearchIndexerClient = class
Public Class SearchIndexerClient
Inheritance
Object
SearchIndexerClient

Constructors

Name Description
SearchIndexerClient()

Initializes a new instance of the SearchIndexerClient class for mocking.
SearchIndexerClient(SearchIndexerClientSettings)

Initializes a new instance of SearchIndexerClient from a SearchIndexerClientSettings.
SearchIndexerClient(Uri, AzureKeyCredential, SearchClientOptions)

Initializes a new instance of the SearchIndexerClient class.
SearchIndexerClient(Uri, AzureKeyCredential)

Initializes a new instance of the SearchIndexerClient class.
SearchIndexerClient(Uri, TokenCredential, SearchClientOptions)

Initializes a new instance of the SearchIndexerClient class.
SearchIndexerClient(Uri, TokenCredential)

Initializes a new instance of the SearchIndexerClient class.

Properties

Name Description
Endpoint

Gets the URI endpoint of the Search service.This is likely to be similar to "https://{search_service}.search.windows.net".
Pipeline

The HTTP pipeline for sending and receiving REST requests and responses.
ServiceName

Gets the name of the Search service.

Methods

Name Description
CreateDataSourceConnection(RequestContent, RequestContext)

[Protocol Method] Creates a new datasource.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateDataSourceConnection(SearchIndexerDataSourceConnection, CancellationToken)

Creates a new datasource.
CreateDataSourceConnectionAsync(RequestContent, RequestContext)

[Protocol Method] Creates a new datasource.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateDataSourceConnectionAsync(SearchIndexerDataSourceConnection, CancellationToken)

Creates a new datasource.
CreateIndexer(RequestContent, RequestContext)

[Protocol Method] Creates a new indexer.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateIndexer(SearchIndexer, CancellationToken)

Creates a new indexer.
CreateIndexerAsync(RequestContent, RequestContext)

[Protocol Method] Creates a new indexer.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateIndexerAsync(SearchIndexer, CancellationToken)

Creates a new indexer.
CreateOrUpdateDataSourceConnection(SearchIndexerDataSourceConnection, Boolean, Nullable<Boolean>, CancellationToken)

Creates a new data source or updates an existing data source connection.
CreateOrUpdateDataSourceConnectionAsync(SearchIndexerDataSourceConnection, Boolean, Nullable<Boolean>, CancellationToken)

Creates a new data source or updates an existing data source connection.
CreateOrUpdateIndexer(SearchIndexer, Boolean, Nullable<Boolean>, Nullable<Boolean>, CancellationToken)

Creates a new indexer or updates an existing indexer.
CreateOrUpdateIndexerAsync(SearchIndexer, Boolean, Nullable<Boolean>, Nullable<Boolean>, CancellationToken)

Creates a new indexer or updates an existing indexer.
CreateOrUpdateSkillset(SearchIndexerSkillset, Boolean, Nullable<Boolean>, Nullable<Boolean>, CancellationToken)

Creates a new skillset or updates an existing skillset.
CreateOrUpdateSkillsetAsync(SearchIndexerSkillset, Boolean, Nullable<Boolean>, Nullable<Boolean>, CancellationToken)

Creates a new skillset or updates an existing skillset.
CreateSkillset(RequestContent, RequestContext)

[Protocol Method] Creates a new skillset in a search service.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateSkillset(SearchIndexerSkillset, CancellationToken)

Creates a new skillset in a search service.
CreateSkillsetAsync(RequestContent, RequestContext)

[Protocol Method] Creates a new skillset in a search service.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateSkillsetAsync(SearchIndexerSkillset, CancellationToken)

Creates a new skillset in a search service.
DeleteDataSourceConnection(SearchIndexerDataSourceConnection, Boolean, CancellationToken)

Deletes a data source connection.
DeleteDataSourceConnection(String, CancellationToken)

Deletes a data source connection.
DeleteDataSourceConnection(String, MatchConditions, CancellationToken)

Deletes a datasource.
DeleteDataSourceConnection(String, MatchConditions, RequestContext)

[Protocol Method] Deletes a datasource.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteDataSourceConnectionAsync(SearchIndexerDataSourceConnection, Boolean, CancellationToken)

Deletes a data source connection.
DeleteDataSourceConnectionAsync(String, CancellationToken)

Deletes a data source connection.
DeleteDataSourceConnectionAsync(String, MatchConditions, CancellationToken)

Deletes a datasource.
DeleteDataSourceConnectionAsync(String, MatchConditions, RequestContext)

[Protocol Method] Deletes a datasource.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteIndexer(SearchIndexer, Boolean, CancellationToken)

Deletes an indexer.
DeleteIndexer(String, CancellationToken)

Deletes an indexer.
DeleteIndexer(String, MatchConditions, CancellationToken)

Deletes an indexer.
DeleteIndexer(String, MatchConditions, RequestContext)

[Protocol Method] Deletes an indexer.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteIndexerAsync(SearchIndexer, Boolean, CancellationToken)

Deletes an indexer.
DeleteIndexerAsync(String, CancellationToken)

Deletes an indexer.
DeleteIndexerAsync(String, MatchConditions, CancellationToken)

Deletes an indexer.
DeleteIndexerAsync(String, MatchConditions, RequestContext)

[Protocol Method] Deletes an indexer.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteSkillset(SearchIndexerSkillset, Boolean, CancellationToken)

Deletes a skillset.
DeleteSkillset(String, CancellationToken)

Deletes a skillset.
DeleteSkillset(String, MatchConditions, CancellationToken)

Deletes a skillset in a search service.
DeleteSkillset(String, MatchConditions, RequestContext)

[Protocol Method] Deletes a skillset in a search service.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteSkillsetAsync(SearchIndexerSkillset, Boolean, CancellationToken)

Deletes a skillset.
DeleteSkillsetAsync(String, CancellationToken)

Deletes a skillset.
DeleteSkillsetAsync(String, MatchConditions, CancellationToken)

Deletes a skillset in a search service.
DeleteSkillsetAsync(String, MatchConditions, RequestContext)

[Protocol Method] Deletes a skillset in a search service.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetDataSourceConnection(String, CancellationToken)

Retrieves a datasource definition.
GetDataSourceConnection(String, RequestContext)

[Protocol Method] Retrieves a datasource definition.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetDataSourceConnectionAsync(String, CancellationToken)

Retrieves a datasource definition.
GetDataSourceConnectionAsync(String, RequestContext)

[Protocol Method] Retrieves a datasource definition.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetDataSourceConnectionNames(CancellationToken)

Gets a list of all data source connection names.
GetDataSourceConnectionNamesAsync(CancellationToken)

Gets a list of all data source connection names.
GetDataSourceConnections(CancellationToken)

Gets a list of all data source connections.
GetDataSourceConnectionsAsync(CancellationToken)

Gets a list of all data source connections.
GetIndexer(String, CancellationToken)

Retrieves an indexer definition.
GetIndexer(String, RequestContext)

[Protocol Method] Retrieves an indexer definition.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetIndexerAsync(String, CancellationToken)

Retrieves an indexer definition.
GetIndexerAsync(String, RequestContext)

[Protocol Method] Retrieves an indexer definition.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetIndexerNames(CancellationToken)

Gets a list of all indexer names.
GetIndexerNamesAsync(CancellationToken)

Gets a list of all indexer names.
GetIndexers(CancellationToken)

Gets a list of all indexers.
GetIndexersAsync(CancellationToken)

Gets a list of all indexers.
GetIndexerStatus(String, CancellationToken)

Returns the current status and execution history of an indexer.
GetIndexerStatus(String, RequestContext)

[Protocol Method] Returns the current status and execution history of an indexer.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetIndexerStatusAsync(String, CancellationToken)

Returns the current status and execution history of an indexer.
GetIndexerStatusAsync(String, RequestContext)

[Protocol Method] Returns the current status and execution history of an indexer.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetSkillset(String, CancellationToken)

Retrieves a skillset in a search service.
GetSkillset(String, RequestContext)

[Protocol Method] Retrieves a skillset in a search service.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetSkillsetAsync(String, CancellationToken)

Retrieves a skillset in a search service.
GetSkillsetAsync(String, RequestContext)

[Protocol Method] Retrieves a skillset in a search service.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetSkillsetNames(CancellationToken)

Gets a list of all skillset names.
GetSkillsetNamesAsync(CancellationToken)

Gets a list of all skillset names.
GetSkillsets(CancellationToken)

Gets a list of all skillsets.
GetSkillsetsAsync(CancellationToken)

Gets a list of all skillsets.
ResetDocuments(String, Nullable<Boolean>, ResetDocumentOptions, CancellationToken)

Resets specific documents in the datasource to be selectively re-ingested by the indexer.
ResetDocumentsAsync(String, Nullable<Boolean>, ResetDocumentOptions, CancellationToken)

Resets specific documents in the datasource to be selectively re-ingested by the indexer.
ResetIndexer(String, CancellationToken)

Resets the change tracking state associated with an indexer.
ResetIndexer(String, RequestContext)

[Protocol Method] Resets the change tracking state associated with an indexer.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
ResetIndexerAsync(String, CancellationToken)

Resets the change tracking state associated with an indexer.
ResetIndexerAsync(String, RequestContext)

[Protocol Method] Resets the change tracking state associated with an indexer.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
ResetSkills(String, ResetSkillsOptions, CancellationToken)

Resets skills in an existing skillset in a search service.
ResetSkillsAsync(String, ResetSkillsOptions, CancellationToken)

Resets skills in an existing skillset in a search service.
Resync(String, IndexerResyncBody, CancellationToken)

Resync selective options from the datasource to be re-ingested by the indexer.
ResyncAsync(String, IndexerResyncBody, CancellationToken)

Resync selective options from the datasource to be re-ingested by the indexer.
RunIndexer(String, CancellationToken)

Runs an indexer on-demand.
RunIndexer(String, RequestContext)

[Protocol Method] Runs an indexer on-demand.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
RunIndexerAsync(String, CancellationToken)

Runs an indexer on-demand.
RunIndexerAsync(String, RequestContext)

[Protocol Method] Runs an indexer on-demand.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

Applies to