Record Class FabricNotification

java.lang.Object

java.lang.Record

com.eqixiac.equinix.messaging.FabricNotification

Record Components:

header - common header

body - the status-change details

rawJson - the envelope as received

All Implemented Interfaces:

EmgMessage

public record FabricNotification(EmgHeader header, FabricNotification.Body body, String rawJson)
extends Record
implements EmgMessage

Equinix Fabric port or virtual-connection operational-status notification (port/VC up or down), delivered with Task.Resource DataCenter.Network.Port or DataCenter.Network.VirtualConnection. Shape: the spec's FabricNotificationBody and the Fabric sample in the Notification Types guide.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FabricNotification.AssetType	Fabric asset type.
static final record	FabricNotification.Body	Fabric notification body.
static final record	FabricNotification.Connections	Virtual connections on a port.
static final record	FabricNotification.Data	The affected port or virtual connection.
static final record	FabricNotification.Embedded	Embedded related resources.
static final record	FabricNotification.Operation	Operational-status details.
static enum	FabricNotification.OperationalStatus	Operational status of the port or connection.
static enum	FabricNotification.Type	Fabric notification type.

Constructor Summary

Constructors

Constructor	Description
FabricNotification(EmgHeader header, FabricNotification.Body body, String rawJson)	Creates an instance of a FabricNotification record class.

Method Summary

Modifier and Type	Method	Description
FabricNotification.Body	body()	Returns the value of the body record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
EmgHeader	header()	Returns the value of the header record component.
boolean	isDown()	Whether the affected port or connection is reported FabricNotification.OperationalStatus.DOWN.
String	rawJson()	Returns the value of the rawJson record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Methods inherited from interface EmgMessage

id

Modifier and Type	Method	Description
default String	id()	Shortcut for header().id(): EMG delivers at least once, so use this as the key to de-duplicate redelivered notifications.

Constructor Details

FabricNotification

public FabricNotification(EmgHeader header,
 FabricNotification.Body body,
 String rawJson)

Creates an instance of a FabricNotification record class.

Parameters:

header - the value for the header record component

body - the value for the body record component

rawJson - the value for the rawJson record component

Method Details

isDown

public boolean isDown()

Whether the affected port or connection is reported FabricNotification.OperationalStatus.DOWN.

Returns:

true only for an explicit DOWN status

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.

header

public EmgHeader header()

Returns the value of the header record component.

Specified by:

header in interface EmgMessage

Returns:

the value of the header record component

body

public FabricNotification.Body body()

Returns the value of the body record component.

Returns:

the value of the body record component

rawJson

public String rawJson()

Returns the value of the rawJson record component.

Specified by:

rawJson in interface EmgMessage

Returns:

the value of the rawJson record component