com.neeve.server.mon.alert
Interface ITriggeringMessageMetadata

All Superinterfaces:
IRogValidatable
All Known Subinterfaces:
ISrvMonAppDuplicateAcknowledgementAlertMessage, ISrvMonAppExceptionMessage, ISrvMonAppInboundLogExceptionMessage, ISrvMonAppOutboundLogExceptionMessage, ISrvMonAppOutOfOrderSendCommitCompletionAlertMessage, ISrvMonAppSendExceptionMessage, ISrvMonAppUnhandledMessageMessage, ISrvMonMessageTraceLoggingExceptionMessage, ISrvMonUnhandledMessageMessage
All Known Implementing Classes:
SrvMonAppDuplicateAcknowledgementAlertMessage, SrvMonAppExceptionMessage, SrvMonAppInboundLogExceptionMessage, SrvMonAppOutboundLogExceptionMessage, SrvMonAppOutOfOrderSendCommitCompletionAlertMessage, SrvMonAppSendExceptionMessage, SrvMonAppUnhandledMessageMessage, SrvMonMessageTraceLoggingExceptionMessage, SrvMonUnhandledMessageMessage, TriggeringMessageMetadata

@Generated(value="com.neeve.adm.AdmGenerator",
           date="Wed Mar 28 10:54:31 EDT 2018")
@AdmGenerated(compatLevel="3.8.0",
              admVersion="nvx-adm v3.7.265 (build 0)",
              date="3/28/18 10:54 AM",
              buildInfo="nvx-talon-3.7.265 (nvx-codegen-plugin)")
public interface ITriggeringMessageMetadata
extends IRogValidatable

Message metadata associated with the message that caused an alert.


Method Summary
 void clearTriggeringMessageMessageBusName()
          Clears the value of 'triggeringMessageMessageBusName' Field Description The bus name for the message that triggered an alert.
 void clearTriggeringMessageMessageChannelId()
          Clears the value of 'triggeringMessageMessageChannelId' Field Description The id of the message channel for the message that triggered an alert.
 void clearTriggeringMessageMessageChannelName()
          Clears the value of 'triggeringMessageMessageChannelName' Field Description The name of the message channel for the message that triggered an alert.
 void clearTriggeringMessageMessageEncodingType()
          Clears the value of 'triggeringMessageMessageEncodingType' Field Description A message's encoding type for the message that triggered an alert.
 void clearTriggeringMessageMessageFactoryId()
          Clears the value of 'triggeringMessageMessageFactoryId' Field Description A message's sender id for the message that triggered an alert.
 void clearTriggeringMessageMessageFlowId()
          Clears the value of 'triggeringMessageMessageFlowId' Field Description A message's flow id for the message that triggered an alert.
 void clearTriggeringMessageMessageKey()
          Clears the value of 'triggeringMessageMessageKey' Field Description A message's key for the message that triggered an alert.
 void clearTriggeringMessageMessageSenderId()
          Clears the value of 'triggeringMessageMessageSenderId' Field Description A message's sender id for the message that triggered an alert.
 void clearTriggeringMessageMessageSno()
          Clears the value of 'triggeringMessageMessageSno' Field Description A message's sequence number for the message that triggered an alert.
 void clearTriggeringMessageMessageViewId()
          Clears the value of 'triggeringMessageMessageViewId' Field Description A message's sender id for the message that triggered an alert.
 String getTriggeringMessageMessageBusName()
          Gets the value of 'triggeringMessageMessageBusName' Field Description The bus name for the message that triggered an alert.
<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' Field Description The id of the message channel for the message that triggered an alert.
<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' Field Description The name of the message channel for the message that triggered an alert.
<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' Field Description A message's encoding type for the message that triggered an alert.
 short getTriggeringMessageMessageFactoryId()
          Gets the value of 'triggeringMessageMessageFactoryId' Field Description A message's sender id for the message that triggered an alert.
 int getTriggeringMessageMessageFlowId()
          Gets the value of 'triggeringMessageMessageFlowId' Field Description A message's flow id for the message that triggered an alert.
 String getTriggeringMessageMessageKey()
          Gets the value of 'triggeringMessageMessageKey' Field Description A message's key for the message that triggered an alert.
<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' Field Description A message's sender id for the message that triggered an alert.
 long getTriggeringMessageMessageSno()
          Gets the value of 'triggeringMessageMessageSno' Field Description A message's sequence number for the message that triggered an alert.
 short getTriggeringMessageMessageViewId()
          Gets the value of 'triggeringMessageMessageViewId' Field Description A message's sender id for the message that triggered an alert.
 boolean hasTriggeringMessageMessageBusName()
          Checks for the presence of 'triggeringMessageMessageBusName' Field Description The bus name for the message that triggered an alert.
 boolean hasTriggeringMessageMessageChannelId()
          Checks for the presence of 'triggeringMessageMessageChannelId' Field Description The id of the message channel for the message that triggered an alert.
 boolean hasTriggeringMessageMessageChannelName()
          Checks for the presence of 'triggeringMessageMessageChannelName' Field Description The name of the message channel for the message that triggered an alert.
 boolean hasTriggeringMessageMessageEncodingType()
          Checks for the presence of 'triggeringMessageMessageEncodingType' Field Description A message's encoding type for the message that triggered an alert.
 boolean hasTriggeringMessageMessageFactoryId()
          Checks for the presence of 'triggeringMessageMessageFactoryId' Field Description A message's sender id for the message that triggered an alert.
 boolean hasTriggeringMessageMessageFlowId()
          Checks for the presence of 'triggeringMessageMessageFlowId' Field Description A message's flow id for the message that triggered an alert.
 boolean hasTriggeringMessageMessageKey()
          Checks for the presence of 'triggeringMessageMessageKey' Field Description A message's key for the message that triggered an alert.
 boolean hasTriggeringMessageMessageSenderId()
          Checks for the presence of 'triggeringMessageMessageSenderId' Field Description A message's sender id for the message that triggered an alert.
 boolean hasTriggeringMessageMessageSno()
          Checks for the presence of 'triggeringMessageMessageSno' Field Description A message's sequence number for the message that triggered an alert.
 boolean hasTriggeringMessageMessageViewId()
          Checks for the presence of 'triggeringMessageMessageViewId' Field Description A message's sender id for the message that triggered an alert.
 void lendTriggeringMessageMessageBusName(XString val)
          Sets the value of 'triggeringMessageMessageBusName' Field Description The bus name for the message that triggered an alert.
 void lendTriggeringMessageMessageChannelId(XString val)
          Sets the value of 'triggeringMessageMessageChannelId' Field Description The id of the message channel for the message that triggered an alert.
 void lendTriggeringMessageMessageChannelName(XString val)
          Sets the value of 'triggeringMessageMessageChannelName' Field Description The name of the message channel for the message that triggered an alert.
 void lendTriggeringMessageMessageKey(XString val)
          Sets the value of 'triggeringMessageMessageKey' Field Description A message's key for the message that triggered an alert.
 void setTriggeringMessageMessageBusName(String val)
          Sets the value of 'triggeringMessageMessageBusName' Field Description The bus name for the message that triggered an alert.
 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' Field Description The id of the message channel for the message that triggered an alert.
 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' Field Description The name of the message channel for the message that triggered an alert.
 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' Field Description A message's encoding type for the message that triggered an alert.
 void setTriggeringMessageMessageFactoryId(short val)
          Sets the value of 'triggeringMessageMessageFactoryId' Field Description A message's sender id for the message that triggered an alert.
 void setTriggeringMessageMessageFlowId(int val)
          Sets the value of 'triggeringMessageMessageFlowId' Field Description A message's flow id for the message that triggered an alert.
 void setTriggeringMessageMessageKey(String val)
          Sets the value of 'triggeringMessageMessageKey' Field Description A message's key for the message that triggered an alert.
 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' Field Description A message's sender id for the message that triggered an alert.
 void setTriggeringMessageMessageSno(long val)
          Sets the value of 'triggeringMessageMessageSno' Field Description A message's sequence number for the message that triggered an alert.
 void setTriggeringMessageMessageViewId(short val)
          Sets the value of 'triggeringMessageMessageViewId' Field Description A message's sender id for the message that triggered an alert.
 
Methods inherited from interface com.neeve.rog.IRogValidatable
getValidationErrors, isValid
 

Method Detail

setTriggeringMessageMessageSno

void setTriggeringMessageMessageSno(long val)
Sets the value of 'triggeringMessageMessageSno'

Field Description

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

See Also:
getTriggeringMessageMessageEncodingType()

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.

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.

Returns:
The bus name for the message that triggered an alert.

lendTriggeringMessageMessageBusName

void lendTriggeringMessageMessageBusName(XString 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.

Parameters:
val - The value to set.

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.


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;

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.


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.

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.

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.

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.

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.

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.

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

lendTriggeringMessageMessageChannelName

void lendTriggeringMessageMessageChannelName(XString val)
Sets the value of 'triggeringMessageMessageChannelName'

Field Description

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

Parameters:
val - The value to set.

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.


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;

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.


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.

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.

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.

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.

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.

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.

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

lendTriggeringMessageMessageChannelId

void lendTriggeringMessageMessageChannelId(XString val)
Sets the value of 'triggeringMessageMessageChannelId'

Field Description

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

Parameters:
val - The value to set.

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.


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;

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.


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.

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.

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.

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.

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.

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.

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

lendTriggeringMessageMessageKey

void lendTriggeringMessageMessageKey(XString val)
Sets the value of 'triggeringMessageMessageKey'

Field Description

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

Parameters:
val - The value to set.

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.


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;

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.


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.

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.

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.

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.

See Also:
getTriggeringMessageMessageKey()


Copyright © 2016 Neeve Research, LLC. All Rights Reserved.