Uses of Record Class
com.eqixiac.equinix.design.spec.DesignSpec

Packages that use DesignSpec

Package	Description
com.eqixiac.equinix	Root package for the Equinix Java SDK.
com.eqixiac.equinix.design.constraint	The built-in hard limits of the Metro Optimizer: one small, pure Constraint per field of DesignConstraints, plus the workload rules, the single-currency budget and the every-metro-used rule.
com.eqixiac.equinix.design.cost	Pricing of candidate designs: RateCardCostModel is the CostModel the Metro Optimizer uses, pricing each metro's needs from a RateCard with every line's source and a range from PriceBands.
com.eqixiac.equinix.design.optimizer	The Metro Optimizer: which set of Equinix metros best serves a DesignSpec, as a multi-objective search.
com.eqixiac.equinix.design.optimizer.context	The facts of a Metro Optimizer run: CatalogDesignContext (an in-memory DesignContext with a builder), FabricCatalogLoader (builds one from live Fabric data, read-only) and ProviderCatalog (which metros each cloud is reachable from).
com.eqixiac.equinix.design.optimizer.model	Immutable value types for the Metro Optimization Engine - the request side (sites, provider requirements, workload specs, constraints, scoring weights) and the result side (ranked recommendations, scores, topology, latency matrix, risk assessment, cost estimates).
com.eqixiac.equinix.design.optimizer.wizard	The Deployment Wizard: turns a metro OptimizationResult into an executable DeploymentPlan - Cloud Routers, provider connections, inter-metro backbone links, and routing protocols, with bandwidth-aware profile selection and honestly-reconciled pricing.
com.eqixiac.equinix.design.peering	Peering Intelligence: interconnection analysis combining PeeringDB IX/facility data with the live Equinix Fabric catalog.
com.eqixiac.equinix.design.record	The Design Decision Record: the one document an architect hands to a review board for a DesignSpec.
com.eqixiac.equinix.design.resilience	Failure analysis of a design.
com.eqixiac.equinix.design.spec	The shared design document every design engine reads: DesignSpec.
com.eqixiac.equinix.design.spi	Extension points of the design engines.
com.eqixiac.equinix.design.value	The value-realization layer of the design API: design-time cost modelling that puts a money figure on an interconnect decision.
com.eqixiac.equinix.design.value.savings	Cloud-egress savings estimation: how much routing a monthly data volume over an Equinix private interconnect saves versus egressing it to the public internet, net of the Equinix interconnect cost.
com.eqixiac.equinix.design.value.tco	Design-time total-cost-of-ownership comparison across the DeploymentArchetypes - public cloud over the internet, on-premises, Equinix-interconnected, and (for a cloud-to-cloud comparison) the providers' native multicloud link.

Uses of DesignSpec in com.eqixiac.equinix

Methods in com.eqixiac.equinix with parameters of type DesignSpec

Modifier and Type	Method	Description
DesignDecisionRecorder	Design.decisionRecord(DesignSpec spec)	Begins a Design Decision Record for a DesignSpec (read-only): the optimiser, resilience analysis, growth and value models and a deployment plan, chained and recorded with their evidence (DesignDecisionRecorder.forSpec).
MetroOptimizer	Design.optimizeMetros(DesignSpec spec)	Begins a metro optimization of a DesignSpec: the spec-first entry point (MetroOptimizer.forSpec).
ResilienceAnalyzer	Design.resilience(DesignSpec spec)	Begins a resilience analysis of a DesignSpec (read-only): by default the optimiser's recommended portfolio is built into a design graph and every single failure and bounded pairs of failures are simulated (ResilienceAnalyzer.forSpec).

Uses of DesignSpec in com.eqixiac.equinix.design.constraint

Methods in com.eqixiac.equinix.design.constraint with parameters of type DesignSpec

Modifier and Type	Method	Description
static List<Constraint>	Constraints.forSpec(DesignSpec spec)	The built-in constraints for a spec: one per field of DesignConstraints that is set, the workload rules (pinned metro, per-workload latency, cloud reachability) when the spec has workloads or required clouds, the budget when one is stated, and EveryMetroUsedConstraint always.

Uses of DesignSpec in com.eqixiac.equinix.design.cost

Methods in com.eqixiac.equinix.design.cost that return DesignSpec

Modifier and Type	Method	Description
static DesignSpec	CurrencyConverters.pinUsedRates(DesignSpec spec, List<PortfolioCost> costs)	The spec with the rates the given costs used pinned in commercial.exchangeRates (rates already pinned are kept and take precedence), so re-running it reproduces the result.

Methods in com.eqixiac.equinix.design.cost with parameters of type DesignSpec

Modifier and Type	Method	Description
static CurrencyConverters.Chain	CurrencyConverters.forSpec(DesignSpec spec, CurrencyConverter supplied)	The converter for a spec: pinned rates, then supplied, then CurrencyConverters.standard(String).
static GrowthPlanner	GrowthPlanner.forSpec(DesignSpec spec, MetroPortfolio portfolio, DesignContext context, RateCard rateCard, ReferenceRateCard providerFees)	Plans a design.
static GrowthPlanner	GrowthPlanner.forSpec(DesignSpec spec, MetroPortfolio portfolio, DesignContext context, RateCard rateCard, ReferenceRateCard providerFees, CurrencyConverter converter)	Plans a design with a converter for prices in other currencies (ranked below rates pinned in the spec and above the default sources; see CurrencyConverters).
static RateCardCostModel.Builder	RateCardCostModel.forSpec(DesignSpec spec, RateCard rateCard)	A builder preset from a spec: the term (commercial.term, default Term.MONTH_1), the target currency (commercial.currency, default USD) and commercial.exchangeRates.
static DesignSpec	CurrencyConverters.pinUsedRates(DesignSpec spec, List<PortfolioCost> costs)	The spec with the rates the given costs used pinned in commercial.exchangeRates (rates already pinned are kept and take precedence), so re-running it reproduces the result.

Uses of DesignSpec in com.eqixiac.equinix.design.optimizer

Methods in com.eqixiac.equinix.design.optimizer that return DesignSpec

Modifier and Type	Method	Description
DesignSpec	MetroOptimizer.Builder.toSpec()

Methods in com.eqixiac.equinix.design.optimizer with parameters of type DesignSpec

Modifier and Type	Method	Description
static MetroOptimizer	MetroOptimizer.forSpec(FabricGateway fabric, DesignSpec spec)	Optimises a spec against live Fabric data (read-only).

Uses of DesignSpec in com.eqixiac.equinix.design.optimizer.context

Methods in com.eqixiac.equinix.design.optimizer.context that return DesignSpec

Modifier and Type	Method	Description
DesignSpec	CatalogDesignContext.spec()

Methods in com.eqixiac.equinix.design.optimizer.context with parameters of type DesignSpec

Modifier and Type	Method	Description
static CatalogDesignContext.Builder	CatalogDesignContext.builder(DesignSpec spec)
static CatalogDesignContext	FabricCatalogLoader.load(FabricGateway fabric, DesignSpec spec, CostModel costModel)

Uses of DesignSpec in com.eqixiac.equinix.design.optimizer.model

Methods in com.eqixiac.equinix.design.optimizer.model that return DesignSpec

Modifier and Type	Method	Description
DesignSpec	OptimizationResult.specWithUsedRatesPinned()	The spec with every exchange rate this result used pinned in commercial.exchangeRates, so running it again reproduces the figures exactly.

Uses of DesignSpec in com.eqixiac.equinix.design.optimizer.wizard

Methods in com.eqixiac.equinix.design.optimizer.wizard with parameters of type DesignSpec

Modifier and Type	Method	Description
DeploymentWizard.Builder	DeploymentWizard.Builder.designSpec(DesignSpec spec)	Records the design spec the plan is derived from: its fingerprint() is stamped on the plan, and its name becomes the deployment name unless DeploymentWizard.Builder.deploymentName(String) sets one.

Uses of DesignSpec in com.eqixiac.equinix.design.peering

Methods in com.eqixiac.equinix.design.peering with parameters of type DesignSpec

Modifier and Type	Method	Description
static PeeringIntelligence.Builder	PeeringIntelligence.forSpec(FabricGateway fabric, DesignSpec spec)	Begins a peering analysis of a DesignSpec: the spec's PeerIntents are the target networks (labelled as the spec labels them), and the metros its sites name plus its constraints.requiredMetros are the customer metros (resiliency analysis is enabled when there is at least one).
static PeeringIntelligence.Builder	PeeringIntelligence.forSpec(FabricGateway fabric, DesignSpec spec, String peeringDbApiKey)	As PeeringIntelligence.forSpec(FabricGateway, DesignSpec), authenticated to PeeringDB with an explicit key.

Uses of DesignSpec in com.eqixiac.equinix.design.record

Methods in com.eqixiac.equinix.design.record that return DesignSpec

Modifier and Type	Method	Description
DesignSpec	DesignDecisionRecord.reproducibleSpec()	The spec with the exchange rates this record used pinned in commercial.exchangeRates, so running it again reproduces the cost figures.
DesignSpec	DesignDecisionRecord.spec()	Returns the value of the spec record component.

Methods in com.eqixiac.equinix.design.record with parameters of type DesignSpec

Modifier and Type	Method	Description
static DesignDecisionRecorder	DesignDecisionRecorder.forSpec(FabricGateway fabric, DesignSpec spec)	Records a spec against live Fabric data (read-only: catalogue reads and price searches).

Constructors in com.eqixiac.equinix.design.record with parameters of type DesignSpec

Modifier	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.

Uses of DesignSpec in com.eqixiac.equinix.design.resilience

Methods in com.eqixiac.equinix.design.resilience with parameters of type DesignSpec

Modifier and Type	Method	Description
static ResilienceAnalyzer	ResilienceAnalyzer.forSpec(FabricGateway fabric, DesignSpec spec)	Analyses a spec against live Fabric data (read-only).
static List<PeerPresence>	DesignGraphBuilder.peers(PeeringIntelligenceResult result, DesignSpec spec)	Peer presence from a peering analysis, for DesignGraphBuilder.build(DesignContext, MetroPortfolio, PlacementPlan, ResilienceOptions, List): one entry per analysed network with every metro where it is present.

Uses of DesignSpec in com.eqixiac.equinix.design.spec

Methods in com.eqixiac.equinix.design.spec that return DesignSpec

Modifier and Type	Method	Description
static DesignSpec	DesignSpecIO.fromJson(String json)	Parses a JSON document.
static DesignSpec	DesignSpecIO.fromYaml(String yaml)	Parses a YAML document.
static DesignSpec	DesignSpecIO.read(Path file)	Reads a spec from a file, choosing the format by extension: .yaml / .yml is YAML, anything else is JSON.
DesignSpec	DesignSpec.requireValid()	Throws when DesignSpec.validate() reports any error.

Methods in com.eqixiac.equinix.design.spec with parameters of type DesignSpec

Modifier and Type	Method	Description
static String	DesignSpecIO.fingerprint(DesignSpec spec)	The SHA-256 of the spec's canonical JSON (properties and map entries sorted), as lowercase hex.
static String	DesignSpecIO.toJson(DesignSpec spec)
static String	DesignSpecIO.toYaml(DesignSpec spec)
static void	DesignSpecIO.write(DesignSpec spec, Path file)	Writes a spec to a file, choosing the format by extension as DesignSpecIO.read(Path) does.

Uses of DesignSpec in com.eqixiac.equinix.design.spi

Methods in com.eqixiac.equinix.design.spi that return DesignSpec

Modifier and Type	Method	Description
DesignSpec	DesignContext.spec()

Uses of DesignSpec in com.eqixiac.equinix.design.value

Methods in com.eqixiac.equinix.design.value with parameters of type DesignSpec

Modifier and Type	Method	Description
static SpecInputs	SpecInputs.derive(DesignSpec spec, String cloudId, MetroPortfolio chosen)

Uses of DesignSpec in com.eqixiac.equinix.design.value.savings

Methods in com.eqixiac.equinix.design.value.savings with parameters of type DesignSpec

Modifier and Type	Method	Description
static SavingsCalculator.Builder	SavingsCalculator.forSpec(FabricGateway fabric, DesignSpec spec, String cloudId, MetroPortfolio chosen)	A builder preset from a DesignSpec the way the optimiser's RateCardCostModel prices it (see SpecInputs): provider, region and egress volume from the cloud; bandwidth from the workloads reaching it, rounded up to the Fabric tier; the chosen portfolio's metro; the spec's term (on demand when unset); an IP_VC from a STANDARD Fabric Cloud Router.

Uses of DesignSpec in com.eqixiac.equinix.design.value.tco

Methods in com.eqixiac.equinix.design.value.tco with parameters of type DesignSpec

Modifier and Type	Method	Description
static TcoCalculator.Builder	TcoCalculator.forSpec(FabricGateway fabric, DesignSpec spec, String cloudId, MetroPortfolio chosen)	A builder preset from a DesignSpec the way the optimiser's RateCardCostModel prices it (see SpecInputs): the cloud's provider, region and monthly egress; bandwidth from the workloads reaching it (rounded up to the Fabric tier); the chosen portfolio's metro; the spec's term (on demand when unset); and the router-originated build the Deployment Wizard uses: an IP_VC from a STANDARD Fabric Cloud Router, no cross-connect and no cabinet.