Record Class DesignDecisionRecord.Risk

java.lang.Object

java.lang.Record

com.eqixiac.equinix.design.record.DesignDecisionRecord.Risk

Record Components:

severity - how serious

source - the engine that raised it (optimizer, resilience, cost, plan, estate, peering, spec, record)

category - the engine's category

statement - the finding

recommendation - what to do, or null

Enclosing class:

DesignDecisionRecord

public static record DesignDecisionRecord.Risk(DesignDecisionRecord.RiskLevel severity, String source, String category, String statement, String recommendation)
extends Record

One finding.

Constructor Summary

Constructors

Constructor	Description
Risk(DesignDecisionRecord.RiskLevel severity, String source, String category, String statement, String recommendation)	Creates an instance of a Risk record class.

Method Summary

Modifier and Type	Method	Description
String	category()	Returns the value of the category 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.
String	recommendation()	Returns the value of the recommendation record component.
DesignDecisionRecord.RiskLevel	severity()	Returns the value of the severity record component.
String	source()	Returns the value of the source record component.
String	statement()	Returns the value of the statement 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

Risk

public Risk(DesignDecisionRecord.RiskLevel severity,
 String source,
 String category,
 String statement,
 String recommendation)

Creates an instance of a Risk record class.

Parameters:

severity - the value for the severity record component

source - the value for the source record component

category - the value for the category record component

statement - the value for the statement record component

recommendation - the value for the recommendation 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.

severity

public DesignDecisionRecord.RiskLevel severity()

Returns the value of the severity record component.

Returns:

the value of the severity record component

source

public String source()

Returns the value of the source record component.

Returns:

the value of the source record component

category

public String category()

Returns the value of the category record component.

Returns:

the value of the category record component

statement

public String statement()

Returns the value of the statement record component.

Returns:

the value of the statement record component

recommendation

public String recommendation()

Returns the value of the recommendation record component.

Returns:

the value of the recommendation record component