Record Class NuggetIntrospection.ComponentSummary

java.lang.Object

java.lang.Record

org.j7m.middleware.operations.api.NuggetIntrospection.ComponentSummary

Record Components:

component - stable component id

availability - component availability

health - health state

readiness - readiness state

required - whether component is required for this nugget

safeReason - safe status reason

metadata - redacted metadata

Enclosing class:

NuggetIntrospection

public static record NuggetIntrospection.ComponentSummary(String component, NuggetIntrospection.Availability availability, NuggetIntrospection.HealthState health, NuggetIntrospection.ReadinessState readiness, boolean required, String safeReason, Map<String,String> metadata)
extends Record

Component status summary.

Constructor Summary

Constructors

Constructor	Description
ComponentSummary(String component, NuggetIntrospection.Availability availability, NuggetIntrospection.HealthState health, NuggetIntrospection.ReadinessState readiness, boolean required, String safeReason, Map<String,String> metadata)	Creates immutable component metadata.

Method Summary

Modifier and Type	Method	Description
NuggetIntrospection.Availability	availability()	Returns the value of the availability record component.
String	component()	Returns the value of the component 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.
NuggetIntrospection.HealthState	health()	Returns the value of the health record component.
Map<String,String>	metadata()	Returns the value of the metadata record component.
NuggetIntrospection.ReadinessState	readiness()	Returns the value of the readiness record component.
boolean	required()	Returns the value of the required record component.
String	safeReason()	Returns the value of the safeReason record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

ComponentSummary

public ComponentSummary(String component,
 NuggetIntrospection.Availability availability,
 NuggetIntrospection.HealthState health,
 NuggetIntrospection.ReadinessState readiness,
 boolean required,
 String safeReason,
 Map<String,String> metadata)

Creates immutable component 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.

component

public String component()

Returns the value of the component record component.

Returns:

the value of the component record component

availability

public NuggetIntrospection.Availability availability()

Returns the value of the availability record component.

Returns:

the value of the availability record component

health

public NuggetIntrospection.HealthState health()

Returns the value of the health record component.

Returns:

the value of the health record component

readiness

public NuggetIntrospection.ReadinessState readiness()

Returns the value of the readiness record component.

Returns:

the value of the readiness record component

required

public boolean required()

Returns the value of the required record component.

Returns:

the value of the required record component

safeReason

public String safeReason()

Returns the value of the safeReason record component.

Returns:

the value of the safeReason record component

metadata

public Map<String,String> metadata()

Returns the value of the metadata record component.

Returns:

the value of the metadata record component