Package io.fluxcapacitor.common.api.tracking

Class ReadFromIndexResult

java.lang.Object

io.fluxcapacitor.common.api.tracking.ReadFromIndexResult

All Implemented Interfaces:

JsonType, RequestResult

public class ReadFromIndexResult
extends Object
implements RequestResult

Result for a ReadFromIndex request.

Contains the messages read from the specified index and accompanying metadata for auditing and metrics logging.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ReadFromIndexResult.Metric	Metric representation of a ReadFromIndexResult, used for internal monitoring and analytics.

Constructor Summary

Constructors

Constructor	Description
ReadFromIndexResult()

Method Summary

Modifier and Type	Method	Description
ReadFromIndexResult.Metric	toMetric()	Converts this result into a metric representation, which includes the number of messages and timestamp.

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

ReadFromIndexResult

public ReadFromIndexResult()

Method Details

toMetric

public ReadFromIndexResult.Metric toMetric()

Converts this result into a metric representation, which includes the number of messages and timestamp.

Specified by:

toMetric in interface JsonType

Returns:

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