SearchClient.GetDocumentCount(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 Azure.Response<long> GetDocumentCount (System.Threading.CancellationToken cancellationToken = default);

abstract member GetDocumentCount : System.Threading.CancellationToken -> Azure.Response<int64>
override this.GetDocumentCount : System.Threading.CancellationToken -> Azure.Response<int64>

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

Parameters

cancellationToken

CancellationToken

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

Returns

Response<Int64>

The number of documents in the search index.

Exceptions

RequestFailedException

Thrown when a failure is returned by the Search Service.