SearchIndexerClient.GetIndexerStatusAsync(String, CancellationToken) Method

Reference

Definition

Namespace:: Azure.Search.Documents.Indexes

Assembly:: Azure.Search.Documents.dll

Package:: Azure.Search.Documents v11.5.1

Package:: Azure.Search.Documents v11.6.0-beta.3

Source:: SearchIndexerClient.cs

Source:: SearchIndexerClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets the current status and execution history of an indexer.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndexerStatus>> GetIndexerStatusAsync (string indexerName, System.Threading.CancellationToken cancellationToken = default);

abstract member GetIndexerStatusAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndexerStatus>>
override this.GetIndexerStatusAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndexerStatus>>

Public Overridable Function GetIndexerStatusAsync (indexerName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SearchIndexerStatus))

Parameters

indexerName: String

Required. The name of the indexer for which to retrieve status.

cancellationToken: CancellationToken

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

Returns

Task<Response<SearchIndexerStatus>>

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

Exceptions

ArgumentNullException

Thrown when indexerName is null.

RequestFailedException

Thrown when a failure is returned by the Search service.

Applies to