Share via


SearchIndexerClient.GetIndexer(String, CancellationToken) Method

Definition

Gets a specific SearchIndexer.

public virtual Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndexer> GetIndexer (string indexerName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetIndexer : string * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndexer>
override this.GetIndexer : string * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndexer>
Public Overridable Function GetIndexer (indexerName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of SearchIndexer)

Parameters

indexerName
String

Required. The name of the SearchIndexer to get.

cancellationToken
CancellationToken

Optional CancellationToken to propagate notifications that the operation should be canceled.

Returns

The Response<T> from the server containing the requested SearchIndexer.

Exceptions

Thrown when indexerName is null.

Thrown when a failure is returned by the Search service.

Applies to