Package io.fluxcapacitor.common.api.search

Class GetDocumentStatsResult

java.lang.Object

io.fluxcapacitor.common.api.search.GetDocumentStatsResult

All Implemented Interfaces:

JsonType, RequestResult

public class GetDocumentStatsResult
extends Object
implements RequestResult

Response to a GetDocumentStats request.

Contains aggregated statistics for documents that matched a SearchQuery, grouped and computed in-memory. Statistics include common numeric metrics like count, min, max, sum, and average, organized per field and optional grouping.

For performance-sensitive use cases or large data sets, prefer GetFacetStats, which is computed by the backing store and generally faster.

See Also:

• GetDocumentStats
• DocumentStats

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetDocumentStatsResult.Metric	Compact summary of the result, used for internal monitoring purposes.

Constructor Summary

Constructors

Constructor	Description
GetDocumentStatsResult()

Method Summary

Modifier and Type	Method	Description
GetDocumentStatsResult.Metric	toMetric()	Returns a lightweight summary of this result for logging or metric tracking.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.fluxcapacitor.common.api.RequestResult

getRequestId, getTimestamp

Constructor Details

GetDocumentStatsResult

public GetDocumentStatsResult()

Method Details

toMetric

public GetDocumentStatsResult.Metric toMetric()

Returns a lightweight summary of this result for logging or metric tracking.

Specified by:

toMetric in interface JsonType

Returns:

a safe and compact object suitable for serialization to the metrics log