Record Class NuggetIntrospection.Result<T>

java.lang.Object

java.lang.Record

org.j7m.middleware.operations.api.NuggetIntrospection.Result<T>

Type Parameters:

T - response value type

Record Components:

admitted - whether Phase 7.1 admission was accepted

authorized - whether authorization allowed this read

category - operation category

collectedAt - collection timestamp

partial - whether optional component data is partial

value - response value, or null on failure

error - normalized safe error, or null

warnings - safe warnings

metadata - safe metadata

Enclosing class:

NuggetIntrospection

public static record NuggetIntrospection.Result<T>(boolean admitted, boolean authorized, NuggetIntrospection.Category category, Instant collectedAt, boolean partial, T value, RemoteError error, List<String> warnings, Map<String,String> metadata)
extends Record

Safe operation result envelope.

Constructor Summary

Constructors

Constructor	Description
Result(boolean admitted, boolean authorized, NuggetIntrospection.Category category, Instant collectedAt, boolean partial, T value, RemoteError error, List<String> warnings, Map<String,String> metadata)	Creates immutable result metadata.

Method Summary

Modifier and Type	Method	Description
boolean	admitted()	Returns the value of the admitted record component.
boolean	authorized()	Returns the value of the authorized record component.
NuggetIntrospection.Category	category()	Returns the value of the category record component.
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.
RemoteError	error()	Returns the value of the error record component.
final int	hashCode()	Returns a hash code value for this object.
Map<String,String>	metadata()	Returns the value of the metadata record component.
boolean	partial()	Returns the value of the partial record component.
final String	toString()	Returns a string representation of this record class.
T	value()	Returns the value of the value 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(boolean admitted,
 boolean authorized,
 NuggetIntrospection.Category category,
 Instant collectedAt,
 boolean partial,
 T value,
 RemoteError error,
 List<String> warnings,
 Map<String,String> metadata)

Creates immutable result metadata.

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.

admitted

public boolean admitted()

Returns the value of the admitted record component.

Returns:

the value of the admitted record component

authorized

public boolean authorized()

Returns the value of the authorized record component.

Returns:

the value of the authorized record component

category

public NuggetIntrospection.Category category()

Returns the value of the category record component.

Returns:

the value of the category 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

value

public T value()

Returns the value of the value record component.

Returns:

the value of the value record component

error

public RemoteError error()

Returns the value of the error record component.

Returns:

the value of the error record component

warnings

public List<String> warnings()

Returns the value of the warnings record component.

Returns:

the value of the warnings record component

metadata

public Map<String,String> metadata()

Returns the value of the metadata record component.

Returns:

the value of the metadata record component