IGeneratedSummaryStats Interface

In addition to the normal summary tree + stats, this contains additional stats only relevant at the root of the tree.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/container-runtime/legacy.

For more information about our API support guarantees, see here.

Signature

export interface IGeneratedSummaryStats extends ISummaryStats

Extends: ISummaryStats

Properties

Property	Alerts	Modifiers	Type	Description
dataStoreCount	Beta	readonly	number	The total number of data stores in the container.
gcBlobNodeCount	Beta	optional, readonly	number	The number of gc blobs in this summary.
gcStateUpdatedDataStoreCount	Beta	optional, readonly	number	The number of data stores whose GC reference state was updated in this summary.
gcTotalBlobsSize	Beta	optional, readonly	number	The size of the gc blobs in this summary.
summarizedDataStoreCount	Beta	readonly	number	The number of data stores that were summarized in this summary.
summaryNumber	Beta	readonly	number	The summary number for a container's summary. Incremented on summaries throughout its lifetime.

Property Details

dataStoreCount

The total number of data stores in the container.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

readonly dataStoreCount: number;

Type: number

gcBlobNodeCount

The number of gc blobs in this summary.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

readonly gcBlobNodeCount?: number;

Type: number

gcStateUpdatedDataStoreCount

The number of data stores whose GC reference state was updated in this summary.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

readonly gcStateUpdatedDataStoreCount?: number;

Type: number

gcTotalBlobsSize

The size of the gc blobs in this summary.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

readonly gcTotalBlobsSize?: number;

Type: number

summarizedDataStoreCount

The number of data stores that were summarized in this summary.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

readonly summarizedDataStoreCount: number;

Type: number

summaryNumber

The summary number for a container's summary. Incremented on summaries throughout its lifetime.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

readonly summaryNumber: number;

Type: number