Package io.fluxcapacitor.common.api.search

Class GetDocumentsResult

java.lang.Object

io.fluxcapacitor.common.api.search.GetDocumentsResult

All Implemented Interfaces:

JsonType, RequestResult

public class GetDocumentsResult
extends Object
implements RequestResult

Result returned in response to a GetDocuments request.

This result includes a collection of documents identified by their 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	GetDocumentsResult.Metric	Lightweight structure for representing GetDocumentsResult in Flux metrics logs.

Constructor Summary

Constructors

Constructor	Description
GetDocumentsResult()

Method Summary

Modifier and Type	Method	Description
GetDocumentsResult.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

GetDocumentsResult

public GetDocumentsResult()

Method Details

toMetric

public GetDocumentsResult.Metric toMetric()

Converts this result to a compact representation for metrics logging.

Specified by:

toMetric in interface JsonType

Returns:

a GetDocumentsResult.Metric containing only the response timestamp.