Record Class NuggetDiscovery.Result

java.lang.Object

java.lang.Record

org.j7m.middleware.operations.api.NuggetDiscovery.Result

Record Components:

records - visible records

returned - returned record count

totalAvailable - visible total before the applied limit

collectedAt - collection timestamp

partial - whether any source failed safely

warnings - bounded safe warnings

Enclosing class:

NuggetDiscovery

public static record NuggetDiscovery.Result(List<NuggetDiscovery.Record> records, int returned, int totalAvailable, Instant collectedAt, boolean partial, List<String> warnings)
extends Record

Discovery collection result.

Constructor Summary

Constructors

Constructor	Description
Result(List<NuggetDiscovery.Record> records, int returned, int totalAvailable, Instant collectedAt, boolean partial, List<String> warnings)	Creates an immutable discovery result.

Method Summary

Modifier and Type	Method	Description
Instant	collectedAt()	Returns the value of the collectedAt record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
boolean	partial()	Returns the value of the partial record component.
List<NuggetDiscovery.Record>	records()	Returns the value of the records record component.
int	returned()	Returns the value of the returned record component.
final String	toString()	Returns a string representation of this record class.
int	totalAvailable()	Returns the value of the totalAvailable record component.
List<String>	warnings()	Returns the value of the warnings record component.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Result

public Result(List<NuggetDiscovery.Record> records,
 int returned,
 int totalAvailable,
 Instant collectedAt,
 boolean partial,
 List<String> warnings)

Creates an immutable discovery result.

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

records

public List<NuggetDiscovery.Record> records()

Returns the value of the records record component.

Returns:

the value of the records record component

returned

public int returned()

Returns the value of the returned record component.

Returns:

the value of the returned record component

totalAvailable

public int totalAvailable()

Returns the value of the totalAvailable record component.

Returns:

the value of the totalAvailable record component

collectedAt

public Instant collectedAt()

Returns the value of the collectedAt record component.

Returns:

the value of the collectedAt record component

partial

public boolean partial()

Returns the value of the partial record component.

Returns:

the value of the partial record component

warnings

public List<String> warnings()

Returns the value of the warnings record component.

Returns:

the value of the warnings record component