Record Class GraphEdge

java.lang.Object
java.lang.Record
com.eqixiac.equinix.design.resilience.GraphEdge
Record Components:
id - stable id, unique in the graph (for example conn:aws@DC)
kind - what the edge stands for
from - one endpoint's node id
to - the other endpoint's node id
role - EdgeRole.PRIMARY or EdgeRole.STANDBY for redundant edges; null otherwise
capacityMbps - provisioned capacity in Mbps; null when unknown or not provisioned by the design (an unknown capacity never constrains the simulation, and the report says so)
roundTripMs - round-trip latency in ms; null when unknown (never a sentinel number)
latencyBasis - where roundTripMs came from (measured, estimated, intra-metro, assumed); null when unknown
carries - labels of the workloads the edge carries (a standby carriage is suffixed (standby))
note - detail for the reader, or null
public record GraphEdge(String id, EdgeKind kind, String from, String to, EdgeRole role, Double capacityMbps, Double roundTripMs, String latencyBasis, List<String> carries, String note) extends Record
One edge of a DesignGraph. Edges are bidirectional; from/to only fix the drawing order.

  • Constructor Details

  • Method Details

    • other

      public String other(String nodeId)
      Parameters:
      nodeId - a node id
      Returns:
      the other endpoint, or null when the edge does not touch the node

    • 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 EdgeKind kind()
      Returns the value of the kind record component.
      Returns:
      the value of the kind record component

    • from

      public String from()
      Returns the value of the from record component.
      Returns:
      the value of the from record component

    • to

      public String to()
      Returns the value of the to record component.
      Returns:
      the value of the to record component

    • role

      public EdgeRole role()
      Returns the value of the role record component.
      Returns:
      the value of the role record component

    • capacityMbps

      public Double capacityMbps()
      Returns the value of the capacityMbps record component.
      Returns:
      the value of the capacityMbps record component

    • roundTripMs

      public Double roundTripMs()
      Returns the value of the roundTripMs record component.
      Returns:
      the value of the roundTripMs record component

    • latencyBasis

      public String latencyBasis()
      Returns the value of the latencyBasis record component.
      Returns:
      the value of the latencyBasis record component

    • carries

      public List<String> carries()
      Returns the value of the carries record component.
      Returns:
      the value of the carries record component

    • note

      public String note()
      Returns the value of the note record component.
      Returns:
      the value of the note record component