Record Class OrderNotification

java.lang.Object

java.lang.Record

com.eqixiac.equinix.messaging.OrderNotification

Record Components:

header - common header

body - the order status details

rawJson - the envelope as received

All Implemented Interfaces:

EmgMessage

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

Order status notification for orders placed through the Customer Portal, the APIs or EMG (Cross Connect, Smart Hands, Work Visit, Shipment, Trouble Ticket, ...): Task.Resource one of the spec's order product groups (SmartHands, Shipping, WorkVisit, ...).

These inbound Order Notifications remain supported. They are distinct from EMG Order Management (placing orders through EMG), which Equinix deprecated on 2024-09-30 and which this SDK does not implement.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	OrderNotification.Attachment	An order attachment.
static final record	OrderNotification.Body	Order notification body (spec OrderNotificationBody).
static enum	OrderNotification.State	Order state.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
OrderNotification.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.
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

OrderNotification

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

Creates an instance of a OrderNotification 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

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 OrderNotification.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