IIndexOperations.GetStatisticsAsync Method

Article
03/04/2015
2 minutes to read

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

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

Usage

'Usage
Dim instance As IIndexOperations
Dim indexName As String
Dim cancellationToken As CancellationToken
Dim returnValue As Task(Of IndexGetStatisticsResponse)

returnValue = instance.GetStatisticsAsync(indexName, cancellationToken)

Syntax

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

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

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

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

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

Parameters

indexName
The name of the index for which to retrieve statistics.

cancellationToken
Cancellation token.

Return Value

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

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Vista, Windows 7, Windows Server 2008, Windows 8.1, Windows Server 2012 R2, Windows 8 and Windows Server 2012