Record Class EstateReport

java.lang.Object

java.lang.Record

com.eqixiac.equinix.design.estate.EstateReport

Record Components:

scope - the scope analysed

inventoryAsOf - when the inventory was taken

inventorySource - where the inventory came from

generatedAt - when the report was generated

counts - resource type to count

utilization - what utilisation data was available

findings - every finding, in priority order

categoryTotals - per category: count, priced monthly saving per currency, unpriced count

addressableMonthlySaving - currency to the total addressable monthly saving

unpriced - the findings whose financial effect could not be priced, with reasons

actions - the prioritised action list (one per finding)

coverageGaps - what could not be read

notAnalysed - what was not analysed and why

warnings - loud warnings (truncation, rule failures)

rulesRun - the rules that ran

collection - how the inventory was collected

reportingCurrency - the currency every priced figure was restated in (null on reports written before reporting currencies existed)

currencyNotes - what was converted, at which rates, and any rate source that fell back

public record EstateReport(EstateScope scope, Instant inventoryAsOf, String inventorySource, Instant generatedAt, Map<String,Integer> counts, EstateReport.UtilizationSummary utilization, List<EstateFinding> findings, List<EstateReport.CategoryTotal> categoryTotals, Map<String, EstateReport.SavingTotal> addressableMonthlySaving, List<EstateReport.UnpricedItem> unpriced, List<EstateReport.ActionItem> actions, List<EstateInventory.CoverageGap> coverageGaps, List<String> notAnalysed, List<String> warnings, List<String> rulesRun, EstateInventory.CollectionStats collection, String reportingCurrency, List<String> currencyNotes)
extends Record

The result of an estate analysis: findings in priority order, totals, the addressable saving per currency, coverage gaps, and what was not analysed.

Money is never added across currencies. The addressable saving counts only priced positive savings; when several findings save money on the same resource (for example a smaller tier and a term), only the largest is counted, because they do not simply add. Unpriced findings are listed separately with their reasons. Priority is severity weight × confidence weight × (1 + log10(1 + monthly saving)), ties broken by severity, category and id, so the order is deterministic.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	EstateReport.ActionItem	One entry of the prioritised action list.
static final record	EstateReport.CategoryTotal	Totals for one category.
static final record	EstateReport.SavingTotal	An addressable saving in one currency.
static final record	EstateReport.UnpricedItem	A finding whose financial effect could not be priced.
static final record	EstateReport.UtilizationSummary	What utilisation data the analysis had.

Constructor Summary

Constructors

Constructor

Description

EstateReport(EstateScope scope, Instant inventoryAsOf, String inventorySource, Instant generatedAt, Map<String,Integer> counts, EstateReport.UtilizationSummary utilization, List<EstateFinding> findings, List<EstateReport.CategoryTotal> categoryTotals, Map<String, EstateReport.SavingTotal> addressableMonthlySaving, List<EstateReport.UnpricedItem> unpriced, List<EstateReport.ActionItem> actions, List<EstateInventory.CoverageGap> coverageGaps, List<String> notAnalysed, List<String> warnings, List<String> rulesRun, EstateInventory.CollectionStats collection, String reportingCurrency, List<String> currencyNotes)

Copies the collections.

Method Summary

Modifier and Type	Method	Description
List<EstateReport.ActionItem>	actions()	Returns the value of the actions record component.
Map<String, EstateReport.SavingTotal>	addressableMonthlySaving()	Returns the value of the addressableMonthlySaving record component.
static EstateReport	assemble(EstateInventory inventory, UtilizationSnapshot utilization, List<EstateFinding> findings, List<String> notAnalysed, List<String> warnings, List<String> rulesRun, Instant generatedAt)	Assembles a report from findings: orders them, totals them and builds the action list.
static EstateReport	assemble(EstateInventory inventory, UtilizationSnapshot utilization, List<EstateFinding> findings, List<String> notAnalysed, List<String> warnings, List<String> rulesRun, Instant generatedAt, String reportingCurrency, List<String> currencyNotes)	As assemble(EstateInventory, UtilizationSnapshot, List, List, List, List, Instant), stating the reporting currency and what was converted into it.
List<EstateReport.CategoryTotal>	categoryTotals()	Returns the value of the categoryTotals record component.
EstateInventory.CollectionStats	collection()	Returns the value of the collection record component.
Map<String,Integer>	counts()	Returns the value of the counts record component.
List<EstateInventory.CoverageGap>	coverageGaps()	Returns the value of the coverageGaps record component.
List<String>	currencyNotes()	Returns the value of the currencyNotes record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
List<EstateFinding>	findings()	Returns the value of the findings record component.
List<EstateFinding>	findings(FindingCategory category)	The findings of one category.
static EstateReport	fromJson(String json)	Reads a report written by toJson().
Instant	generatedAt()	Returns the value of the generatedAt record component.
final int	hashCode()	Returns a hash code value for this object.
Instant	inventoryAsOf()	Returns the value of the inventoryAsOf record component.
String	inventorySource()	Returns the value of the inventorySource record component.
List<String>	notAnalysed()	Returns the value of the notAnalysed record component.
static double	priority(EstateFinding f)	The priority of a finding (higher first).
String	reportingCurrency()	Returns the value of the reportingCurrency record component.
List<String>	rulesRun()	Returns the value of the rulesRun record component.
EstateScope	scope()	Returns the value of the scope record component.
String	toJson()	Serializes the report to JSON.
String	toMarkdown()	Renders the report as Markdown.
final String	toString()	Returns a string representation of this record class.
List<EstateReport.UnpricedItem>	unpriced()	Returns the value of the unpriced record component.
EstateReport.UtilizationSummary	utilization()	Returns the value of the utilization record component.
List<String>	warnings()	Returns the value of the warnings record component.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

EstateReport

public EstateReport(EstateScope scope,
 Instant inventoryAsOf,
 String inventorySource,
 Instant generatedAt,
 Map<String,Integer> counts,
 EstateReport.UtilizationSummary utilization,
 List<EstateFinding> findings,
 List<EstateReport.CategoryTotal> categoryTotals,
 Map<String, EstateReport.SavingTotal> addressableMonthlySaving,
 List<EstateReport.UnpricedItem> unpriced,
 List<EstateReport.ActionItem> actions,
 List<EstateInventory.CoverageGap> coverageGaps,
 List<String> notAnalysed,
 List<String> warnings,
 List<String> rulesRun,
 EstateInventory.CollectionStats collection,
 String reportingCurrency,
 List<String> currencyNotes)

Copies the collections.

Method Details

assemble

public static EstateReport assemble(EstateInventory inventory,
 UtilizationSnapshot utilization,
 List<EstateFinding> findings,
 List<String> notAnalysed,
 List<String> warnings,
 List<String> rulesRun,
 Instant generatedAt)

Assembles a report from findings: orders them, totals them and builds the action list.

Parameters:

inventory - the inventory analysed

utilization - the utilisation used

findings - the findings, in any order

notAnalysed - what was not analysed and why

warnings - warnings to surface

rulesRun - the rules that ran

generatedAt - the generation time

Returns:

the report

assemble

public static EstateReport assemble(EstateInventory inventory,
 UtilizationSnapshot utilization,
 List<EstateFinding> findings,
 List<String> notAnalysed,
 List<String> warnings,
 List<String> rulesRun,
 Instant generatedAt,
 String reportingCurrency,
 List<String> currencyNotes)

As assemble(EstateInventory, UtilizationSnapshot, List, List, List, List, Instant), stating the reporting currency and what was converted into it.

Parameters:

inventory - the inventory analysed

utilization - the utilisation used

findings - the findings, in any order

notAnalysed - what was not analysed and why

warnings - warnings to surface

rulesRun - the rules that ran

generatedAt - the generation time

reportingCurrency - the currency priced figures were restated in, or null

currencyNotes - conversion advisories and rate-source fallbacks

Returns:

the report

priority

public static double priority(EstateFinding f)

The priority of a finding (higher first).

Parameters:

f - the finding

Returns:

severity weight × confidence weight × (1 + log10(1 + monthly saving))

findings

public List<EstateFinding> findings(FindingCategory category)

The findings of one category.

Parameters:

category - the category

Returns:

the findings, in priority order

toJson

public String toJson()

Serializes the report to JSON.

Returns:

the JSON document

fromJson

public static EstateReport fromJson(String json)

Reads a report written by toJson().

Parameters:

json - the JSON document

Returns:

the report

toMarkdown

public String toMarkdown()

Renders the report as Markdown.

Returns:

the Markdown text

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

scope

public EstateScope scope()

Returns the value of the scope record component.

Returns:

the value of the scope record component

inventoryAsOf

public Instant inventoryAsOf()

Returns the value of the inventoryAsOf record component.

Returns:

the value of the inventoryAsOf record component

inventorySource

public String inventorySource()

Returns the value of the inventorySource record component.

Returns:

the value of the inventorySource record component

generatedAt

public Instant generatedAt()

Returns the value of the generatedAt record component.

Returns:

the value of the generatedAt record component

counts

public Map<String,Integer> counts()

Returns the value of the counts record component.

Returns:

the value of the counts record component

utilization

public EstateReport.UtilizationSummary utilization()

Returns the value of the utilization record component.

Returns:

the value of the utilization record component

findings

public List<EstateFinding> findings()

Returns the value of the findings record component.

Returns:

the value of the findings record component

categoryTotals

public List<EstateReport.CategoryTotal> categoryTotals()

Returns the value of the categoryTotals record component.

Returns:

the value of the categoryTotals record component

addressableMonthlySaving

public Map<String, EstateReport.SavingTotal> addressableMonthlySaving()

Returns the value of the addressableMonthlySaving record component.

Returns:

the value of the addressableMonthlySaving record component

unpriced

public List<EstateReport.UnpricedItem> unpriced()

Returns the value of the unpriced record component.

Returns:

the value of the unpriced record component

actions

public List<EstateReport.ActionItem> actions()

Returns the value of the actions record component.

Returns:

the value of the actions record component

coverageGaps

public List<EstateInventory.CoverageGap> coverageGaps()

Returns the value of the coverageGaps record component.

Returns:

the value of the coverageGaps record component

notAnalysed

public List<String> notAnalysed()

Returns the value of the notAnalysed record component.

Returns:

the value of the notAnalysed record component

warnings

public List<String> warnings()

Returns the value of the warnings record component.

Returns:

the value of the warnings record component

rulesRun

public List<String> rulesRun()

Returns the value of the rulesRun record component.

Returns:

the value of the rulesRun record component

collection

public EstateInventory.CollectionStats collection()

Returns the value of the collection record component.

Returns:

the value of the collection record component

reportingCurrency

public String reportingCurrency()

Returns the value of the reportingCurrency record component.

Returns:

the value of the reportingCurrency record component

currencyNotes

public List<String> currencyNotes()

Returns the value of the currencyNotes record component.

Returns:

the value of the currencyNotes record component