IndexStatisticsSummary Class

Definition

Namespace:: Azure.Search.Documents.Indexes.Models

Assembly:: Azure.Search.Documents.dll

Package:: Azure.Search.Documents v11.7.0-beta.7

Source:: IndexStatisticsSummary.cs

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.

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

public class IndexStatisticsSummary : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.IndexStatisticsSummary>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.IndexStatisticsSummary>

type IndexStatisticsSummary = class
    interface IJsonModel<IndexStatisticsSummary>
    interface IPersistableModel<IndexStatisticsSummary>

Public Class IndexStatisticsSummary
Implements IJsonModel(Of IndexStatisticsSummary), IPersistableModel(Of IndexStatisticsSummary)

Inheritance: Object
IndexStatisticsSummary

Implements: IJsonModel<IndexStatisticsSummary> IPersistableModel<IndexStatisticsSummary> IPersistableModel<T>

Properties

DocumentCount	The number of documents in the index.
Name	The name of the index.
StorageSize	The amount of storage in bytes consumed by the index.
VectorIndexSize	The amount of memory in bytes consumed by vectors in the index.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<IndexStatisticsSummary>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<IndexStatisticsSummary>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<IndexStatisticsSummary>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<IndexStatisticsSummary>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<IndexStatisticsSummary>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Applies to