SearchIndexClient.GetIndexStatsSummary 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.
Overloads
| Name | Description |
|---|---|
| GetIndexStatsSummary(String, Nullable<Int32>, Nullable<ListingSearchType>, CancellationToken) |
Retrieves a summary of statistics for all indexes in the search service. |
| GetIndexStatsSummary(String, Nullable<Int32>, String, RequestContext) |
[Protocol Method] Retrieves a summary of statistics for all indexes in the search service.
|
GetIndexStatsSummary(String, Nullable<Int32>, Nullable<ListingSearchType>, CancellationToken)
- Source:
- SearchIndexClient.cs
Retrieves a summary of statistics for all indexes in the search service.
public virtual Azure.Pageable<Azure.Search.Documents.Indexes.Models.IndexStatisticsSummary> GetIndexStatsSummary(string search = default, int? pageSize = default, Azure.Search.Documents.Indexes.Models.ListingSearchType? searchType = default, System.Threading.CancellationToken cancellationToken = default);abstract member GetIndexStatsSummary : string * Nullable<int> * Nullable<Azure.Search.Documents.Indexes.Models.ListingSearchType> * System.Threading.CancellationToken -> Azure.Pageable<Azure.Search.Documents.Indexes.Models.IndexStatisticsSummary>
override this.GetIndexStatsSummary : string * Nullable<int> * Nullable<Azure.Search.Documents.Indexes.Models.ListingSearchType> * System.Threading.CancellationToken -> Azure.Pageable<Azure.Search.Documents.Indexes.Models.IndexStatisticsSummary>Public Overridable Function GetIndexStatsSummary (Optional search As String = Nothing, Optional pageSize As Nullable(Of Integer) = Nothing, Optional searchType As Nullable(Of ListingSearchType) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of IndexStatisticsSummary)Parameters
- search
- String
A string used to narrow down the listing so that fewer results need to be paged through. If omitted or an empty string is passed, no narrowing is applied.
The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default.
- searchType
- Nullable<ListingSearchType>
Specifies how the search parameter is interpreted. Currently only 'prefix' is supported.
- cancellationToken
- CancellationToken
The cancellation token that can be used to cancel the operation.
Returns
Exceptions
Service returned a non-success status code.
Applies to
GetIndexStatsSummary(String, Nullable<Int32>, String, RequestContext)
- Source:
- SearchIndexClient.cs
[Protocol Method] Retrieves a summary of statistics for all indexes in the search service.
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
public virtual Azure.Pageable<BinaryData> GetIndexStatsSummary(string search, int? pageSize, string searchType, Azure.RequestContext context);abstract member GetIndexStatsSummary : string * Nullable<int> * string * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetIndexStatsSummary : string * Nullable<int> * string * Azure.RequestContext -> Azure.Pageable<BinaryData>Public Overridable Function GetIndexStatsSummary (search As String, pageSize As Nullable(Of Integer), searchType As String, context As RequestContext) As Pageable(Of BinaryData)Parameters
- search
- String
A string used to narrow down the listing so that fewer results need to be paged through. If omitted or an empty string is passed, no narrowing is applied.
The maximum number of items to return in a single page. The server enforces a maximum; if omitted, the server determines a suitable default.
- searchType
- String
Specifies how the search parameter is interpreted. Currently only 'prefix' is supported.
- context
- RequestContext
The request options, which can override default behaviors of the client pipeline on a per-call basis.
Returns
The response returned from the service.
Exceptions
Service returned a non-success status code.
