Record Class DesignDecisionRecord

java.lang.Object

java.lang.Record

com.eqixiac.equinix.design.record.DesignDecisionRecord

Record Components:

schemaVersion - the record format version ("1")

title - the record's title

status - the decision's status (for example Proposed, Accepted)

generatedAt - when the record was produced

sdkVersion - the SDK version that produced it

specFingerprint - the spec's fingerprint()

spec - the spec the record is about

context - 1. context and requirements, restated from the spec

decision - 2. the recommended portfolio, its placement and its objective values and scores

alternatives - 3. the Pareto frontier and what each option trades away; what the constraints rejected

sensitivity - 4. how far the weights can move before the decision changes

cost - 5. priced lines, currency conversions, term and growth view, TCO and savings

resilience - 6. failure simulation: N-1 / N-2, single points of failure, availability, remediation

risks - 7. every engine's findings, de-duplicated, most severe first

provenance - 8. assumptions, data notes and as-of dates

implementation - 9. the deployment plan summary and how to reproduce the record

public record DesignDecisionRecord(String schemaVersion, String title, String status, Instant generatedAt, String sdkVersion, String specFingerprint, DesignSpec spec, RecordSection<DesignDecisionRecord.Context> context, RecordSection<DesignDecisionRecord.Decision> decision, RecordSection<DesignDecisionRecord.Alternatives> alternatives, RecordSection<DesignDecisionRecord.Sensitivity> sensitivity, RecordSection<DesignDecisionRecord.Cost> cost, RecordSection<DesignDecisionRecord.Resilience> resilience, RecordSection<DesignDecisionRecord.Risks> risks, RecordSection<DesignDecisionRecord.Provenance> provenance, RecordSection<DesignDecisionRecord.Implementation> implementation)
extends Record

A Design Decision Record: what was decided for a DesignSpec, why, on what evidence, and what would change the decision. Produced by DesignDecisionRecorder; immutable; round-trips through JSON (toJson(), fromJson(String)); renders as an ADR-style Markdown document (toMarkdown()); two records of the same design can be diffed (compare(DesignDecisionRecord, DesignDecisionRecord)).

Every section is a RecordSection: included, or skipped or failed with the reason. Figures keep their provenance: each cost line says whether it is a live price, a reference figure or an estimate; availability is computed from planning assumptions, not SLAs; latency counts say how many figures were measured.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	DesignDecisionRecord.Alternative	One option on the frontier.
static final record	DesignDecisionRecord.Alternatives	The options considered and rejected.
static final record	DesignDecisionRecord.Assumption	One assumption.
static final record	DesignDecisionRecord.Availability	One workload's estimated availability, under planning assumptions.
static final record	DesignDecisionRecord.ConstraintEffect	What one constraint did to the search.
static final record	DesignDecisionRecord.Context	The requirements, restated from the spec in words.
static final record	DesignDecisionRecord.Cost	What the recommended design costs, and where each figure came from.
static final record	DesignDecisionRecord.CostItem	One priced line.
static final record	DesignDecisionRecord.Decision	The recommended design.
static final record	DesignDecisionRecord.FxRate	An exchange rate a line was converted at.
static final record	DesignDecisionRecord.Growth	The design priced month by month under the spec's growth, with a term recommendation per item.
static final record	DesignDecisionRecord.GrowthItem	One item's growth and term decision.
static final record	DesignDecisionRecord.Implementation	How to build and reproduce the design.
static final record	DesignDecisionRecord.NearestOption	The frontier option nearest the recommendation.
static final record	DesignDecisionRecord.ObjectiveResult	One objective of the recommended design.
static final record	DesignDecisionRecord.PlanSummary	A deployment plan in brief.
static final record	DesignDecisionRecord.Provenance	What the record rests on.
static final record	DesignDecisionRecord.Reproduction	What pins the record's figures.
static final record	DesignDecisionRecord.Resilience	The failure simulation of the recommended design.
static final record	DesignDecisionRecord.Risk	One finding.
static enum	DesignDecisionRecord.RiskLevel	Finding severity, most severe first.
static final record	DesignDecisionRecord.Risks	Every finding, de-duplicated, most severe first.
static final record	DesignDecisionRecord.Savings	Egress savings of the private path.
static final record	DesignDecisionRecord.Sensitivity	How firm the decision is.
static final record	DesignDecisionRecord.Tco	The TCO archetype comparison.
static final record	DesignDecisionRecord.Value	The TCO and egress-savings view of the design's main cloud.
static final record	DesignDecisionRecord.Verdict	An N-1 or N-2 verdict.
static final record	DesignDecisionRecord.WeightRange	The share of one objective's weight over which the recommendation holds.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SCHEMA_VERSION	The record format version this release writes.

Constructor Summary

Constructors

Constructor

Description

DesignDecisionRecord(String schemaVersion, String title, String status, Instant generatedAt, String sdkVersion, String specFingerprint, DesignSpec spec, RecordSection<DesignDecisionRecord.Context> context, RecordSection<DesignDecisionRecord.Decision> decision, RecordSection<DesignDecisionRecord.Alternatives> alternatives, RecordSection<DesignDecisionRecord.Sensitivity> sensitivity, RecordSection<DesignDecisionRecord.Cost> cost, RecordSection<DesignDecisionRecord.Resilience> resilience, RecordSection<DesignDecisionRecord.Risks> risks, RecordSection<DesignDecisionRecord.Provenance> provenance, RecordSection<DesignDecisionRecord.Implementation> implementation)

Requires the identity fields.

Method Summary

Modifier and Type	Method	Description
RecordSection<DesignDecisionRecord.Alternatives>	alternatives()	Returns the value of the alternatives record component.
static DecisionDelta	compare(DesignDecisionRecord before, DesignDecisionRecord after)	What changed between two records (spec, recommendation, cost, resilience, risks), for example the same design re-run a quarter later.
RecordSection<DesignDecisionRecord.Context>	context()	Returns the value of the context record component.
RecordSection<DesignDecisionRecord.Cost>	cost()	Returns the value of the cost record component.
RecordSection<DesignDecisionRecord.Decision>	decision()	Returns the value of the decision record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static DesignDecisionRecord	fromJson(String json)	Reads a record written by toJson().
Instant	generatedAt()	Returns the value of the generatedAt record component.
final int	hashCode()	Returns a hash code value for this object.
RecordSection<DesignDecisionRecord.Implementation>	implementation()	Returns the value of the implementation record component.
RecordSection<DesignDecisionRecord.Provenance>	provenance()	Returns the value of the provenance record component.
DesignSpec	reproducibleSpec()	The spec with the exchange rates this record used pinned in commercial.exchangeRates, so running it again reproduces the cost figures.
RecordSection<DesignDecisionRecord.Resilience>	resilience()	Returns the value of the resilience record component.
RecordSection<DesignDecisionRecord.Risks>	risks()	Returns the value of the risks record component.
String	schemaVersion()	Returns the value of the schemaVersion record component.
String	sdkVersion()	Returns the value of the sdkVersion record component.
Map<String, RecordSection<?>>	sections()
RecordSection<DesignDecisionRecord.Sensitivity>	sensitivity()	Returns the value of the sensitivity record component.
DesignSpec	spec()	Returns the value of the spec record component.
String	specFingerprint()	Returns the value of the specFingerprint record component.
String	status()	Returns the value of the status record component.
String	title()	Returns the value of the title record component.
String	toJson()
String	toMarkdown()
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Field Details

SCHEMA_VERSION

public static final String SCHEMA_VERSION

The record format version this release writes.

See Also:

• Constant Field Values

Constructor Details

DesignDecisionRecord

public DesignDecisionRecord(String schemaVersion,
 String title,
 String status,
 Instant generatedAt,
 String sdkVersion,
 String specFingerprint,
 DesignSpec spec,
 RecordSection<DesignDecisionRecord.Context> context,
 RecordSection<DesignDecisionRecord.Decision> decision,
 RecordSection<DesignDecisionRecord.Alternatives> alternatives,
 RecordSection<DesignDecisionRecord.Sensitivity> sensitivity,
 RecordSection<DesignDecisionRecord.Cost> cost,
 RecordSection<DesignDecisionRecord.Resilience> resilience,
 RecordSection<DesignDecisionRecord.Risks> risks,
 RecordSection<DesignDecisionRecord.Provenance> provenance,
 RecordSection<DesignDecisionRecord.Implementation> implementation)

Requires the identity fields.

Method Details

toMarkdown

public String toMarkdown()

Returns:

the record as an ADR-style Markdown document

toJson

public String toJson()

Returns:

the record as indented JSON (ISO-8601 instants)

fromJson

public static DesignDecisionRecord fromJson(String json)

Reads a record written by toJson().

Parameters:

json - the document

Returns:

the record

Throws:

IllegalArgumentException - when the document is not a readable record

compare

public static DecisionDelta compare(DesignDecisionRecord before,
 DesignDecisionRecord after)

What changed between two records (spec, recommendation, cost, resilience, risks), for example the same design re-run a quarter later.

Parameters:

before - the earlier record

after - the later record

Returns:

the differences

reproducibleSpec

public DesignSpec reproducibleSpec()

The spec with the exchange rates this record used pinned in commercial.exchangeRates, so running it again reproduces the cost figures. The spec itself when nothing was converted.

Returns:

the reproducible spec

sections

public Map<String, RecordSection<?>> sections()

Returns:

the sections in document order, keyed by their heading

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.

schemaVersion

public String schemaVersion()

Returns the value of the schemaVersion record component.

Returns:

the value of the schemaVersion record component

title

public String title()

Returns the value of the title record component.

Returns:

the value of the title record component

status

public String status()

Returns the value of the status record component.

Returns:

the value of the status record component

generatedAt

public Instant generatedAt()

Returns the value of the generatedAt record component.

Returns:

the value of the generatedAt record component

sdkVersion

public String sdkVersion()

Returns the value of the sdkVersion record component.

Returns:

the value of the sdkVersion record component

specFingerprint

public String specFingerprint()

Returns the value of the specFingerprint record component.

Returns:

the value of the specFingerprint record component

spec

public DesignSpec spec()

Returns the value of the spec record component.

Returns:

the value of the spec record component

context

public RecordSection<DesignDecisionRecord.Context> context()

Returns the value of the context record component.

Returns:

the value of the context record component

decision

public RecordSection<DesignDecisionRecord.Decision> decision()

Returns the value of the decision record component.

Returns:

the value of the decision record component

alternatives

public RecordSection<DesignDecisionRecord.Alternatives> alternatives()

Returns the value of the alternatives record component.

Returns:

the value of the alternatives record component

sensitivity

public RecordSection<DesignDecisionRecord.Sensitivity> sensitivity()

Returns the value of the sensitivity record component.

Returns:

the value of the sensitivity record component

cost

public RecordSection<DesignDecisionRecord.Cost> cost()

Returns the value of the cost record component.

Returns:

the value of the cost record component

resilience

public RecordSection<DesignDecisionRecord.Resilience> resilience()

Returns the value of the resilience record component.

Returns:

the value of the resilience record component

risks

public RecordSection<DesignDecisionRecord.Risks> risks()

Returns the value of the risks record component.

Returns:

the value of the risks record component

provenance

public RecordSection<DesignDecisionRecord.Provenance> provenance()

Returns the value of the provenance record component.

Returns:

the value of the provenance record component

implementation

public RecordSection<DesignDecisionRecord.Implementation> implementation()

Returns the value of the implementation record component.

Returns:

the value of the implementation record component