SearchIndexerClient.GetIndexerStatus Method

Definition

Namespace:: Azure.Search.Documents.Indexes

Assembly:: Azure.Search.Documents.dll

Package:: Azure.Search.Documents v12.0.0

Package:: Azure.Search.Documents v12.1.0-beta.2

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.

Overloads

Name	Description
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.
GetIndexerStatus(String, CancellationToken)	Returns the current status and execution history of an indexer.

Name

Description

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.

GetIndexerStatus(String, CancellationToken)

Returns the current status and execution history of an indexer.

GetIndexerStatus(String, RequestContext)

Source:: SearchIndexerClient.cs

Source:: SearchIndexerClient.cs

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

public virtual Azure.Response GetIndexerStatus(string indexerName, Azure.RequestContext context);

abstract member GetIndexerStatus : string * Azure.RequestContext -> Azure.Response
override this.GetIndexerStatus : string * Azure.RequestContext -> Azure.Response

Public Overridable Function GetIndexerStatus (indexerName As String, context As RequestContext) As Response

Parameters

indexerName: String

The name of the indexer.

context: RequestContext

The request options, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

indexerName is null.

ArgumentException

indexerName is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Applies to

GetIndexerStatus(String, CancellationToken)

Source:: SearchIndexerClient.cs

Source:: SearchIndexerClient.cs

Returns the current status and execution history of an indexer.

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

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

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