Class RateCardCostModel.Builder

java.lang.Object

com.eqixiac.equinix.design.cost.RateCardCostModel.Builder

Enclosing class:

RateCardCostModel

public static final class RateCardCostModel.Builder
extends Object

Configures a RateCardCostModel.

Method Summary

Modifier and Type	Method	Description
RateCardCostModel	build()
RateCardCostModel.Builder	connectionType(ConnectionType type)
RateCardCostModel.Builder	currency(String currency)
RateCardCostModel.Builder	currencyConverter(CurrencyConverter converter)
RateCardCostModel.Builder	defaultRates(CurrencyConverter defaults)	Replaces the default sources after the supplied converter (live ECB rates, then the bundled table), for example with CurrencyConverters.bundledOnly() for an offline run.
RateCardCostModel.Builder	exchangeRates(CommercialTerms.ExchangeRates rates)	Pins exchange rates (normally the spec's commercial.exchangeRates); they take precedence over every other source.
RateCardCostModel.Builder	fallbackRateCard(RateCard card)	The card an item is priced from when the primary card's lookup times out or fails during RateCardCostModel.prepare(Collection, DesignContext) (default: the reference table, ReferenceRateCard.standard()).
RateCardCostModel.Builder	prefetch(int threads, Duration lookupTimeout, int maxTimeouts)	How RateCardCostModel.prepare(Collection, DesignContext) prices ahead.
RateCardCostModel.Builder	providerPorts(ReferenceRateCard table)
RateCardCostModel.Builder	routerPackage(String packageCode)
RateCardCostModel.Builder	term(Term term)

Methods inherited from class Object

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

Method Details

providerPorts

public RateCardCostModel.Builder providerPorts(ReferenceRateCard table)

Parameters:

table - the reference table cloud-provider port fees come from; null leaves them unpriced

Returns:

this builder

term

public RateCardCostModel.Builder term(Term term)

Parameters:

term - the commitment term to price at; null keeps Term.MONTH_1

Returns:

this builder

connectionType

public RateCardCostModel.Builder connectionType(ConnectionType type)

Parameters:

type - the Fabric connection type of every cloud leg (default IP_VC, router-originated)

Returns:

this builder

routerPackage

public RateCardCostModel.Builder routerPackage(String packageCode)

Parameters:

packageCode - the Cloud Router package (default STANDARD)

Returns:

this builder

currency

public RateCardCostModel.Builder currency(String currency)

Parameters:

currency - ISO 4217 code totals are compared in (normally the spec's commercial.currency); null keeps USD

Returns:

this builder

exchangeRates

public RateCardCostModel.Builder exchangeRates(CommercialTerms.ExchangeRates rates)

Pins exchange rates (normally the spec's commercial.exchangeRates); they take precedence over every other source.

Parameters:

rates - the rates, their date and source; null pins none

Returns:

this builder

currencyConverter

public RateCardCostModel.Builder currencyConverter(CurrencyConverter converter)

Parameters:

converter - a converter (for example a live FX feed) ranked below pinned rates and above the default live ECB rates and bundled table; null for none

Returns:

this builder

defaultRates

public RateCardCostModel.Builder defaultRates(CurrencyConverter defaults)

Replaces the default sources after the supplied converter (live ECB rates, then the bundled table), for example with CurrencyConverters.bundledOnly() for an offline run.

Parameters:

defaults - the fallback converter; null restores the default

Returns:

this builder

fallbackRateCard

public RateCardCostModel.Builder fallbackRateCard(RateCard card)

The card an item is priced from when the primary card's lookup times out or fails during RateCardCostModel.prepare(Collection, DesignContext) (default: the reference table, ReferenceRateCard.standard()).

Parameters:

card - the fallback card; null leaves such items unpriced

Returns:

this builder

prefetch

public RateCardCostModel.Builder prefetch(int threads,
 Duration lookupTimeout,
 int maxTimeouts)

How RateCardCostModel.prepare(Collection, DesignContext) prices ahead. Defaults: RateCardCostModel.DEFAULT_PREFETCH_THREADS threads, RateCardCostModel.DEFAULT_LOOKUP_TIMEOUT per lookup, fallback after RateCardCostModel.DEFAULT_MAX_TIMEOUTS timeouts.

Parameters:

threads - lookups run at once (0 disables pricing ahead; each item is then priced on first use)

lookupTimeout - how long one lookup may run before the fallback card is used instead

maxTimeouts - after this many timeouts in one run, lookups not yet started use the fallback card without asking the primary card

Returns:

this builder

build

public RateCardCostModel build()

Returns:

the cost model