Module xorcery.health.api

Package com.exoreaction.xorcery.health.api

Record Class HealthCheckResult

Object

Record

HealthCheckResult

public record HealthCheckResult(HealthStatus status, String unhealthyMessage, Throwable unhealthyThrowable, JsonNode info)
extends Record

Constructor Summary

Constructors

Constructor	Description
HealthCheckResult()
HealthCheckResult(HealthStatus status, String unhealthyMessage, Throwable unhealthyThrowable, JsonNode info)	Creates an instance of a HealthCheckResult record class.
HealthCheckResult(JsonNode info)
HealthCheckResult(String unhealthyMessage)
HealthCheckResult(String unhealthyMessage, JsonNode info)
HealthCheckResult(String unhealthyMessage, Throwable unhealthyThrowable)
HealthCheckResult(String unhealthyMessage, Throwable unhealthyThrowable, JsonNode info)
HealthCheckResult(Throwable unhealthyThrowable, JsonNode info)

Method Summary

Modifier and Type	Method	Description
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.
JsonNode	info()	Returns the value of the info record component.
HealthStatus	status()	Returns the value of the status record component.
final String	toString()	Returns a string representation of this record class.
String	unhealthyMessage()	Returns the value of the unhealthyMessage record component.
Throwable	unhealthyThrowable()	Returns the value of the unhealthyThrowable record component.

Methods inherited from class Object

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

Constructor Details

HealthCheckResult

public HealthCheckResult()

HealthCheckResult

public HealthCheckResult(JsonNode info)

HealthCheckResult

public HealthCheckResult(String unhealthyMessage)

HealthCheckResult

public HealthCheckResult(String unhealthyMessage,
 JsonNode info)

HealthCheckResult

public HealthCheckResult(Throwable unhealthyThrowable,
 JsonNode info)

HealthCheckResult

public HealthCheckResult(String unhealthyMessage,
 Throwable unhealthyThrowable)

HealthCheckResult

public HealthCheckResult(String unhealthyMessage,
 Throwable unhealthyThrowable,
 JsonNode info)

HealthCheckResult

public HealthCheckResult(HealthStatus status,
 String unhealthyMessage,
 Throwable unhealthyThrowable,
 JsonNode info)

Creates an instance of a HealthCheckResult record class.

Parameters:

status - the value for the status record component

unhealthyMessage - the value for the unhealthyMessage record component

unhealthyThrowable - the value for the unhealthyThrowable record component

info - the value for the info record component

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. All components in this record class are compared with Objects::equals(Object,Object).

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.

status

public HealthStatus status()

Returns the value of the status record component.

Returns:

the value of the status record component

unhealthyMessage

public String unhealthyMessage()

Returns the value of the unhealthyMessage record component.

Returns:

the value of the unhealthyMessage record component

unhealthyThrowable

public Throwable unhealthyThrowable()

Returns the value of the unhealthyThrowable record component.

Returns:

the value of the unhealthyThrowable record component

info

public JsonNode info()

Returns the value of the info record component.

Returns:

the value of the info record component