SearchIndexClient.GetKnowledgeSourceStatusAsync Method

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

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
GetKnowledgeSourceStatusAsync(String, RequestContext)	[Protocol Method] Retrieves the status of a knowledge source. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetKnowledgeSourceStatusAsync(String, CancellationToken)	Retrieves the status of a knowledge source.

Name

Description

GetKnowledgeSourceStatusAsync(String, RequestContext)

[Protocol Method] Retrieves the status of a knowledge source.

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

GetKnowledgeSourceStatusAsync(String, CancellationToken)

Retrieves the status of a knowledge source.

GetKnowledgeSourceStatusAsync(String, RequestContext)

Source:: SearchIndexClient.cs

[Protocol Method] Retrieves the status of a knowledge source.

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

public virtual System.Threading.Tasks.Task<Azure.Response> GetKnowledgeSourceStatusAsync(string sourceName, Azure.RequestContext context);

abstract member GetKnowledgeSourceStatusAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetKnowledgeSourceStatusAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function GetKnowledgeSourceStatusAsync (sourceName As String, context As RequestContext) As Task(Of Response)

Parameters

sourceName: String

The name of the knowledge source.

context: RequestContext

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

Returns

Task<Response>

The response returned from the service.

Exceptions

ArgumentNullException

sourceName is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.

Applies to

GetKnowledgeSourceStatusAsync(String, CancellationToken)

Source:: SearchIndexClient.cs

Source:: SearchIndexClient.cs

Retrieves the status of a knowledge source.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeSourceStatus>> GetKnowledgeSourceStatusAsync(string sourceName, System.Threading.CancellationToken cancellationToken = default);

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

abstract member GetKnowledgeSourceStatusAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeSourceStatus>>
override this.GetKnowledgeSourceStatusAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeSourceStatus>>

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

Public Overridable Function GetKnowledgeSourceStatusAsync (sourceName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of KnowledgeSourceStatus))