Package io.fluxcapacitor.common.api.search

Class GetDocumentResult

java.lang.Object

io.fluxcapacitor.common.api.search.GetDocumentResult

All Implemented Interfaces:

JsonType, RequestResult

public class GetDocumentResult
extends Object
implements RequestResult

Result returned in response to a GetDocument request.

This result includes a single SerializedDocument identified by its ID and collection, or null if the document could not be found.

See Also:

• GetDocument
• SerializedDocument

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetDocumentResult.Metric	Lightweight structure for representing GetDocumentResult in Flux metrics logs.

Constructor Summary

Constructors

Constructor	Description
GetDocumentResult()

Method Summary

Modifier and Type	Method	Description
GetDocumentResult.Metric	toMetric()	Converts this result to a compact representation for metrics logging.

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

GetDocumentResult

public GetDocumentResult()

Method Details

toMetric

public GetDocumentResult.Metric toMetric()

Converts this result to a compact representation for metrics logging.

Specified by:

toMetric in interface JsonType

Returns:

a GetDocumentResult.Metric containing only the response timestamp.