IIndexOperations.GetStatisticsAsync Method (String, CancellationToken)

Applies To: Microsoft Azure

Returns statistics for the given index, including a document count and storage usage. (see https://msdn.microsoft.com/library/azure/dn798942.aspx for more information)

Namespace:   Microsoft.Azure.Search
Assembly:  Microsoft.Azure.Search (in Microsoft.Azure.Search.dll)

Syntax

Task<IndexGetStatisticsResponse> GetStatisticsAsync(
    string indexName,
    CancellationToken cancellationToken
)

Task<IndexGetStatisticsResponse^>^ GetStatisticsAsync(
    String^ indexName,
    CancellationToken cancellationToken
)

abstract GetStatisticsAsync : 
        indexName:string *
        cancellationToken:CancellationToken -> Task<IndexGetStatisticsResponse>

Function GetStatisticsAsync (
    indexName As String,
    cancellationToken As CancellationToken
) As Task(Of IndexGetStatisticsResponse)

Parameters

• indexName
  Type: System.String

  The name of the index for which to retrieve statistics.

• cancellationToken
  Type: System.Threading.CancellationToken

  Cancellation token.

Return Value

Type: System.Threading.Tasks.Task<IndexGetStatisticsResponse>

Statistics for a given index. Statistics are collected periodically and are not guaranteed to always be up-to-date.

See Also

IIndexOperations Interface
Microsoft.Azure.Search Namespace

Return to top