Class CarbonObjective

java.lang.Object

com.eqixiac.equinix.design.sustainability.CarbonObjective

All Implemented Interfaces:

Objective

public final class CarbonObjective
extends Object
implements Objective

"carbon": the grid carbon intensity of where a portfolio runs its workloads, in "gCO2e/kWh", from a caller-supplied CarbonIntensityTable. Smaller is better.

The value is the mean intensity of the metros the workloads' primaries run in (the WorkloadPlacer's placement), weighted by each workload's bandwidth (an unsized workload, or a design whose workloads are all unsized, counts 1 per workload); a portfolio with no placed workload is the plain mean over its metros. It ranks where load runs; it is not an emissions inventory (it knows no power draw).

Inert without a table: the SDK holds no emissions figures, so without one every portfolio is unknown and the objective never influences a ranking. A metro missing from the table makes the value unknown and names the metro; nothing is filled in.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID	The objective id.

Fields inherited from interface Objective

COMPLIANCE, COST, LATENCY, PROVIDER_COVERAGE, RESILIENCE

Modifier and Type	Field	Description
static final String	COMPLIANCE	Share of the stated compliance and sovereignty zones the portfolio satisfies, 0 to 100.
static final String	COST	Total monthly cost of the portfolio in the spec's currency.
static final String	LATENCY	Site-weighted round-trip latency from the sites to their nearest metro in the portfolio, in ms.
static final String	PROVIDER_COVERAGE	Share of the required clouds and service providers reachable from the portfolio, 0 to 100.
static final String	RESILIENCE	How well the portfolio survives losing a metro or a region, 0 to 100.

Constructor Summary

Constructors

Constructor	Description
CarbonObjective(CarbonIntensityTable table)

Method Summary

Modifier and Type	Method	Description
Direction	direction()
ObjectiveValue	evaluate(MetroPortfolio portfolio, DesignContext context)	Measures a portfolio.
String	id()
String	unit()

Methods inherited from class Object

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

Methods inherited from interface Objective

scale

Modifier and Type	Method	Description
default ValueScale	scale(DesignContext context)	How this objective's values become 0..100 scores for the weighted ranking.

Field Details

ID

public static final String ID

The objective id.

See Also:

• Constant Field Values

Constructor Details

CarbonObjective

public CarbonObjective(CarbonIntensityTable table)

Parameters:

table - the caller's intensity table, or null for an inert objective

Method Details

id

public String id()

Specified by:

id in interface Objective

Returns:

the id weights refer to (for example Objective.LATENCY); stable, lower_snake_case

direction

public Direction direction()

Specified by:

direction in interface Objective

Returns:

whether smaller or larger values are better

unit

public String unit()

Specified by:

unit in interface Objective

Returns:

the unit of ObjectiveValue.value(), for display (for example ms, USD/month, score)

evaluate

public ObjectiveValue evaluate(MetroPortfolio portfolio,
 DesignContext context)

Description copied from interface: Objective

Measures a portfolio.

Specified by:

evaluate in interface Objective

Parameters:

portfolio - the metros of one candidate design

context - the facts of this run

Returns:

the measurement, or ObjectiveValue.unknown(String) when it cannot be made