com.neeve.server.mon.alert

Interface ISrvMonAppDuplicateAcknowledgementAlertMessage

All Superinterfaces:

CopyableMessageView<ISrvMonAppDuplicateAcknowledgementAlertMessage>, com.neeve.server.mon.common.IHasSrvMonXvmHeader, IRogCopyableNode<ISrvMonAppDuplicateAcknowledgementAlertMessage>, IRogMessage, IRogMetadata, IRogNode, IRogValidatable, com.neeve.server.mon.common.ISrvMonAlertEvent, com.neeve.server.mon.common.ISrvMonEvent, IStoreObject, IStoreObjectMetadata, ITriggeringMessageMetadata, MapMessageView, MessageView, UtlReferenceTracker.HasReferenceTracker

All Known Implementing Classes:

SrvMonAppDuplicateAcknowledgementAlertMessage

@Generated(value="com.neeve.adm.AdmGenerator",
           date="Thu May 07 15:37:31 EDT 2020")
@AdmGenerated(compatLevel="4.0.0",
              admVersion="nvx-rumi-adm v3.14 (build 29)",
              date="5/7/20 3:37 PM",
              buildInfo="nvx-talon-3.14.19 (nvx-codegen-plugin)")
public interface ISrvMonAppDuplicateAcknowledgementAlertMessage
extends IRogNode, IRogMessage, IRogCopyableNode<ISrvMonAppDuplicateAcknowledgementAlertMessage>, com.neeve.server.mon.common.ISrvMonAlertEvent, ITriggeringMessageMetadata

Event alerting an AEP application of a duplicate ack.

This event is dispatched to an application of an alert triggered by a duplicate acknowledgement of an outbound message send as part of an AEP transaction. This alert is not generated for duplicate acknowledgements received for unsolicited message sends.

ADM Details

ADM Type	Message
Factory	SrvMonAlertFactory

ADM Field Summary

Field	Type	Id	Description
eventSource	String	6006	The source of an event.
eventTimestamp	Date	6007	The timestamp of an event.
timestamp	Long	1	The timestamp at which this event occurred (millis since the epoch).
triggeringMessageMessageBusName	String	4	The bus name for the message that triggered an alert.
triggeringMessageMessageChannelId	String	6	The id of the message channel for the message that triggered an alert.
triggeringMessageMessageChannelName	String	5	The name of the message channel for the message that triggered an alert.
triggeringMessageMessageEncodingType	Byte	13	A message's encoding type for the message that triggered an alert.
triggeringMessageMessageFactoryId	Short	11	A message's sender id for the message that triggered an alert.
triggeringMessageMessageFlowId	Integer	9	A message's flow id for the message that triggered an alert.
triggeringMessageMessageKey	String	7	A message's key for the message that triggered an alert.
triggeringMessageMessageSenderId	Integer	10	A message's sender id for the message that triggered an alert.
triggeringMessageMessageSno	Long	8	A message's sequence number for the message that triggered an alert.
triggeringMessageMessageViewId	Short	12	A message's sender id for the message that triggered an alert.
xvmHeader	SrvMonXvmHeader	6004	Details about the message source.

Nested Class Summary

Nested classes/interfaces inherited from interface com.neeve.rog.IRogNode

IRogNode.PoolingListener

Nested classes/interfaces inherited from interface com.neeve.ods.IStoreObject

IStoreObject.EncodingType

Method Summary

Methods

Modifier and Type	Method and Description
void	clearEventSource() Clears the value of 'eventSource'.
void	clearEventTimestamp() Clears the value of 'eventTimestamp'.
void	clearTimestamp() Deprecated. - Use eventTimestamp instead.
void	clearTriggeringMessageMessageBusName() Clears the value of 'triggeringMessageMessageBusName'.
void	clearTriggeringMessageMessageChannelId() Clears the value of 'triggeringMessageMessageChannelId'.
void	clearTriggeringMessageMessageChannelName() Clears the value of 'triggeringMessageMessageChannelName'.
void	clearTriggeringMessageMessageEncodingType() Clears the value of 'triggeringMessageMessageEncodingType'.
void	clearTriggeringMessageMessageFactoryId() Clears the value of 'triggeringMessageMessageFactoryId'.
void	clearTriggeringMessageMessageFlowId() Clears the value of 'triggeringMessageMessageFlowId'.
void	clearTriggeringMessageMessageKey() Clears the value of 'triggeringMessageMessageKey'.
void	clearTriggeringMessageMessageSenderId() Clears the value of 'triggeringMessageMessageSenderId'.
void	clearTriggeringMessageMessageSno() Clears the value of 'triggeringMessageMessageSno'.
void	clearTriggeringMessageMessageViewId() Clears the value of 'triggeringMessageMessageViewId'.
void	clearXvmHeader() Clears the value of 'xvmHeader'.
SrvMonAppDuplicateAcknowledgementAlertMessage	copy() Creates a copy of this SrvMonAppDuplicateAcknowledgementAlertMessage.
void	copyInto(SrvMonAppDuplicateAcknowledgementAlertMessage target) Copies the contents of this SrvMonAppDuplicateAcknowledgementAlertMessage into the target.
String	getEventSource() Gets the value of 'eventSource'.
<T extends XString> T	getEventSourceTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getEventSourceTo(XString val) Copies the value of 'eventSource' into the provided XString.
XString	getEventSourceUnsafe() Gets the raw value of 'eventSource'.
Date	getEventTimestamp() Gets the value of 'eventTimestamp'.
long	getEventTimestampAsTimestamp() Retrieves the date as a timestamp (a zero garbage operation for XBuf encoding).
long	getTimestamp() Deprecated. - Use eventTimestamp instead.
String	getTriggeringMessageMessageBusName() Gets the value of 'triggeringMessageMessageBusName'.
<T extends XString> T	getTriggeringMessageMessageBusNameTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getTriggeringMessageMessageBusNameTo(XString val) Copies the value of 'triggeringMessageMessageBusName' into the provided XString.
XString	getTriggeringMessageMessageBusNameUnsafe() Gets the raw value of 'triggeringMessageMessageBusName'.
String	getTriggeringMessageMessageChannelId() Gets the value of 'triggeringMessageMessageChannelId'.
<T extends XString> T	getTriggeringMessageMessageChannelIdTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getTriggeringMessageMessageChannelIdTo(XString val) Copies the value of 'triggeringMessageMessageChannelId' into the provided XString.
XString	getTriggeringMessageMessageChannelIdUnsafe() Gets the raw value of 'triggeringMessageMessageChannelId'.
String	getTriggeringMessageMessageChannelName() Gets the value of 'triggeringMessageMessageChannelName'.
<T extends XString> T	getTriggeringMessageMessageChannelNameTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getTriggeringMessageMessageChannelNameTo(XString val) Copies the value of 'triggeringMessageMessageChannelName' into the provided XString.
XString	getTriggeringMessageMessageChannelNameUnsafe() Gets the raw value of 'triggeringMessageMessageChannelName'.
byte	getTriggeringMessageMessageEncodingType() Gets the value of 'triggeringMessageMessageEncodingType'.
short	getTriggeringMessageMessageFactoryId() Gets the value of 'triggeringMessageMessageFactoryId'.
int	getTriggeringMessageMessageFlowId() Gets the value of 'triggeringMessageMessageFlowId'.
String	getTriggeringMessageMessageKey() Gets the value of 'triggeringMessageMessageKey'.
<T extends XString> T	getTriggeringMessageMessageKeyTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getTriggeringMessageMessageKeyTo(XString val) Copies the value of 'triggeringMessageMessageKey' into the provided XString.
XString	getTriggeringMessageMessageKeyUnsafe() Gets the raw value of 'triggeringMessageMessageKey'.
int	getTriggeringMessageMessageSenderId() Gets the value of 'triggeringMessageMessageSenderId'.
long	getTriggeringMessageMessageSno() Gets the value of 'triggeringMessageMessageSno'.
short	getTriggeringMessageMessageViewId() Gets the value of 'triggeringMessageMessageViewId'.
com.neeve.server.mon.common.SrvMonXvmHeader	getXvmHeader() Gets the value of 'xvmHeader'.
void	getXvmHeaderTo(com.neeve.server.mon.common.SrvMonXvmHeader val) Copies the value of SrvMonXvmHeader into the provided value.
boolean	hasEventSource() Checks for the presence of 'eventSource'.
boolean	hasEventTimestamp() Checks for the presence of 'eventTimestamp'.
boolean	hasTimestamp() Deprecated. - Use eventTimestamp instead.
boolean	hasTriggeringMessageMessageBusName() Checks for the presence of 'triggeringMessageMessageBusName'.
boolean	hasTriggeringMessageMessageChannelId() Checks for the presence of 'triggeringMessageMessageChannelId'.
boolean	hasTriggeringMessageMessageChannelName() Checks for the presence of 'triggeringMessageMessageChannelName'.
boolean	hasTriggeringMessageMessageEncodingType() Checks for the presence of 'triggeringMessageMessageEncodingType'.
boolean	hasTriggeringMessageMessageFactoryId() Checks for the presence of 'triggeringMessageMessageFactoryId'.
boolean	hasTriggeringMessageMessageFlowId() Checks for the presence of 'triggeringMessageMessageFlowId'.
boolean	hasTriggeringMessageMessageKey() Checks for the presence of 'triggeringMessageMessageKey'.
boolean	hasTriggeringMessageMessageSenderId() Checks for the presence of 'triggeringMessageMessageSenderId'.
boolean	hasTriggeringMessageMessageSno() Checks for the presence of 'triggeringMessageMessageSno'.
boolean	hasTriggeringMessageMessageViewId() Checks for the presence of 'triggeringMessageMessageViewId'.
boolean	hasXvmHeader() Checks for the presence of 'xvmHeader'.
void	lendEventSource(XString val) Lends the value of 'eventSource' to this object.
void	lendTriggeringMessageMessageBusName(XString val) Lends the value of 'triggeringMessageMessageBusName' to this object.
void	lendTriggeringMessageMessageChannelId(XString val) Lends the value of 'triggeringMessageMessageChannelId' to this object.
void	lendTriggeringMessageMessageChannelName(XString val) Lends the value of 'triggeringMessageMessageChannelName' to this object.
void	lendTriggeringMessageMessageKey(XString val) Lends the value of 'triggeringMessageMessageKey' to this object.
void	lendXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val) 'Lends' a reference of the SrvMonXvmHeader to the message for this field.
void	setEventSource(String val) Sets the value of 'eventSource'.
void	setEventSourceFrom(long val) Sets the value of this String field to the given numeric value.
void	setEventSourceFrom(XString val) Copies the provided XString value into this object's 'eventSource'.
void	setEventTimestamp(Date val) Sets the value of 'eventTimestamp'.
void	setEventTimestampAsTimestamp(long val) Sets the date value as a timestamp.
void	setTimestamp(long val) Deprecated. - Use eventTimestamp instead.
void	setTriggeringMessageMessageBusName(String val) Sets the value of 'triggeringMessageMessageBusName'.
void	setTriggeringMessageMessageBusNameFrom(long val) Sets the value of this String field to the given numeric value.
void	setTriggeringMessageMessageBusNameFrom(XString val) Copies the provided XString value into this object's 'triggeringMessageMessageBusName'.
void	setTriggeringMessageMessageChannelId(String val) Sets the value of 'triggeringMessageMessageChannelId'.
void	setTriggeringMessageMessageChannelIdFrom(long val) Sets the value of this String field to the given numeric value.
void	setTriggeringMessageMessageChannelIdFrom(XString val) Copies the provided XString value into this object's 'triggeringMessageMessageChannelId'.
void	setTriggeringMessageMessageChannelName(String val) Sets the value of 'triggeringMessageMessageChannelName'.
void	setTriggeringMessageMessageChannelNameFrom(long val) Sets the value of this String field to the given numeric value.
void	setTriggeringMessageMessageChannelNameFrom(XString val) Copies the provided XString value into this object's 'triggeringMessageMessageChannelName'.
void	setTriggeringMessageMessageEncodingType(byte val) Sets the value of 'triggeringMessageMessageEncodingType'.
void	setTriggeringMessageMessageFactoryId(short val) Sets the value of 'triggeringMessageMessageFactoryId'.
void	setTriggeringMessageMessageFlowId(int val) Sets the value of 'triggeringMessageMessageFlowId'.
void	setTriggeringMessageMessageKey(String val) Sets the value of 'triggeringMessageMessageKey'.
void	setTriggeringMessageMessageKeyFrom(long val) Sets the value of this String field to the given numeric value.
void	setTriggeringMessageMessageKeyFrom(XString val) Copies the provided XString value into this object's 'triggeringMessageMessageKey'.
void	setTriggeringMessageMessageSenderId(int val) Sets the value of 'triggeringMessageMessageSenderId'.
void	setTriggeringMessageMessageSno(long val) Sets the value of 'triggeringMessageMessageSno'.
void	setTriggeringMessageMessageViewId(short val) Sets the value of 'triggeringMessageMessageViewId'.
void	setXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val) Sets the value of 'xvmHeader'.
com.neeve.server.mon.common.SrvMonXvmHeader	takeXvmHeader() 'Takes' a reference to the xvmHeader field from the message.

Methods inherited from interface com.neeve.rog.IRogNode

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, setTransactionOutSequenceNumber

Methods inherited from interface com.neeve.ods.IStoreObject

acquire, deserialize, deserializeMetadata, deserializeMetadata, getContentEncodingType, getOwnershipCount, getSerializedMetadataLength, getStoreMetadata, serialize, serializeMetadata, setFieldValue

Methods inherited from interface com.neeve.ods.IStoreObjectMetadata

ensureId, getBinding, getCheckpointVersion, getCommittedDataSize, getId, getOfid, getStableTransactionId, getTransactionId, setBinding, setCheckpointVersion, setCommittedDataSize, setId, setStableTransactionId, setTransactionId

Methods inherited from interface com.neeve.sma.MapMessageView

getMessageReflector

Methods inherited from interface com.neeve.rog.IRogMetadata

getEnqueueTs, 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, metadataToString

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Method Detail

setEventTimestamp

void setEventTimestamp(Date val)

Sets the value of 'eventTimestamp'.

Field Description

The timestamp of an event.

Specified by:

setEventTimestamp in interface com.neeve.server.mon.common.ISrvMonAlertEvent

Specified by:

setEventTimestamp in interface com.neeve.server.mon.common.ISrvMonEvent

Parameters:

val - The value to set.

getEventTimestamp

Date getEventTimestamp()

Gets the value of 'eventTimestamp'.

Field Description

The timestamp of an event.

Specified by:

getEventTimestamp in interface com.neeve.server.mon.common.ISrvMonAlertEvent

Specified by:

getEventTimestamp in interface com.neeve.server.mon.common.ISrvMonEvent

Returns:

The timestamp of an event.

setEventTimestampAsTimestamp

void setEventTimestampAsTimestamp(long val)

Sets the date value as a timestamp.

Field Description

The timestamp of an event.

Specified by:

setEventTimestampAsTimestamp in interface com.neeve.server.mon.common.ISrvMonAlertEvent

Specified by:

setEventTimestampAsTimestamp in interface com.neeve.server.mon.common.ISrvMonEvent

Parameters:

val - The date value in milliseconds from the epoch

getEventTimestampAsTimestamp

long getEventTimestampAsTimestamp()

Retrieves the date as a timestamp (a zero garbage operation for XBuf encoding).

Field Description

The timestamp of an event.

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, hasEventTimestamp() should be called.

Specified by:

getEventTimestampAsTimestamp in interface com.neeve.server.mon.common.ISrvMonAlertEvent

Specified by:

getEventTimestampAsTimestamp in interface com.neeve.server.mon.common.ISrvMonEvent

Returns:

The data as a timestamp in milliseconds from the epoch or -1 if null or not set

clearEventTimestamp

void clearEventTimestamp()

Clears the value of 'eventTimestamp'.

Field Description

The timestamp of an event.

Specified by:

clearEventTimestamp in interface com.neeve.server.mon.common.ISrvMonAlertEvent

Specified by:

clearEventTimestamp in interface com.neeve.server.mon.common.ISrvMonEvent

See Also:

setEventTimestamp(Date)

hasEventTimestamp

boolean hasEventTimestamp()

Checks for the presence of 'eventTimestamp'.

Field Description

The timestamp of an event.

Specified by:

hasEventTimestamp in interface com.neeve.server.mon.common.ISrvMonAlertEvent

Specified by:

hasEventTimestamp in interface com.neeve.server.mon.common.ISrvMonEvent

See Also:

getEventTimestamp()

setTriggeringMessageMessageSno

void setTriggeringMessageMessageSno(long val)

Sets the value of 'triggeringMessageMessageSno'.

Field Description

A message's sequence number for the message that triggered an alert.

Specified by:

setTriggeringMessageMessageSno in interface ITriggeringMessageMetadata

Parameters:

val - The value to set.

getTriggeringMessageMessageSno

long getTriggeringMessageMessageSno()

Gets the value of 'triggeringMessageMessageSno'.

Field Description

A message's sequence number for the message that triggered an alert.

Specified by:

getTriggeringMessageMessageSno in interface ITriggeringMessageMetadata

Returns:

A message's sequence number for the message that triggered an alert.

clearTriggeringMessageMessageSno

void clearTriggeringMessageMessageSno()

Clears the value of 'triggeringMessageMessageSno'.

Field Description

A message's sequence number for the message that triggered an alert.

Specified by:

clearTriggeringMessageMessageSno in interface ITriggeringMessageMetadata

See Also:

setTriggeringMessageMessageSno(long)

hasTriggeringMessageMessageSno

boolean hasTriggeringMessageMessageSno()

Checks for the presence of 'triggeringMessageMessageSno'.

Field Description

A message's sequence number for the message that triggered an alert.

Specified by:

hasTriggeringMessageMessageSno in interface ITriggeringMessageMetadata

See Also:

getTriggeringMessageMessageSno()

setTriggeringMessageMessageFlowId

void setTriggeringMessageMessageFlowId(int val)

Sets the value of 'triggeringMessageMessageFlowId'.

Field Description

A message's flow id for the message that triggered an alert.

Specified by:

setTriggeringMessageMessageFlowId in interface ITriggeringMessageMetadata

Parameters:

val - The value to set.

getTriggeringMessageMessageFlowId

int getTriggeringMessageMessageFlowId()

Gets the value of 'triggeringMessageMessageFlowId'.

Field Description

A message's flow id for the message that triggered an alert.

Specified by:

getTriggeringMessageMessageFlowId in interface ITriggeringMessageMetadata

Returns:

A message's flow id for the message that triggered an alert.

clearTriggeringMessageMessageFlowId

void clearTriggeringMessageMessageFlowId()

Clears the value of 'triggeringMessageMessageFlowId'.

Field Description

A message's flow id for the message that triggered an alert.

Specified by:

clearTriggeringMessageMessageFlowId in interface ITriggeringMessageMetadata

See Also:

setTriggeringMessageMessageFlowId(int)

hasTriggeringMessageMessageFlowId

boolean hasTriggeringMessageMessageFlowId()

Checks for the presence of 'triggeringMessageMessageFlowId'.

Field Description

A message's flow id for the message that triggered an alert.

Specified by:

hasTriggeringMessageMessageFlowId in interface ITriggeringMessageMetadata

See Also:

getTriggeringMessageMessageFlowId()

setTriggeringMessageMessageSenderId

void setTriggeringMessageMessageSenderId(int val)

Sets the value of 'triggeringMessageMessageSenderId'.

Field Description

A message's sender id for the message that triggered an alert.

Specified by:

setTriggeringMessageMessageSenderId in interface ITriggeringMessageMetadata

Parameters:

val - The value to set.

getTriggeringMessageMessageSenderId

int getTriggeringMessageMessageSenderId()

Gets the value of 'triggeringMessageMessageSenderId'.

Field Description

A message's sender id for the message that triggered an alert.

Specified by:

getTriggeringMessageMessageSenderId in interface ITriggeringMessageMetadata

Returns:

A message's sender id for the message that triggered an alert.

clearTriggeringMessageMessageSenderId

void clearTriggeringMessageMessageSenderId()

Clears the value of 'triggeringMessageMessageSenderId'.

Field Description

A message's sender id for the message that triggered an alert.

Specified by:

clearTriggeringMessageMessageSenderId in interface ITriggeringMessageMetadata

See Also:

setTriggeringMessageMessageSenderId(int)

hasTriggeringMessageMessageSenderId

boolean hasTriggeringMessageMessageSenderId()

Checks for the presence of 'triggeringMessageMessageSenderId'.

Field Description

A message's sender id for the message that triggered an alert.

Specified by:

hasTriggeringMessageMessageSenderId in interface ITriggeringMessageMetadata

See Also:

getTriggeringMessageMessageSenderId()

setTriggeringMessageMessageFactoryId

void setTriggeringMessageMessageFactoryId(short val)

Sets the value of 'triggeringMessageMessageFactoryId'.

Field Description

A message's sender id for the message that triggered an alert.

Specified by:

setTriggeringMessageMessageFactoryId in interface ITriggeringMessageMetadata

Parameters:

val - The value to set.

getTriggeringMessageMessageFactoryId

short getTriggeringMessageMessageFactoryId()

Gets the value of 'triggeringMessageMessageFactoryId'.

Field Description

A message's sender id for the message that triggered an alert.

Specified by:

getTriggeringMessageMessageFactoryId in interface ITriggeringMessageMetadata

Returns:

A message's sender id for the message that triggered an alert.

clearTriggeringMessageMessageFactoryId

void clearTriggeringMessageMessageFactoryId()

Clears the value of 'triggeringMessageMessageFactoryId'.

Field Description

A message's sender id for the message that triggered an alert.

Specified by:

clearTriggeringMessageMessageFactoryId in interface ITriggeringMessageMetadata

See Also:

setTriggeringMessageMessageFactoryId(short)

hasTriggeringMessageMessageFactoryId

boolean hasTriggeringMessageMessageFactoryId()

Checks for the presence of 'triggeringMessageMessageFactoryId'.

Field Description

A message's sender id for the message that triggered an alert.

Specified by:

hasTriggeringMessageMessageFactoryId in interface ITriggeringMessageMetadata

See Also:

getTriggeringMessageMessageFactoryId()

setTriggeringMessageMessageViewId

void setTriggeringMessageMessageViewId(short val)

Sets the value of 'triggeringMessageMessageViewId'.

Field Description

A message's sender id for the message that triggered an alert.

Specified by:

setTriggeringMessageMessageViewId in interface ITriggeringMessageMetadata

Parameters:

val - The value to set.

getTriggeringMessageMessageViewId

short getTriggeringMessageMessageViewId()

Gets the value of 'triggeringMessageMessageViewId'.

Field Description

A message's sender id for the message that triggered an alert.

Specified by:

getTriggeringMessageMessageViewId in interface ITriggeringMessageMetadata

Returns:

A message's sender id for the message that triggered an alert.

clearTriggeringMessageMessageViewId

void clearTriggeringMessageMessageViewId()

Clears the value of 'triggeringMessageMessageViewId'.

Field Description

A message's sender id for the message that triggered an alert.

Specified by:

clearTriggeringMessageMessageViewId in interface ITriggeringMessageMetadata

See Also:

setTriggeringMessageMessageViewId(short)

hasTriggeringMessageMessageViewId

boolean hasTriggeringMessageMessageViewId()

Checks for the presence of 'triggeringMessageMessageViewId'.

Field Description

A message's sender id for the message that triggered an alert.

Specified by:

hasTriggeringMessageMessageViewId in interface ITriggeringMessageMetadata

See Also:

getTriggeringMessageMessageViewId()

setTriggeringMessageMessageEncodingType

void setTriggeringMessageMessageEncodingType(byte val)

Sets the value of 'triggeringMessageMessageEncodingType'.

Field Description

A message's encoding type for the message that triggered an alert.

Specified by:

setTriggeringMessageMessageEncodingType in interface ITriggeringMessageMetadata

Parameters:

val - The value to set.

getTriggeringMessageMessageEncodingType

byte getTriggeringMessageMessageEncodingType()

Gets the value of 'triggeringMessageMessageEncodingType'.

Field Description

A message's encoding type for the message that triggered an alert.

Specified by:

getTriggeringMessageMessageEncodingType in interface ITriggeringMessageMetadata

Returns:

A message's encoding type for the message that triggered an alert.

clearTriggeringMessageMessageEncodingType

void clearTriggeringMessageMessageEncodingType()

Clears the value of 'triggeringMessageMessageEncodingType'.

Field Description

A message's encoding type for the message that triggered an alert.

Specified by:

clearTriggeringMessageMessageEncodingType in interface ITriggeringMessageMetadata

See Also:

setTriggeringMessageMessageEncodingType(byte)

hasTriggeringMessageMessageEncodingType

boolean hasTriggeringMessageMessageEncodingType()

Checks for the presence of 'triggeringMessageMessageEncodingType'.

Field Description

A message's encoding type for the message that triggered an alert.

Specified by:

hasTriggeringMessageMessageEncodingType in interface ITriggeringMessageMetadata

See Also:

getTriggeringMessageMessageEncodingType()

setTimestamp

@Deprecated
void setTimestamp(long val)

Deprecated. - Use eventTimestamp instead.

Sets the value of 'timestamp'.

Field Description

The timestamp at which this event occurred (millis since the epoch).

Parameters:

val - The value to set.

getTimestamp

@Deprecated
long getTimestamp()

Deprecated. - Use eventTimestamp instead.

Gets the value of 'timestamp'.

Field Description

The timestamp at which this event occurred (millis since the epoch).

Returns:

The timestamp at which this event occurred (millis since the epoch).

clearTimestamp

@Deprecated
void clearTimestamp()

Deprecated. - Use eventTimestamp instead.

Clears the value of 'timestamp'.

Field Description

The timestamp at which this event occurred (millis since the epoch).

See Also:

setTimestamp(long)

hasTimestamp

@Deprecated
boolean hasTimestamp()

Deprecated. - Use eventTimestamp instead.

Checks for the presence of 'timestamp'.

Field Description

The timestamp at which this event occurred (millis since the epoch).

See Also:

getTimestamp()

setXvmHeader

void setXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)

Sets the value of 'xvmHeader'.

Field Description

Details about the message source.

Specified by:

setXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader

Specified by:

setXvmHeader in interface com.neeve.server.mon.common.ISrvMonAlertEvent

Specified by:

setXvmHeader in interface com.neeve.server.mon.common.ISrvMonEvent

Parameters:

val - The value to set.

lendXvmHeader

void lendXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)

'Lends' a reference of the SrvMonXvmHeader to the message for this field.

Field Description

Details about the message source.

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.

Specified by:

lendXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader

Specified by:

lendXvmHeader in interface com.neeve.server.mon.common.ISrvMonAlertEvent

Specified by:

lendXvmHeader in interface com.neeve.server.mon.common.ISrvMonEvent

Parameters:

val - the value to 'lend' to lend.

getXvmHeader

com.neeve.server.mon.common.SrvMonXvmHeader getXvmHeader()

Gets the value of 'xvmHeader'.

Field Description

Details about the message source.

Specified by:

getXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader

Specified by:

getXvmHeader in interface com.neeve.server.mon.common.ISrvMonAlertEvent

Specified by:

getXvmHeader in interface com.neeve.server.mon.common.ISrvMonEvent

Returns:

Details about the message source.

getXvmHeaderTo

void getXvmHeaderTo(com.neeve.server.mon.common.SrvMonXvmHeader val)

Copies the value of SrvMonXvmHeader into the provided value.

IF the value is not set, then the contents of the provided SrvMonXvmHeader are cleared.

Specified by:

getXvmHeaderTo in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader

Specified by:

getXvmHeaderTo in interface com.neeve.server.mon.common.ISrvMonAlertEvent

Specified by:

getXvmHeaderTo in interface com.neeve.server.mon.common.ISrvMonEvent

Parameters:

val - the value to copy into

See Also:

SrvMonXvmHeader.copyInto(SrvMonXvmHeader)

takeXvmHeader

com.neeve.server.mon.common.SrvMonXvmHeader takeXvmHeader()

'Takes' a reference to the xvmHeader field from the message.

Field Description

Details about the message source.

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.

Specified by:

takeXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader

Specified by:

takeXvmHeader in interface com.neeve.server.mon.common.ISrvMonAlertEvent

Specified by:

takeXvmHeader in interface com.neeve.server.mon.common.ISrvMonEvent

Returns:

a 'taken' reference to the field or null if the field is not set.

hasXvmHeader

boolean hasXvmHeader()

Checks for the presence of 'xvmHeader'.

Field Description

Details about the message source.

Specified by:

hasXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader

Specified by:

hasXvmHeader in interface com.neeve.server.mon.common.ISrvMonAlertEvent

Specified by:

hasXvmHeader in interface com.neeve.server.mon.common.ISrvMonEvent

See Also:

getXvmHeader()

clearXvmHeader

void clearXvmHeader()

Clears the value of 'xvmHeader'.

Field Description

Details about the message source.

Specified by:

clearXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader

Specified by:

clearXvmHeader in interface com.neeve.server.mon.common.ISrvMonAlertEvent

Specified by:

clearXvmHeader in interface com.neeve.server.mon.common.ISrvMonEvent

See Also:

setXvmHeader(SrvMonXvmHeader)

setEventSource

void setEventSource(String val)

Sets the value of 'eventSource'.

Field Description

The source of an event.

Specified by:

setEventSource in interface com.neeve.server.mon.common.ISrvMonAlertEvent

Specified by:

setEventSource in interface com.neeve.server.mon.common.ISrvMonEvent

Parameters:

val - The value to set.

getEventSource

String getEventSource()

Gets the value of 'eventSource'.

Field Description

The source of an event.

Specified by:

getEventSource in interface com.neeve.server.mon.common.ISrvMonAlertEvent

Specified by:

getEventSource in interface com.neeve.server.mon.common.ISrvMonEvent

Returns:

The source of an event.

lendEventSource

void lendEventSource(XString val)

Lends the value of 'eventSource' to this object.

This method is equivalent to setEventSource 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.

Field Description

The source of an event.

Usage Notes

Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.

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.

Specified by:

lendEventSource in interface com.neeve.server.mon.common.ISrvMonAlertEvent

Specified by:

lendEventSource in interface com.neeve.server.mon.common.ISrvMonEvent

Parameters:

val - The value to set.

Throws:

IllegalArgumentException - If the value is mutable.

setEventSourceFrom

void setEventSourceFrom(long val)

Sets the value of this String field to the given numeric value.

Field Description

The source of an event.

NOTE:
This is the same as calling setEventSource(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

Specified by:

setEventSourceFrom in interface com.neeve.server.mon.common.ISrvMonAlertEvent

Specified by:

setEventSourceFrom in interface com.neeve.server.mon.common.ISrvMonEvent

getEventSourceTo

<T extends XString> T getEventSourceTo(XString.Factory<T> factory)

Copies the value of this String field into a new XString from the given factory.

Field Description

The source of an event.

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;

Specified by:

getEventSourceTo in interface com.neeve.server.mon.common.ISrvMonAlertEvent

Specified by:

getEventSourceTo in interface com.neeve.server.mon.common.ISrvMonEvent

Parameters:

factory - The factory from which to get the XString to copy into and return

Returns:

a new XString from the provided factory if this field is set or null.

Throws:

NullPointerException - if the provided factory is null

setEventSourceFrom

void setEventSourceFrom(XString val)

Copies the provided XString value into this object's 'eventSource'.

Field Description

The source of an event.

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than setEventSource(String) because it avoids encoding the value into a String if the given XString is already encoded.

Specified by:

setEventSourceFrom in interface com.neeve.server.mon.common.ISrvMonAlertEvent

Specified by:

setEventSourceFrom in interface com.neeve.server.mon.common.ISrvMonEvent

getEventSourceTo

void getEventSourceTo(XString val)

Copies the value of 'eventSource' into the provided XString.

Field Description

The source of an event.

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than getEventSource() bec because it can avoid decoding the value into an String.

Specified by:

getEventSourceTo in interface com.neeve.server.mon.common.ISrvMonAlertEvent

Specified by:

getEventSourceTo in interface com.neeve.server.mon.common.ISrvMonEvent

See Also:

getEventSource()

getEventSourceUnsafe

XString getEventSourceUnsafe()

Gets the raw value of 'eventSource'.

Field Description

The source of an event.

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.

Specified by:

getEventSourceUnsafe in interface com.neeve.server.mon.common.ISrvMonAlertEvent

Specified by:

getEventSourceUnsafe in interface com.neeve.server.mon.common.ISrvMonEvent

Returns:

the field's raw value

See Also:

getEventSource()

clearEventSource

void clearEventSource()

Clears the value of 'eventSource'.

Field Description

The source of an event.

Specified by:

clearEventSource in interface com.neeve.server.mon.common.ISrvMonAlertEvent

Specified by:

clearEventSource in interface com.neeve.server.mon.common.ISrvMonEvent

See Also:

setEventSource(String)

hasEventSource

boolean hasEventSource()

Checks for the presence of 'eventSource'.

Field Description

The source of an event.

Specified by:

hasEventSource in interface com.neeve.server.mon.common.ISrvMonAlertEvent

Specified by:

hasEventSource in interface com.neeve.server.mon.common.ISrvMonEvent

See Also:

getEventSource()

setTriggeringMessageMessageBusName

void setTriggeringMessageMessageBusName(String val)

Sets the value of 'triggeringMessageMessageBusName'.

Field Description

The bus name for the message that triggered an alert.

Field Type Semantics

A String representing a message bus name.

Specified by:

setTriggeringMessageMessageBusName in interface ITriggeringMessageMetadata

Parameters:

val - The value to set.

getTriggeringMessageMessageBusName

String getTriggeringMessageMessageBusName()

Gets the value of 'triggeringMessageMessageBusName'.

Field Description

The bus name for the message that triggered an alert.

Field Type Semantics

A String representing a message bus name.

Specified by:

getTriggeringMessageMessageBusName in interface ITriggeringMessageMetadata

Returns:

The bus name for the message that triggered an alert.

lendTriggeringMessageMessageBusName

void lendTriggeringMessageMessageBusName(XString val)

Lends the value of 'triggeringMessageMessageBusName' to this object.

This method is equivalent to setTriggeringMessageMessageBusName 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.

Field Description

The bus name for the message that triggered an alert.

Field Type Semantics

A String representing a message bus name.

Usage Notes

Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.

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.

Specified by:

lendTriggeringMessageMessageBusName in interface ITriggeringMessageMetadata

Parameters:

val - The value to set.

Throws:

IllegalArgumentException - If the value is mutable.

setTriggeringMessageMessageBusNameFrom

void setTriggeringMessageMessageBusNameFrom(long val)

Sets the value of this String field to the given numeric value.

Field Description

The bus name for the message that triggered an alert.

Field Type Semantics

A String representing a message bus name.

NOTE:
This is the same as calling setTriggeringMessageMessageBusName(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

Specified by:

setTriggeringMessageMessageBusNameFrom in interface ITriggeringMessageMetadata

getTriggeringMessageMessageBusNameTo

<T extends XString> T getTriggeringMessageMessageBusNameTo(XString.Factory<T> factory)

Copies the value of this String field into a new XString from the given factory.

Field Description

The bus name for the message that triggered an alert.

Field Type Semantics

A String representing a message bus name.

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;

Specified by:

getTriggeringMessageMessageBusNameTo in interface ITriggeringMessageMetadata

Parameters:

factory - The factory from which to get the XString to copy into and return

Returns:

a new XString from the provided factory if this field is set or null.

Throws:

NullPointerException - if the provided factory is null

setTriggeringMessageMessageBusNameFrom

void setTriggeringMessageMessageBusNameFrom(XString val)

Copies the provided XString value into this object's 'triggeringMessageMessageBusName'.

Field Description

The bus name for the message that triggered an alert.

Field Type Semantics

A String representing a message bus name.

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than setTriggeringMessageMessageBusName(String) because it avoids encoding the value into a String if the given XString is already encoded.

Specified by:

setTriggeringMessageMessageBusNameFrom in interface ITriggeringMessageMetadata

getTriggeringMessageMessageBusNameTo

void getTriggeringMessageMessageBusNameTo(XString val)

Copies the value of 'triggeringMessageMessageBusName' into the provided XString.

Field Description

The bus name for the message that triggered an alert.

Field Type Semantics

A String representing a message bus name.

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than getTriggeringMessageMessageBusName() bec because it can avoid decoding the value into an String.

Specified by:

getTriggeringMessageMessageBusNameTo in interface ITriggeringMessageMetadata

See Also:

getTriggeringMessageMessageBusName()

getTriggeringMessageMessageBusNameUnsafe

XString getTriggeringMessageMessageBusNameUnsafe()

Gets the raw value of 'triggeringMessageMessageBusName'.

Field Description

The bus name for the message that triggered an alert.

Field Type Semantics

A String representing a message bus name.

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.

Specified by:

getTriggeringMessageMessageBusNameUnsafe in interface ITriggeringMessageMetadata

Returns:

the field's raw value

See Also:

getTriggeringMessageMessageBusName()

clearTriggeringMessageMessageBusName

void clearTriggeringMessageMessageBusName()

Clears the value of 'triggeringMessageMessageBusName'.

Field Description

The bus name for the message that triggered an alert.

Field Type Semantics

A String representing a message bus name.

Specified by:

clearTriggeringMessageMessageBusName in interface ITriggeringMessageMetadata

See Also:

setTriggeringMessageMessageBusName(String)

hasTriggeringMessageMessageBusName

boolean hasTriggeringMessageMessageBusName()

Checks for the presence of 'triggeringMessageMessageBusName'.

Field Description

The bus name for the message that triggered an alert.

Field Type Semantics

A String representing a message bus name.

Specified by:

hasTriggeringMessageMessageBusName in interface ITriggeringMessageMetadata

See Also:

getTriggeringMessageMessageBusName()

setTriggeringMessageMessageChannelName

void setTriggeringMessageMessageChannelName(String val)

Sets the value of 'triggeringMessageMessageChannelName'.

Field Description

The name of the message channel for the message that triggered an alert.

Specified by:

setTriggeringMessageMessageChannelName in interface ITriggeringMessageMetadata

Parameters:

val - The value to set.

getTriggeringMessageMessageChannelName

String getTriggeringMessageMessageChannelName()

Gets the value of 'triggeringMessageMessageChannelName'.

Field Description

The name of the message channel for the message that triggered an alert.

Specified by:

getTriggeringMessageMessageChannelName in interface ITriggeringMessageMetadata

Returns:

The name of the message channel for the message that triggered an alert.

lendTriggeringMessageMessageChannelName

void lendTriggeringMessageMessageChannelName(XString val)

Lends the value of 'triggeringMessageMessageChannelName' to this object.

This method is equivalent to setTriggeringMessageMessageChannelName 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.

Field Description

The name of the message channel for the message that triggered an alert.

Usage Notes

Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.

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.

Specified by:

lendTriggeringMessageMessageChannelName in interface ITriggeringMessageMetadata

Parameters:

val - The value to set.

Throws:

IllegalArgumentException - If the value is mutable.

setTriggeringMessageMessageChannelNameFrom

void setTriggeringMessageMessageChannelNameFrom(long val)

Sets the value of this String field to the given numeric value.

Field Description

The name of the message channel for the message that triggered an alert.

NOTE:
This is the same as calling setTriggeringMessageMessageChannelName(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

Specified by:

setTriggeringMessageMessageChannelNameFrom in interface ITriggeringMessageMetadata

getTriggeringMessageMessageChannelNameTo

<T extends XString> T getTriggeringMessageMessageChannelNameTo(XString.Factory<T> factory)

Copies the value of this String field into a new XString from the given factory.

Field Description

The name of the message channel for the message that triggered an alert.

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;

Specified by:

getTriggeringMessageMessageChannelNameTo in interface ITriggeringMessageMetadata

Parameters:

factory - The factory from which to get the XString to copy into and return

Returns:

a new XString from the provided factory if this field is set or null.

Throws:

NullPointerException - if the provided factory is null

setTriggeringMessageMessageChannelNameFrom

void setTriggeringMessageMessageChannelNameFrom(XString val)

Copies the provided XString value into this object's 'triggeringMessageMessageChannelName'.

Field Description

The name of the message channel for the message that triggered an alert.

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than setTriggeringMessageMessageChannelName(String) because it avoids encoding the value into a String if the given XString is already encoded.

Specified by:

setTriggeringMessageMessageChannelNameFrom in interface ITriggeringMessageMetadata

getTriggeringMessageMessageChannelNameTo

void getTriggeringMessageMessageChannelNameTo(XString val)

Copies the value of 'triggeringMessageMessageChannelName' into the provided XString.

Field Description

The name of the message channel for the message that triggered an alert.

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than getTriggeringMessageMessageChannelName() bec because it can avoid decoding the value into an String.

Specified by:

getTriggeringMessageMessageChannelNameTo in interface ITriggeringMessageMetadata

See Also:

getTriggeringMessageMessageChannelName()

getTriggeringMessageMessageChannelNameUnsafe

XString getTriggeringMessageMessageChannelNameUnsafe()

Gets the raw value of 'triggeringMessageMessageChannelName'.

Field Description

The name of the message channel for the message that triggered an alert.

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.

Specified by:

getTriggeringMessageMessageChannelNameUnsafe in interface ITriggeringMessageMetadata

Returns:

the field's raw value

See Also:

getTriggeringMessageMessageChannelName()

clearTriggeringMessageMessageChannelName

void clearTriggeringMessageMessageChannelName()

Clears the value of 'triggeringMessageMessageChannelName'.

Field Description

The name of the message channel for the message that triggered an alert.

Specified by:

clearTriggeringMessageMessageChannelName in interface ITriggeringMessageMetadata

See Also:

setTriggeringMessageMessageChannelName(String)

hasTriggeringMessageMessageChannelName

boolean hasTriggeringMessageMessageChannelName()

Checks for the presence of 'triggeringMessageMessageChannelName'.

Field Description

The name of the message channel for the message that triggered an alert.

Specified by:

hasTriggeringMessageMessageChannelName in interface ITriggeringMessageMetadata

See Also:

getTriggeringMessageMessageChannelName()

setTriggeringMessageMessageChannelId

void setTriggeringMessageMessageChannelId(String val)

Sets the value of 'triggeringMessageMessageChannelId'.

Field Description

The id of the message channel for the message that triggered an alert.

Specified by:

setTriggeringMessageMessageChannelId in interface ITriggeringMessageMetadata

Parameters:

val - The value to set.

getTriggeringMessageMessageChannelId

String getTriggeringMessageMessageChannelId()

Gets the value of 'triggeringMessageMessageChannelId'.

Field Description

The id of the message channel for the message that triggered an alert.

Specified by:

getTriggeringMessageMessageChannelId in interface ITriggeringMessageMetadata

Returns:

The id of the message channel for the message that triggered an alert.

lendTriggeringMessageMessageChannelId

void lendTriggeringMessageMessageChannelId(XString val)

Lends the value of 'triggeringMessageMessageChannelId' to this object.

This method is equivalent to setTriggeringMessageMessageChannelId 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.

Field Description

The id of the message channel for the message that triggered an alert.

Usage Notes

Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.

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.

Specified by:

lendTriggeringMessageMessageChannelId in interface ITriggeringMessageMetadata

Parameters:

val - The value to set.

Throws:

IllegalArgumentException - If the value is mutable.

setTriggeringMessageMessageChannelIdFrom

void setTriggeringMessageMessageChannelIdFrom(long val)

Sets the value of this String field to the given numeric value.

Field Description

The id of the message channel for the message that triggered an alert.

NOTE:
This is the same as calling setTriggeringMessageMessageChannelId(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

Specified by:

setTriggeringMessageMessageChannelIdFrom in interface ITriggeringMessageMetadata

getTriggeringMessageMessageChannelIdTo

<T extends XString> T getTriggeringMessageMessageChannelIdTo(XString.Factory<T> factory)

Copies the value of this String field into a new XString from the given factory.

Field Description

The id of the message channel for the message that triggered an alert.

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;

Specified by:

getTriggeringMessageMessageChannelIdTo in interface ITriggeringMessageMetadata

Parameters:

factory - The factory from which to get the XString to copy into and return

Returns:

a new XString from the provided factory if this field is set or null.

Throws:

NullPointerException - if the provided factory is null

setTriggeringMessageMessageChannelIdFrom

void setTriggeringMessageMessageChannelIdFrom(XString val)

Copies the provided XString value into this object's 'triggeringMessageMessageChannelId'.

Field Description

The id of the message channel for the message that triggered an alert.

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than setTriggeringMessageMessageChannelId(String) because it avoids encoding the value into a String if the given XString is already encoded.

Specified by:

setTriggeringMessageMessageChannelIdFrom in interface ITriggeringMessageMetadata

getTriggeringMessageMessageChannelIdTo

void getTriggeringMessageMessageChannelIdTo(XString val)

Copies the value of 'triggeringMessageMessageChannelId' into the provided XString.

Field Description

The id of the message channel for the message that triggered an alert.

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than getTriggeringMessageMessageChannelId() bec because it can avoid decoding the value into an String.

Specified by:

getTriggeringMessageMessageChannelIdTo in interface ITriggeringMessageMetadata

See Also:

getTriggeringMessageMessageChannelId()

getTriggeringMessageMessageChannelIdUnsafe

XString getTriggeringMessageMessageChannelIdUnsafe()

Gets the raw value of 'triggeringMessageMessageChannelId'.

Field Description

The id of the message channel for the message that triggered an alert.

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.

Specified by:

getTriggeringMessageMessageChannelIdUnsafe in interface ITriggeringMessageMetadata

Returns:

the field's raw value

See Also:

getTriggeringMessageMessageChannelId()

clearTriggeringMessageMessageChannelId

void clearTriggeringMessageMessageChannelId()

Clears the value of 'triggeringMessageMessageChannelId'.

Field Description

The id of the message channel for the message that triggered an alert.

Specified by:

clearTriggeringMessageMessageChannelId in interface ITriggeringMessageMetadata

See Also:

setTriggeringMessageMessageChannelId(String)

hasTriggeringMessageMessageChannelId

boolean hasTriggeringMessageMessageChannelId()

Checks for the presence of 'triggeringMessageMessageChannelId'.

Field Description

The id of the message channel for the message that triggered an alert.

Specified by:

hasTriggeringMessageMessageChannelId in interface ITriggeringMessageMetadata

See Also:

getTriggeringMessageMessageChannelId()

setTriggeringMessageMessageKey

void setTriggeringMessageMessageKey(String val)

Sets the value of 'triggeringMessageMessageKey'.

Field Description

A message's key for the message that triggered an alert.

Specified by:

setTriggeringMessageMessageKey in interface ITriggeringMessageMetadata

Parameters:

val - The value to set.

getTriggeringMessageMessageKey

String getTriggeringMessageMessageKey()

Gets the value of 'triggeringMessageMessageKey'.

Field Description

A message's key for the message that triggered an alert.

Specified by:

getTriggeringMessageMessageKey in interface ITriggeringMessageMetadata

Returns:

A message's key for the message that triggered an alert.

lendTriggeringMessageMessageKey

void lendTriggeringMessageMessageKey(XString val)

Lends the value of 'triggeringMessageMessageKey' to this object.

This method is equivalent to setTriggeringMessageMessageKey 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.

Field Description

A message's key for the message that triggered an alert.

Usage Notes

Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.

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.

Specified by:

lendTriggeringMessageMessageKey in interface ITriggeringMessageMetadata

Parameters:

val - The value to set.

Throws:

IllegalArgumentException - If the value is mutable.

setTriggeringMessageMessageKeyFrom

void setTriggeringMessageMessageKeyFrom(long val)

Sets the value of this String field to the given numeric value.

Field Description

A message's key for the message that triggered an alert.

NOTE:
This is the same as calling setTriggeringMessageMessageKey(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

Specified by:

setTriggeringMessageMessageKeyFrom in interface ITriggeringMessageMetadata

getTriggeringMessageMessageKeyTo

<T extends XString> T getTriggeringMessageMessageKeyTo(XString.Factory<T> factory)

Copies the value of this String field into a new XString from the given factory.

Field Description

A message's key for the message that triggered an alert.

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;

Specified by:

getTriggeringMessageMessageKeyTo in interface ITriggeringMessageMetadata

Parameters:

factory - The factory from which to get the XString to copy into and return

Returns:

a new XString from the provided factory if this field is set or null.

Throws:

NullPointerException - if the provided factory is null

setTriggeringMessageMessageKeyFrom

void setTriggeringMessageMessageKeyFrom(XString val)

Copies the provided XString value into this object's 'triggeringMessageMessageKey'.

Field Description

A message's key for the message that triggered an alert.

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than setTriggeringMessageMessageKey(String) because it avoids encoding the value into a String if the given XString is already encoded.

Specified by:

setTriggeringMessageMessageKeyFrom in interface ITriggeringMessageMetadata

getTriggeringMessageMessageKeyTo

void getTriggeringMessageMessageKeyTo(XString val)

Copies the value of 'triggeringMessageMessageKey' into the provided XString.

Field Description

A message's key for the message that triggered an alert.

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than getTriggeringMessageMessageKey() bec because it can avoid decoding the value into an String.

Specified by:

getTriggeringMessageMessageKeyTo in interface ITriggeringMessageMetadata

See Also:

getTriggeringMessageMessageKey()

getTriggeringMessageMessageKeyUnsafe

XString getTriggeringMessageMessageKeyUnsafe()

Gets the raw value of 'triggeringMessageMessageKey'.

Field Description

A message's key for the message that triggered an alert.

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.

Specified by:

getTriggeringMessageMessageKeyUnsafe in interface ITriggeringMessageMetadata

Returns:

the field's raw value

See Also:

getTriggeringMessageMessageKey()

clearTriggeringMessageMessageKey

void clearTriggeringMessageMessageKey()

Clears the value of 'triggeringMessageMessageKey'.

Field Description

A message's key for the message that triggered an alert.

Specified by:

clearTriggeringMessageMessageKey in interface ITriggeringMessageMetadata

See Also:

setTriggeringMessageMessageKey(String)

hasTriggeringMessageMessageKey

boolean hasTriggeringMessageMessageKey()

Checks for the presence of 'triggeringMessageMessageKey'.

Field Description

A message's key for the message that triggered an alert.

Specified by:

hasTriggeringMessageMessageKey in interface ITriggeringMessageMetadata

See Also:

getTriggeringMessageMessageKey()

copy

SrvMonAppDuplicateAcknowledgementAlertMessage copy()

Creates a copy of this SrvMonAppDuplicateAcknowledgementAlertMessage.

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 SrvMonAppDuplicateAcknowledgementAlertMessage's embedded entity fields.

The returned copy will be writeable even if this SrvMonAppDuplicateAcknowledgementAlertMessage is read only.

No metadata is copied except as documented IRogCopyableNode. See IRogCopyableNode for more detailed information on the semantics of this method.

Specified by:

copy in interface CopyableMessageView<ISrvMonAppDuplicateAcknowledgementAlertMessage>

Specified by:

copy in interface IRogCopyableNode<ISrvMonAppDuplicateAcknowledgementAlertMessage>

Returns:

A copy of this SrvMonAppDuplicateAcknowledgementAlertMessage.

See Also:

IRogCopyableNode, CopyableMessageView

copyInto

void copyInto(SrvMonAppDuplicateAcknowledgementAlertMessage target)

Copies the contents of this SrvMonAppDuplicateAcknowledgementAlertMessage into the 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 SrvMonAppDuplicateAcknowledgementAlertMessage's embedded entity fields.

The returned copy will be writeable even if this SrvMonAppDuplicateAcknowledgementAlertMessage is read only.

No metadata is copied except as documented IRogCopyableNode. See IRogCopyableNode for more detailed information on the semantics of this method.

Parameters:

target - The target to copy into which must not be null or read only.