Class MetroOptimizer.Builder

java.lang.Object

com.eqixiac.equinix.design.optimizer.MetroOptimizer.Builder

Enclosing class:

MetroOptimizer

public static final class MetroOptimizer.Builder
extends Object

Fluent convenience over DesignSpec: each call adds to the spec, toSpec() returns it and optimize() runs MetroOptimizer.forSpec(FabricGateway, DesignSpec). Clouds are identified by their label (default: the provider's name, or the profile name); a workload's dependsOn refers to the same cloud, adding it as required when it was not declared.

Method Summary

Modifier and Type	Method	Description
MetroOptimizer.SiteBuilder	addSite(String label)
MetroOptimizer.WorkloadBuilder	addWorkload(String label)
MetroOptimizer.ConstraintsBuilder	constraints()
MetroOptimizer.Builder	multicloudEnvironments(MulticloudEnvironmentCatalog catalog)
MetroOptimizer.Builder	name(String name)
OptimizationResult	optimize()
MetroOptimizer.ProviderBuilder	preferProvider(CloudProviderType provider)
MetroOptimizer.ProviderBuilder	preferProvider(String serviceProfileName)
MetroOptimizer.Builder	rateCard(RateCard card)
MetroOptimizer.ProviderBuilder	requireProvider(CloudProviderType provider)
MetroOptimizer.ProviderBuilder	requireProvider(String serviceProfileName)
MetroOptimizer.Builder	strategy(OptimizationStrategy strategy)
MetroOptimizer.Builder	term(Term term)
DesignSpec	toSpec()
MetroOptimizer.Builder	weights(Map<String,Double> weights)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

name

public MetroOptimizer.Builder name(String name)

Parameters:

name - the spec name

Returns:

this builder

addSite

public MetroOptimizer.SiteBuilder addSite(String label)

Parameters:

label - the site label

Returns:

a site builder; MetroOptimizer.SiteBuilder.done() returns here

requireProvider

public MetroOptimizer.ProviderBuilder requireProvider(CloudProviderType provider)

Parameters:

provider - a cloud every design must reach

Returns:

a cloud builder

requireProvider

public MetroOptimizer.ProviderBuilder requireProvider(String serviceProfileName)

Parameters:

serviceProfileName - a service provider (profile name substring) every design must reach

Returns:

a cloud builder

preferProvider

public MetroOptimizer.ProviderBuilder preferProvider(CloudProviderType provider)

Parameters:

provider - a cloud that counts towards coverage but is not required

Returns:

a cloud builder

preferProvider

public MetroOptimizer.ProviderBuilder preferProvider(String serviceProfileName)

Parameters:

serviceProfileName - a service provider that counts towards coverage but is not required

Returns:

a cloud builder

addWorkload

public MetroOptimizer.WorkloadBuilder addWorkload(String label)

Parameters:

label - the workload label

Returns:

a workload builder

constraints

public MetroOptimizer.ConstraintsBuilder constraints()

Returns:

a constraints builder

strategy

public MetroOptimizer.Builder strategy(OptimizationStrategy strategy)

Parameters:

strategy - a named weight profile

Returns:

this builder

weights

public MetroOptimizer.Builder weights(Map<String,Double> weights)

Parameters:

weights - explicit objective weights by id, applied on top of the profile

Returns:

this builder

rateCard

public MetroOptimizer.Builder rateCard(RateCard card)

Parameters:

card - the rate card to price with

Returns:

this builder

term

public MetroOptimizer.Builder term(Term term)

Parameters:

term - the commitment term to price at

Returns:

this builder

multicloudEnvironments

public MetroOptimizer.Builder multicloudEnvironments(MulticloudEnvironmentCatalog catalog)

Parameters:

catalog - the native multicloud environment catalogue (Beta)

Returns:

this builder

toSpec

public DesignSpec toSpec()

Returns:

the spec assembled so far

optimize

public OptimizationResult optimize()

Returns:

the result of MetroOptimizer.forSpec(fabric, toSpec())