SearchIndexClient.GetIndexStatistics Method

Definition

Namespace:

Azure.Search.Documents.Indexes

Assembly:

Azure.Search.Documents.dll

Package:

Azure.Search.Documents v12.0.0

Overloads

Name	Description
GetIndexStatistics(String, CancellationToken)	Returns statistics for the given index, including a document count and storage usage.
GetIndexStatistics(String, RequestContext)	[Protocol Method] Returns statistics for the given index, including a document count and storage usage. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

GetIndexStatistics(String, CancellationToken)

Source:

SearchIndexClient.cs

Returns statistics for the given index, including a document count and storage usage.

public virtual Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndexStatistics> GetIndexStatistics(string indexName, System.Threading.CancellationToken cancellationToken = default);

abstract member GetIndexStatistics : string * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndexStatistics>
override this.GetIndexStatistics : string * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndexStatistics>

Public Overridable Function GetIndexStatistics (indexName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of SearchIndexStatistics)

Parameters

indexName

String

The name of the index.

cancellationToken

CancellationToken

The cancellation token that can be used to cancel the operation.

Returns

Response<SearchIndexStatistics>

The Response<T> from the server containing SearchIndexStatistics names.

Exceptions

ArgumentNullException

indexName is null.

ArgumentException

indexName is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

GetIndexStatistics(String, RequestContext)

Source:

SearchIndexClient.cs

[Protocol Method] Returns statistics for the given index, including a document count and storage usage.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

public virtual Azure.Response GetIndexStatistics(string indexName, Azure.RequestContext context);

abstract member GetIndexStatistics : string * Azure.RequestContext -> Azure.Response
override this.GetIndexStatistics : string * Azure.RequestContext -> Azure.Response

Public Overridable Function GetIndexStatistics (indexName As String, context As RequestContext) As Response

Parameters

indexName

String

The name of the index.

context

RequestContext

The request options, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

indexName is null.

ArgumentException

indexName is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.