SearchClient.GetDocumentCountAsync(CancellationToken) Method

Definition

Namespace:

Azure.Search.Documents

Assembly:

Azure.Search.Documents.dll

Package:

Azure.Search.Documents v11.5.1

Source:

SearchClient.cs

Retrieves a count of the number of documents in this search index.

public virtual System.Threading.Tasks.Task<Azure.Response<long>> GetDocumentCountAsync (System.Threading.CancellationToken cancellationToken = default);

abstract member GetDocumentCountAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<int64>>
override this.GetDocumentCountAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<int64>>

Public Overridable Function GetDocumentCountAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of Long))

Parameters

cancellationToken

CancellationToken

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

Returns

Task<Response<Int64>>

The number of documents in the search index.

Exceptions

RequestFailedException

Thrown when a failure is returned by the Search Service.