Package com.eqixiac.equinix.design.spi

package com.eqixiac.equinix.design.spi

Extension points of the design engines. Everything an engine decides with is one of these small interfaces, so a new objective, limit, pricing source or search strategy is added by implementing one, never by editing an engine.

• DesignContext: the read-only facts of one run (the DesignSpec, the metro catalogue, latency, cloud reachability, the cost model). Built once, so the other plug-ins are pure functions of it and can be unit-tested without a network.
• CandidateGenerator: which metros are worth considering.
• Constraint: a hard limit on a metro or a portfolio.
• Objective: one measurable quality of a portfolio (latency, cost, resilience...), in its own unit, with a direction.
• CostModel: prices a portfolio line by line, with the source and an uncertainty range for every figure.
• Solver: searches portfolios and returns the trade-off frontier plus the option the weights recommend.

A portfolio (MetroPortfolio) is the set of metros a design deploys in. Objectives are evaluated on portfolios, not on single metros, because the qualities that matter (worst-case latency, total cost, surviving a metro loss) are properties of the set.

Third-party plug-ins are discovered through ServiceLoader: see DesignPlugin.

Related Packages

Package	Description
com.eqixiac.equinix.design	Value-add design engines built on top of the Equinix API clients: placement optimization, deployment planning, pricing/TCO analysis, peering intelligence, latency physics, and infrastructure-as-code export.

Class	Description
CandidateGenerator	Chooses which metros a Solver considers.
Constraint	A hard limit.
ConstraintVerdict	The outcome of checking one Constraint against one portfolio.
CostLine	One priced item of a portfolio, with where the figure came from and how far it could be off.
CostLine.Conversion	How a line was restated in the comparison currency.
CostModel	Prices a portfolio.
CurrencyConverter	Restates an amount in another currency, so a design whose prices come back in several currencies (the live Fabric price search quotes London in GBP, Frankfurt in EUR, Tokyo in JPY) is priced and ranked in one.
CurrencyConverter.Converted	An amount restated in another currency.
CurrencyConverter.Kind	Where a rate came from, in precedence order.
CurrencyConverter.Rate	A rate between two currencies.
DesignContext	The read-only facts of one design run.
DesignOption	One feasible design with everything measured about it.
DesignPlugin	A bundle of extra objectives and constraints contributed by a library on the classpath.
DesignSolution	What a Solver found.
Direction	Whether a smaller or a larger Objective value is better.
MetroFacts	What a run knows about one metro, taken from the live Fabric catalogue.
MetroPortfolio	The set of metros one candidate design deploys in.
Objective	One measurable quality of a portfolio, in its own unit.
ObjectiveValue	What an Objective measured for one portfolio.
PortfolioCost	The priced lines of one portfolio plus the items that could not be priced.
SolveProblem	Everything a Solver needs.
Solver	Searches the portfolios a SolveProblem allows and returns the trade-off frontier and the recommended option.
ValueScale	How an objective's raw value becomes a 0..100 score (100 = best) for the weighted ranking.
ValueScale.Anchored	Linear between two fixed anchors, clamped.
ValueScale.Percent	The value is a percentage: it is the score when larger is better, and 100 minus it otherwise.
ValueScale.Range	Min-max over the options being ranked.
ValueScale.RatioToBest	The ratio to the best value: an option 7% dearer than the cheapest scores about 93, one twice as dear scores 50.