Record Class EstateInventory

java.lang.Object

java.lang.Record

com.eqixiac.equinix.design.estate.EstateInventory

Record Components:

scope - the scope the snapshot was taken for

asOf - when the snapshot was taken

source - where the data came from, for example live Fabric v4 API or fixture

ports - Fabric ports in scope

connections - Fabric virtual connections in scope

routers - Fabric Cloud Routers in scope

networks - Fabric networks in scope

serviceTokens - Fabric service tokens in scope

devices - Network Edge devices in scope

routerPackageLimits - Cloud Router package code to the maximum number of virtual connections, as the /routerPackages API reported it (empty when not reported)

coverageGaps - what could not be read, and why

stats - how the snapshot was collected (requests, timings)

public record EstateInventory(EstateScope scope, Instant asOf, String source, List<EstateInventory.PortRecord> ports, List<EstateInventory.ConnectionRecord> connections, List<EstateInventory.RouterRecord> routers, List<EstateInventory.NetworkRecord> networks, List<EstateInventory.ServiceTokenRecord> serviceTokens, List<EstateInventory.DeviceRecord> devices, Map<String,Integer> routerPackageLimits, List<EstateInventory.CoverageGap> coverageGaps, EstateInventory.CollectionStats stats)
extends Record

An immutable, serializable snapshot of the part of an Equinix estate an analysis covers.

The snapshot is plain data (no live SDK objects), so an analysis can be repeated offline, stored next to its report, and built by hand in tests. Every list is sorted by resource id so the same estate always produces the same snapshot. Values the API did not report are null (unknown), never zero. Anything that could not be read is listed in coverageGaps().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	EstateInventory.Builder	Builds an inventory by hand.
static final record	EstateInventory.CollectionStats	How the snapshot was collected.
static final record	EstateInventory.ConnectionRecord	A Fabric virtual connection.
static final record	EstateInventory.CoverageGap	Something the collector could not read, recorded instead of failing the run.
static final record	EstateInventory.DeviceRecord	A Network Edge virtual device.
static final record	EstateInventory.Endpoint	One side of a virtual connection.
static final record	EstateInventory.NetworkRecord	A Fabric network (EVPLAN, EPLAN, IPWAN...).
static final record	EstateInventory.PortRecord	A Fabric port.
static final record	EstateInventory.RouterRecord	A Fabric Cloud Router.
static final record	EstateInventory.ServiceTokenRecord	A Fabric service token.
static final record	EstateInventory.TypeStats	Collection figures for one resource type.

Constructor Summary

Constructors

Constructor

Description

EstateInventory(EstateScope scope, Instant asOf, String source, List<EstateInventory.PortRecord> ports, List<EstateInventory.ConnectionRecord> connections, List<EstateInventory.RouterRecord> routers, List<EstateInventory.NetworkRecord> networks, List<EstateInventory.ServiceTokenRecord> serviceTokens, List<EstateInventory.DeviceRecord> devices, Map<String,Integer> routerPackageLimits, List<EstateInventory.CoverageGap> coverageGaps, EstateInventory.CollectionStats stats)

Sorts every list by id and makes every collection immutable.

Method Summary

Modifier and Type	Method	Description
Instant	asOf()	Returns the value of the asOf record component.
static EstateInventory.Builder	builder(EstateScope scope, Instant asOf)	Starts a hand-built inventory (tests, imports from other tools).
List<EstateInventory.ConnectionRecord>	connections()	Returns the value of the connections record component.
List<EstateInventory.ConnectionRecord>	connectionsOnPort(String portId)	The connections whose A or Z side terminates on the given port.
List<EstateInventory.ConnectionRecord>	connectionsOnRouter(String routerId)	The connections whose A or Z side terminates on the given Cloud Router.
Map<String,Integer>	counts()	Counts of each resource type, for report headers.
List<EstateInventory.CoverageGap>	coverageGaps()	Returns the value of the coverageGaps record component.
List<EstateInventory.DeviceRecord>	devices()	Returns the value of the devices record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static EstateInventory	fromJson(String json)	Reads a snapshot written by toJson().
final int	hashCode()	Returns a hash code value for this object.
List<EstateInventory.NetworkRecord>	networks()	Returns the value of the networks record component.
Optional<EstateInventory.PortRecord>	port(String id)	Finds a port by id.
List<EstateInventory.PortRecord>	ports()	Returns the value of the ports record component.
Optional<EstateInventory.RouterRecord>	router(String id)	Finds a Cloud Router by id.
Map<String,Integer>	routerPackageLimits()	Returns the value of the routerPackageLimits record component.
List<EstateInventory.RouterRecord>	routers()	Returns the value of the routers record component.
EstateScope	scope()	Returns the value of the scope record component.
List<EstateInventory.ServiceTokenRecord>	serviceTokens()	Returns the value of the serviceTokens record component.
String	source()	Returns the value of the source record component.
EstateInventory.CollectionStats	stats()	Returns the value of the stats record component.
String	toJson()	Serializes the snapshot to JSON (ISO-8601 timestamps).
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

EstateInventory

public EstateInventory(EstateScope scope,
 Instant asOf,
 String source,
 List<EstateInventory.PortRecord> ports,
 List<EstateInventory.ConnectionRecord> connections,
 List<EstateInventory.RouterRecord> routers,
 List<EstateInventory.NetworkRecord> networks,
 List<EstateInventory.ServiceTokenRecord> serviceTokens,
 List<EstateInventory.DeviceRecord> devices,
 Map<String,Integer> routerPackageLimits,
 List<EstateInventory.CoverageGap> coverageGaps,
 EstateInventory.CollectionStats stats)

Sorts every list by id and makes every collection immutable.

Method Details

builder

public static EstateInventory.Builder builder(EstateScope scope,
 Instant asOf)

Starts a hand-built inventory (tests, imports from other tools).

Parameters:

scope - the scope

asOf - the as-of time

Returns:

a builder

counts

public Map<String,Integer> counts()

Counts of each resource type, for report headers.

Returns:

resource type to count, in a fixed order

port

public Optional<EstateInventory.PortRecord> port(String id)

Finds a port by id.

Parameters:

id - the port id

Returns:

the port, if in the snapshot

router

public Optional<EstateInventory.RouterRecord> router(String id)

Finds a Cloud Router by id.

Parameters:

id - the router id

Returns:

the router, if in the snapshot

connectionsOnPort

public List<EstateInventory.ConnectionRecord> connectionsOnPort(String portId)

The connections whose A or Z side terminates on the given port.

Parameters:

portId - the port id

Returns:

the connections, in id order

connectionsOnRouter

public List<EstateInventory.ConnectionRecord> connectionsOnRouter(String routerId)

The connections whose A or Z side terminates on the given Cloud Router.

Parameters:

routerId - the router id

Returns:

the connections, in id order

toJson

public String toJson()

Serializes the snapshot to JSON (ISO-8601 timestamps).

Returns:

the JSON document

fromJson

public static EstateInventory fromJson(String json)

Reads a snapshot written by toJson().

Parameters:

json - the JSON document

Returns:

the snapshot

Throws:

IllegalArgumentException - when the document is not a snapshot

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

asOf

public Instant asOf()

Returns the value of the asOf record component.

Returns:

the value of the asOf record component

source

public String source()

Returns the value of the source record component.

Returns:

the value of the source record component

ports

public List<EstateInventory.PortRecord> ports()

Returns the value of the ports record component.

Returns:

the value of the ports record component

connections

public List<EstateInventory.ConnectionRecord> connections()

Returns the value of the connections record component.

Returns:

the value of the connections record component

routers

public List<EstateInventory.RouterRecord> routers()

Returns the value of the routers record component.

Returns:

the value of the routers record component

networks

public List<EstateInventory.NetworkRecord> networks()

Returns the value of the networks record component.

Returns:

the value of the networks record component

serviceTokens

public List<EstateInventory.ServiceTokenRecord> serviceTokens()

Returns the value of the serviceTokens record component.

Returns:

the value of the serviceTokens record component

devices

public List<EstateInventory.DeviceRecord> devices()

Returns the value of the devices record component.

Returns:

the value of the devices record component

routerPackageLimits

public Map<String,Integer> routerPackageLimits()

Returns the value of the routerPackageLimits record component.

Returns:

the value of the routerPackageLimits record component

coverageGaps

public List<EstateInventory.CoverageGap> coverageGaps()

Returns the value of the coverageGaps record component.

Returns:

the value of the coverageGaps record component

stats

public EstateInventory.CollectionStats stats()

Returns the value of the stats record component.

Returns:

the value of the stats record component