IIndexesOperations.GetStatisticsWithHttpMessagesAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Search

Assembly:: Microsoft.Azure.Search.Service.dll

Package:: Microsoft.Azure.Search.Service v10.1.0

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.

Returns statistics for the given index, including a document count and storage usage. https://docs.microsoft.com/rest/api/searchservice/Get-Index-Statistics

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Search.Models.IndexGetStatisticsResult>> GetStatisticsWithHttpMessagesAsync (string indexName, Microsoft.Azure.Search.Models.SearchRequestOptions searchRequestOptions = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetStatisticsWithHttpMessagesAsync : string * Microsoft.Azure.Search.Models.SearchRequestOptions * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Search.Models.IndexGetStatisticsResult>>

Public Function GetStatisticsWithHttpMessagesAsync (indexName As String, Optional searchRequestOptions As SearchRequestOptions = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of IndexGetStatisticsResult))

Parameters

indexName: String

The name of the index for which to retrieve statistics.

searchRequestOptions: SearchRequestOptions

Additional parameters for the operation

customHeaders: Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken: CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<IndexGetStatisticsResult>>

Exceptions

CloudException

Thrown when the operation returned an invalid status code

SerializationException

Thrown when unable to deserialize the response

ValidationException

Thrown when a required parameter is null

Applies to