SearchClient.GetDocumentCountAsync(CancellationToken) Method
Definition
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.
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
The number of documents in the search index.
Exceptions
Thrown when a failure is returned by the Search Service.
Applies to
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Azure SDK for .NET