@Generated(value="com.neeve.adm.AdmGenerator", date="Fri Dec 05 11:53:59 EST 2025") @AdmGenerated(compatLevel="4.1.0", admVersion="Unknown Version", date="12/5/25 11:53 AM", buildInfo="nvx-eagle-2.9-SNAPSHOT Json Encoding") public interface IAlert extends IRogNode, IRogMessage, IRogCopyableNode<IAlert>
| ADM Type | Message |
| Factory | MessageFactory |
| ADM Field Summary |
|---|
| Field | Type | Id | Description |
|---|---|---|---|
| agentInfo | AgentInfo |
32736 | No doc provided. |
| classifier | String | 32734 | No doc provided. |
| desc | String | 32733 | No doc provided. |
| header | MessageHeader |
32737 | No doc provided. |
| headline | String | 32730 | No doc provided. |
| severity | AlertSeverity |
32731 | No doc provided. |
| stackTrace | String | 32732 | No doc provided. |
| timestamp | Date | 32735 | No doc provided. |
IRogNode.PoolingListenerIStoreObject.EncodingType| Modifier and Type | Method and Description |
|---|---|
void |
clearAgentInfo()
Clears the value of 'agentInfo'.
|
void |
clearClassifier()
Clears the value of 'classifier'.
|
void |
clearDesc()
Clears the value of 'desc'.
|
void |
clearHeader()
Clears the value of 'header'.
|
void |
clearHeadline()
Clears the value of 'headline'.
|
void |
clearSeverity()
Clears the value of 'severity'.
|
void |
clearStackTrace()
Clears the value of 'stackTrace'.
|
void |
clearTimestamp()
Clears the value of 'timestamp'.
|
Alert |
copy()
Creates a copy of this Alert.
|
void |
copyInto(Alert target)
Copies the contents of this Alert into the target.
|
AgentInfo |
getAgentInfo()
Gets the value of 'agentInfo'.
|
void |
getAgentInfoTo(AgentInfo val)
Copies the value of AgentInfo into the provided value.
|
String |
getClassifier()
Gets the value of 'classifier'.
|
<T extends XString> |
getClassifierTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory.
|
void |
getClassifierTo(XString val)
Copies the value of 'classifier' into the provided XString.
|
XString |
getClassifierUnsafe()
Gets the raw value of 'classifier'.
|
String |
getDesc()
Gets the value of 'desc'.
|
<T extends XString> |
getDescTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory.
|
void |
getDescTo(XString val)
Copies the value of 'desc' into the provided XString.
|
XString |
getDescUnsafe()
Gets the raw value of 'desc'.
|
MessageHeader |
getHeader()
Gets the value of 'header'.
|
void |
getHeaderTo(MessageHeader val)
Copies the value of MessageHeader into the provided value.
|
String |
getHeadline()
Gets the value of 'headline'.
|
<T extends XString> |
getHeadlineTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory.
|
void |
getHeadlineTo(XString val)
Copies the value of 'headline' into the provided XString.
|
XString |
getHeadlineUnsafe()
Gets the raw value of 'headline'.
|
AlertSeverity |
getSeverity()
Gets the value of 'severity'.
|
String |
getStackTrace()
Gets the value of 'stackTrace'.
|
<T extends XString> |
getStackTraceTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory.
|
void |
getStackTraceTo(XString val)
Copies the value of 'stackTrace' into the provided XString.
|
XString |
getStackTraceUnsafe()
Gets the raw value of 'stackTrace'.
|
Date |
getTimestamp()
Gets the value of 'timestamp'.
|
Instant |
getTimestampAsInstant()
Retrieves the date as a java.time.Instant object.
|
long |
getTimestampAsTimestamp()
Retrieves the date as a timestamp (a zero garbage operation for XBuf encoding).
|
Long |
getTimestampAsTimestampObject()
Retrieves the date as a timestamp object (autobox long).
|
boolean |
hasAgentInfo()
Checks for the presence of 'agentInfo'.
|
boolean |
hasClassifier()
Checks for the presence of 'classifier'.
|
boolean |
hasDesc()
Checks for the presence of 'desc'.
|
boolean |
hasHeader()
Checks for the presence of 'header'.
|
boolean |
hasHeadline()
Checks for the presence of 'headline'.
|
boolean |
hasSeverity()
Checks for the presence of 'severity'.
|
boolean |
hasStackTrace()
Checks for the presence of 'stackTrace'.
|
boolean |
hasTimestamp()
Checks for the presence of 'timestamp'.
|
void |
lendAgentInfo(AgentInfo val)
'Lends' a reference of the AgentInfo to the message for this field.
|
void |
lendClassifier(XString val)
Lends the value of 'classifier' to this object.
|
void |
lendDesc(XString val)
Lends the value of 'desc' to this object.
|
void |
lendHeader(MessageHeader val)
'Lends' a reference of the MessageHeader to the message for this field.
|
void |
lendHeadline(XString val)
Lends the value of 'headline' to this object.
|
void |
lendStackTrace(XString val)
Lends the value of 'stackTrace' to this object.
|
void |
setAgentInfo(AgentInfo val)
Sets the value of 'agentInfo'.
|
void |
setClassifier(String val)
Sets the value of 'classifier'.
|
void |
setClassifierFrom(long val)
Sets the value of this String field to the given numeric value.
|
void |
setClassifierFrom(XString val)
Copies the provided XString value into this object's 'classifier'.
|
void |
setDesc(String val)
Sets the value of 'desc'.
|
void |
setDescFrom(long val)
Sets the value of this String field to the given numeric value.
|
void |
setDescFrom(XString val)
Copies the provided XString value into this object's 'desc'.
|
void |
setHeader(MessageHeader val)
Sets the value of 'header'.
|
void |
setHeadline(String val)
Sets the value of 'headline'.
|
void |
setHeadlineFrom(long val)
Sets the value of this String field to the given numeric value.
|
void |
setHeadlineFrom(XString val)
Copies the provided XString value into this object's 'headline'.
|
void |
setSeverity(AlertSeverity val)
Sets the value of 'severity'.
|
void |
setStackTrace(String val)
Sets the value of 'stackTrace'.
|
void |
setStackTraceFrom(long val)
Sets the value of this String field to the given numeric value.
|
void |
setStackTraceFrom(XString val)
Copies the provided XString value into this object's 'stackTrace'.
|
void |
setTimestamp(Date val)
Sets the value of 'timestamp'.
|
void |
setTimestampAsInstant(Instant val)
Sets the date value as a java.time.Instant.
|
void |
setTimestampAsTimestamp(long val)
Sets the date value as a timestamp.
|
AgentInfo |
takeAgentInfo()
'Takes' a reference to the agentInfo field from the message.
|
MessageHeader |
takeHeader()
'Takes' a reference to the header field from the message.
|
deserializeFromProtobuf, dispose, dump, getAttachment, getIsLiveInboundMessage, getIsPriority, getIsReadOnly, getMetadata, getParent, getPoolingListener, getType, metadataToJsonString, serializeToProtobuf, setAsInboundMessage, setAsInternal, setAsLastTransaction, setAsMessage, setAsOutboundMessage, setAsPriority, setAsReadOnly, setAsReplayedMessage, setAttachment, setInMsgsInTransaction, setOutMsgsInTransaction, setParentId, setPoolingListener, setTransactionInSequenceNumber, setTransactionOutSequenceNumberacquire, deserialize, deserializeMetadata, deserializeMetadata, getContentEncodingType, getOwnershipCount, getSerializedMetadataLength, getStoreMetadata, saveMemory, serialize, serializeMetadata, setFieldValueensureId, getBinding, getCheckpointVersion, getCommittedDataSize, getId, getOfid, getStableTransactionId, getTransactionId, setBinding, setCheckpointVersion, setCommittedDataSize, setId, setStableTransactionId, setTransactionIdgetMessageReflectorgetEnqueueTs, getEnqueueTsMicros, getGraphId, getInMsgsInTransaction, getIsInboundMessage, getIsInternal, getIsLastTransaction, getIsMessage, getIsOutboundMessage, getIsReplayedMessage, getMessageBus, getMessageChannel, getMessageFlow, getMessageKey, getMessageSender, getMessageSequenceNumber, getMessageTransportHeaders, getOutMsgsInTransaction, getOutTs, getOutTsMicros, getParentId, getPreProcessingTs, getPreProcessingTsMicros, getTransactionInSequenceNumber, getTransactionOutSequenceNumber, isPossibleDuplicate, metadataToJsonString, metadataToStringgetValidationErrors, isValidvoid setTimestamp(Date val)
val - The value to set.Date getTimestamp()
void setTimestampAsTimestamp(long val)
val - The date value in milliseconds from the epochlong getTimestampAsTimestamp()
NOTE:
Note that a return value of -1 could also indicate 1 millisecond before the epoch.
In cases where a such an ambiguity is a practical concern, hasTimestamp()
should be called.
Long getTimestampAsTimestampObject()
void setTimestampAsInstant(Instant val)
val - The instant valueInstant getTimestampAsInstant()
void clearTimestamp()
setTimestamp(Date)boolean hasTimestamp()
getTimestamp()void setSeverity(AlertSeverity val)
val - The value to set.AlertSeverity getSeverity()
void clearSeverity()
setSeverity(AlertSeverity)boolean hasSeverity()
getSeverity()void setHeader(MessageHeader val)
val - The value to set.void lendHeader(MessageHeader val)
NOTE:
It is illegal to hold onto an entity 'set' on a message post the disposal of the container message.
This is true even if a reference to the entity is explicitly 'acquired' by the application via acquire().
To hold onto the reference of an entity beyond the lifecycle of its container message, an application must own a reference to the entity (via, for example, 'taking' the entity off an inbound message) and then 'lend' the entity to the message for sending. The act of 'lending' an entity to a message implies that the application continues to own the entity even though the message is holding a reference to it for the duration of the send.
val - the value to 'lend' to lend.MessageHeader getHeader()
void getHeaderTo(MessageHeader val)
IF the value is not set, then the contents of the provided MessageHeader are cleared.
val - the value to copy intoMessageHeader.copyInto(MessageHeader)MessageHeader takeHeader()
NOTE:
A nested entity reference returned by getXXX() is only valid until the entity is disposed
i.e. the act of getting an entity does not transfer ownership of the entity to the application
A message disposes of its reference to its contained entities when it is disposed itself.
An AEP engine disposes a message on return from its message handler. Therefore, applications working with AEP engines that wish to hold onto a nested entity reference post return from its containing message's handler must either acquire a reference to the container message or 'take' the nested entity itself from the container message. The act of 'taking' an entity differs from 'getting' an entity in that 'take' does what is necessary to ensure that the entity contents are not cleared and the entity not disposed when the message itself is disposed. For a taken entity to be disposed, the application must explicitly dispose it when done working with it.
null if the field is not set.boolean hasHeader()
getHeader()void clearHeader()
setHeader(MessageHeader)void setAgentInfo(AgentInfo val)
val - The value to set.void lendAgentInfo(AgentInfo val)
NOTE:
It is illegal to hold onto an entity 'set' on a message post the disposal of the container message.
This is true even if a reference to the entity is explicitly 'acquired' by the application via acquire().
To hold onto the reference of an entity beyond the lifecycle of its container message, an application must own a reference to the entity (via, for example, 'taking' the entity off an inbound message) and then 'lend' the entity to the message for sending. The act of 'lending' an entity to a message implies that the application continues to own the entity even though the message is holding a reference to it for the duration of the send.
val - the value to 'lend' to lend.AgentInfo getAgentInfo()
void getAgentInfoTo(AgentInfo val)
IF the value is not set, then the contents of the provided AgentInfo are cleared.
val - the value to copy intoAgentInfo.copyInto(AgentInfo)AgentInfo takeAgentInfo()
NOTE:
A nested entity reference returned by getXXX() is only valid until the entity is disposed
i.e. the act of getting an entity does not transfer ownership of the entity to the application
A message disposes of its reference to its contained entities when it is disposed itself.
An AEP engine disposes a message on return from its message handler. Therefore, applications working with AEP engines that wish to hold onto a nested entity reference post return from its containing message's handler must either acquire a reference to the container message or 'take' the nested entity itself from the container message. The act of 'taking' an entity differs from 'getting' an entity in that 'take' does what is necessary to ensure that the entity contents are not cleared and the entity not disposed when the message itself is disposed. For a taken entity to be disposed, the application must explicitly dispose it when done working with it.
null if the field is not set.boolean hasAgentInfo()
getAgentInfo()void clearAgentInfo()
setAgentInfo(AgentInfo)void setClassifier(String val)
val - The value to set.String getClassifier()
void lendClassifier(XString val)
This method is equivalent to setClassifier except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.
Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
val - The value to set.IllegalArgumentException - If the value is mutable.void setClassifierFrom(long val)
NOTE:
This is the same as calling setClassifier(String).
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
<T extends XString> T getClassifierTo(XString.Factory<T> factory)
If the value of this field is not null this method creates an XString from
the provided Factory, copies this field's value into the type, and returns the new
XString.);
This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;
factory - The factory from which to get the XString to copy into and returnnull.NullPointerException - if the provided factory is nullvoid setClassifierFrom(XString val)
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than setClassifier(String)
because it avoids encoding the value into a String if the given XString is already encoded.
void getClassifierTo(XString val)
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than getClassifier() bec
because it can avoid decoding the value into an String.
getClassifier()XString getClassifierUnsafe()
NOTE:
This method retrieves the raw value backed by this object's buffer. This is a useful operation
when copying this field value to another object because it avoids copying the data into an intermediate
XString and instead allows direct byte transfer from the raw value to the target object.
However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.
Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.
getClassifier()void clearClassifier()
setClassifier(String)boolean hasClassifier()
getClassifier()void setDesc(String val)
val - The value to set.String getDesc()
void lendDesc(XString val)
This method is equivalent to setDesc except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.
Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
val - The value to set.IllegalArgumentException - If the value is mutable.void setDescFrom(long val)
NOTE:
This is the same as calling setDesc(String).
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
<T extends XString> T getDescTo(XString.Factory<T> factory)
If the value of this field is not null this method creates an XString from
the provided Factory, copies this field's value into the type, and returns the new
XString.);
This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;
factory - The factory from which to get the XString to copy into and returnnull.NullPointerException - if the provided factory is nullvoid setDescFrom(XString val)
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than setDesc(String)
because it avoids encoding the value into a String if the given XString is already encoded.
void getDescTo(XString val)
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than getDesc() bec
because it can avoid decoding the value into an String.
getDesc()XString getDescUnsafe()
NOTE:
This method retrieves the raw value backed by this object's buffer. This is a useful operation
when copying this field value to another object because it avoids copying the data into an intermediate
XString and instead allows direct byte transfer from the raw value to the target object.
However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.
Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.
getDesc()void clearDesc()
setDesc(String)boolean hasDesc()
getDesc()void setStackTrace(String val)
val - The value to set.String getStackTrace()
void lendStackTrace(XString val)
This method is equivalent to setStackTrace except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.
Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
val - The value to set.IllegalArgumentException - If the value is mutable.void setStackTraceFrom(long val)
NOTE:
This is the same as calling setStackTrace(String).
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
<T extends XString> T getStackTraceTo(XString.Factory<T> factory)
If the value of this field is not null this method creates an XString from
the provided Factory, copies this field's value into the type, and returns the new
XString.);
This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;
factory - The factory from which to get the XString to copy into and returnnull.NullPointerException - if the provided factory is nullvoid setStackTraceFrom(XString val)
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than setStackTrace(String)
because it avoids encoding the value into a String if the given XString is already encoded.
void getStackTraceTo(XString val)
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than getStackTrace() bec
because it can avoid decoding the value into an String.
getStackTrace()XString getStackTraceUnsafe()
NOTE:
This method retrieves the raw value backed by this object's buffer. This is a useful operation
when copying this field value to another object because it avoids copying the data into an intermediate
XString and instead allows direct byte transfer from the raw value to the target object.
However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.
Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.
getStackTrace()void clearStackTrace()
setStackTrace(String)boolean hasStackTrace()
getStackTrace()void setHeadline(String val)
val - The value to set.String getHeadline()
void lendHeadline(XString val)
This method is equivalent to setHeadline except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.
Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
val - The value to set.IllegalArgumentException - If the value is mutable.void setHeadlineFrom(long val)
NOTE:
This is the same as calling setHeadline(String).
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
<T extends XString> T getHeadlineTo(XString.Factory<T> factory)
If the value of this field is not null this method creates an XString from
the provided Factory, copies this field's value into the type, and returns the new
XString.);
This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;
factory - The factory from which to get the XString to copy into and returnnull.NullPointerException - if the provided factory is nullvoid setHeadlineFrom(XString val)
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than setHeadline(String)
because it avoids encoding the value into a String if the given XString is already encoded.
void getHeadlineTo(XString val)
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than getHeadline() bec
because it can avoid decoding the value into an String.
getHeadline()XString getHeadlineUnsafe()
NOTE:
This method retrieves the raw value backed by this object's buffer. This is a useful operation
when copying this field value to another object because it avoids copying the data into an intermediate
XString and instead allows direct byte transfer from the raw value to the target object.
However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.
Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.
getHeadline()void clearHeadline()
setHeadline(String)boolean hasHeadline()
getHeadline()Alert copy()
The copy copies primitive, enum and embedded entity fields into the returned copy. Each embedded entity field is cloned so that modifications made to the copy's embedded entity fields do not affect this Alert's embedded entity fields.
The returned copy will be writeable even if this Alert is read only.
No metadata is copied except as documented IRogCopyableNode.
See IRogCopyableNode for more detailed information on the semantics of this method.
copy in interface CopyableMessageView<IAlert>copy in interface IRogCopyableNode<IAlert>IRogCopyableNode,
CopyableMessageViewvoid copyInto(Alert target)
The copy clears the target's contents and copies primitive, enum and embedded entity fields into the provided copy. Each embedded entity field is cloned so that modifications made to the copy's embedded entity fields do not affect this Alert's embedded entity fields.
The returned copy will be writeable even if this Alert is read only.
No metadata is copied except as documented IRogCopyableNode.
See IRogCopyableNode for more detailed information on the semantics of this method.
target - The target to copy into which must not be null or read only.Copyright © 2016 Neeve Research, LLC. All Rights Reserved.