Record Class FailureScenario

java.lang.Object

java.lang.Record

com.eqixiac.equinix.design.resilience.FailureScenario

Record Components:

id - stable id (for example metro:DC, conn:aws@NY, pair:metro:DC+conn:aws@NY)

kind - what fails

description - readable description

failedNodes - node ids taken away (every edge touching them fails too)

failedEdges - edge ids taken away

components - for a ScenarioKind.PAIR, the ids of the two single scenarios; empty otherwise

public record FailureScenario(String id, ScenarioKind kind, String description, List<String> failedNodes, List<String> failedEdges, List<String> components)
extends Record

One failure to simulate: the graph nodes and edges it takes away.

Constructor Summary

Constructors

Constructor	Description
FailureScenario(String id, ScenarioKind kind, String description, List<String> failedNodes, List<String> failedEdges, List<String> components)	Makes the lists immutable and non-null.

Method Summary

Modifier and Type	Method	Description
static FailureScenario	baseline()
List<String>	components()	Returns the value of the components record component.
String	description()	Returns the value of the description record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
List<String>	failedEdges()	Returns the value of the failedEdges record component.
List<String>	failedNodes()	Returns the value of the failedNodes record component.
final int	hashCode()	Returns a hash code value for this object.
String	id()	Returns the value of the id record component.
ScenarioKind	kind()	Returns the value of the kind 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

FailureScenario

public FailureScenario(String id,
 ScenarioKind kind,
 String description,
 List<String> failedNodes,
 List<String> failedEdges,
 List<String> components)

Makes the lists immutable and non-null.

Method Details

baseline

public static FailureScenario baseline()

Returns:

the scenario in which nothing fails

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.

id

public String id()

Returns the value of the id record component.

Returns:

the value of the id record component

kind

public ScenarioKind kind()

Returns the value of the kind record component.

Returns:

the value of the kind record component

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component

failedNodes

public List<String> failedNodes()

Returns the value of the failedNodes record component.

Returns:

the value of the failedNodes record component

failedEdges

public List<String> failedEdges()

Returns the value of the failedEdges record component.

Returns:

the value of the failedEdges record component

components

public List<String> components()

Returns the value of the components record component.

Returns:

the value of the components record component