ISrvMonHeartbeatMessage (Talon 3.14.19 API)

All Superinterfaces:: CopyableMessageView<ISrvMonHeartbeatMessage>, com.neeve.server.mon.common.IHasSrvMonXvmHeader, IRogCopyableNode<ISrvMonHeartbeatMessage>, IRogMessage, IRogMetadata, IRogNode, IRogValidatable, IStoreObject, IStoreObjectMetadata, MapMessageView, MessageView, UtlReferenceTracker.HasReferenceTracker

All Known Implementing Classes:: SrvMonHeartbeatMessage

@Generated(value="com.neeve.adm.AdmGenerator",
           date="Thu May 07 15:37:32 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 ISrvMonHeartbeatMessage
extends IRogNode, IRogMessage, IRogCopyableNode<ISrvMonHeartbeatMessage>, com.neeve.server.mon.common.IHasSrvMonXvmHeader

Talon XVM Heartbeat.

The XVM heartbeat is emitted by a Talon XVM at regular intervals and contains all of the stats reported by a XVM.

ADM Details

ADM Type	Message
Factory	SrvMonFactory

ADM Field Summary

Field	Type	Id	Description
adminClientStats	SrvMonAdminClientStats[]	11	Collects stats related to the admin client connections.
appsInfo	SrvMonAppInfo[]	9	Information about the apps configured for this XVM.
appsStats	SrvMonAppStats[]	10	Platform and user stats for loaded applications.
collectionEndTime	Long	3	The collection end time in nanoseconds (e.g. System.nanoTime()).
collectionStartTime	Long	2	The collection start time in nanoseconds (e.g. System.nanoTime()).
collectionStartWallTime	Long	1	The collection start time in milliseconds since the Epoch (e.g. System.currentTimeMillis()).
heartbeatLoggerStats	`SrvMonAppMessageLoggerStats`	15	Logger stats for the xvm's binary heartbeat log (if enabled).
loadedTime	Date	12	The time at which the XVM loaded.
poolStats	SrvMonPoolStats[]	8	Collects process wide pooling stats.
serverHostName	String	5	The XVM's hostname.
serverName	String	4	The name of the XVM.
serverPid	String	6	The XVM process id.
sysStats	`SrvMonSysStats`	7	Collects System System level stats such process or memory usage.
systemName	String	13	The name of the system to which the XVM belongs.
systemVersion	String	14	The version of the system to which the XVM belongs.
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`	`addAdminClientStats(SrvMonAdminClientStats val)` Adds the provided value to the list of 'adminClientStats' values.
`void`	`addAppsInfo(SrvMonAppInfo val)` Adds the provided value to the list of 'appsInfo' values.
`void`	`addAppsStats(SrvMonAppStats val)` Adds the provided value to the list of 'appsStats' values.
`void`	`addPoolStats(SrvMonPoolStats val)` Adds the provided value to the list of 'poolStats' values.
`void`	`clearAdminClientStats()` Clears the value of 'adminClientStats'.
`void`	`clearAppsInfo()` Clears the value of 'appsInfo'.
`void`	`clearAppsStats()` Clears the value of 'appsStats'.
`void`	`clearCollectionEndTime()` Clears the value of 'collectionEndTime'.
`void`	`clearCollectionStartTime()` Clears the value of 'collectionStartTime'.
`void`	`clearCollectionStartWallTime()` Clears the value of 'collectionStartWallTime'.
`void`	`clearHeartbeatLoggerStats()` Clears the value of 'heartbeatLoggerStats'.
`void`	`clearLoadedTime()` Clears the value of 'loadedTime'.
`void`	`clearPoolStats()` Clears the value of 'poolStats'.
`void`	`clearServerHostName()` Clears the value of 'serverHostName'.
`void`	`clearServerName()` Clears the value of 'serverName'.
`void`	`clearServerPid()` Clears the value of 'serverPid'.
`void`	`clearSysStats()` Clears the value of 'sysStats'.
`void`	`clearSystemName()` Clears the value of 'systemName'.
`void`	`clearSystemVersion()` Clears the value of 'systemVersion'.
`void`	`clearXvmHeader()` Clears the value of 'xvmHeader'.
`SrvMonHeartbeatMessage`	`copy()` Creates a copy of this SrvMonHeartbeatMessage.
`void`	`copyInto(SrvMonHeartbeatMessage target)` Copies the contents of this SrvMonHeartbeatMessage into the target.
`SrvMonAdminClientStats[]`	`getAdminClientStats()` Gets the value of 'adminClientStats'.
`SrvMonAdminClientStats[]`	`getAdminClientStatsEmptyIfNull()` Gets the value of 'adminClientStats' or an empty array if the value is `null` or not set.
`XIterator<SrvMonAdminClientStats>`	`getAdminClientStatsIterator()` Gets the value of 'adminClientStats' as iterator of values.
`SrvMonAppInfo[]`	`getAppsInfo()` Gets the value of 'appsInfo'.
`SrvMonAppInfo[]`	`getAppsInfoEmptyIfNull()` Gets the value of 'appsInfo' or an empty array if the value is `null` or not set.
`XIterator<SrvMonAppInfo>`	`getAppsInfoIterator()` Gets the value of 'appsInfo' as iterator of values.
`SrvMonAppStats[]`	`getAppsStats()` Gets the value of 'appsStats'.
`SrvMonAppStats[]`	`getAppsStatsEmptyIfNull()` Gets the value of 'appsStats' or an empty array if the value is `null` or not set.
`XIterator<SrvMonAppStats>`	`getAppsStatsIterator()` Gets the value of 'appsStats' as iterator of values.
`long`	`getCollectionEndTime()` Gets the value of 'collectionEndTime'.
`long`	`getCollectionStartTime()` Gets the value of 'collectionStartTime'.
`long`	`getCollectionStartWallTime()` Gets the value of 'collectionStartWallTime'.
`SrvMonAppMessageLoggerStats`	`getHeartbeatLoggerStats()` Gets the value of 'heartbeatLoggerStats'.
`void`	`getHeartbeatLoggerStatsTo(SrvMonAppMessageLoggerStats val)` Copies the value of SrvMonAppMessageLoggerStats into the provided value.
`Date`	`getLoadedTime()` Gets the value of 'loadedTime'.
`long`	`getLoadedTimeAsTimestamp()` Retrieves the date as a timestamp (a zero garbage operation for XBuf encoding).
`SrvMonPoolStats[]`	`getPoolStats()` Gets the value of 'poolStats'.
`SrvMonPoolStats[]`	`getPoolStatsEmptyIfNull()` Gets the value of 'poolStats' or an empty array if the value is `null` or not set.
`XIterator<SrvMonPoolStats>`	`getPoolStatsIterator()` Gets the value of 'poolStats' as iterator of values.
`String`	`getServerHostName()` Gets the value of 'serverHostName'.
`<T extends XString> T`	`getServerHostNameTo(XString.Factory<T> factory)` Copies the value of this String field into a new XString from the given factory.
`void`	`getServerHostNameTo(XString val)` Copies the value of 'serverHostName' into the provided XString.
`XString`	`getServerHostNameUnsafe()` Gets the raw value of 'serverHostName'.
`String`	`getServerName()` Gets the value of 'serverName'.
`<T extends XString> T`	`getServerNameTo(XString.Factory<T> factory)` Copies the value of this String field into a new XString from the given factory.
`void`	`getServerNameTo(XString val)` Copies the value of 'serverName' into the provided XString.
`XString`	`getServerNameUnsafe()` Gets the raw value of 'serverName'.
`String`	`getServerPid()` Gets the value of 'serverPid'.
`<T extends XString> T`	`getServerPidTo(XString.Factory<T> factory)` Copies the value of this String field into a new XString from the given factory.
`void`	`getServerPidTo(XString val)` Copies the value of 'serverPid' into the provided XString.
`XString`	`getServerPidUnsafe()` Gets the raw value of 'serverPid'.
`SrvMonSysStats`	`getSysStats()` Gets the value of 'sysStats'.
`void`	`getSysStatsTo(SrvMonSysStats val)` Copies the value of SrvMonSysStats into the provided value.
`String`	`getSystemName()` Gets the value of 'systemName'.
`<T extends XString> T`	`getSystemNameTo(XString.Factory<T> factory)` Copies the value of this String field into a new XString from the given factory.
`void`	`getSystemNameTo(XString val)` Copies the value of 'systemName' into the provided XString.
`XString`	`getSystemNameUnsafe()` Gets the raw value of 'systemName'.
`String`	`getSystemVersion()` Gets the value of 'systemVersion'.
`<T extends XString> T`	`getSystemVersionTo(XString.Factory<T> factory)` Copies the value of this String field into a new XString from the given factory.
`void`	`getSystemVersionTo(XString val)` Copies the value of 'systemVersion' into the provided XString.
`XString`	`getSystemVersionUnsafe()` Gets the raw value of 'systemVersion'.
`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`	`hasCollectionEndTime()` Checks for the presence of 'collectionEndTime'.
`boolean`	`hasCollectionStartTime()` Checks for the presence of 'collectionStartTime'.
`boolean`	`hasCollectionStartWallTime()` Checks for the presence of 'collectionStartWallTime'.
`boolean`	`hasHeartbeatLoggerStats()` Checks for the presence of 'heartbeatLoggerStats'.
`boolean`	`hasLoadedTime()` Checks for the presence of 'loadedTime'.
`boolean`	`hasServerHostName()` Checks for the presence of 'serverHostName'.
`boolean`	`hasServerName()` Checks for the presence of 'serverName'.
`boolean`	`hasServerPid()` Checks for the presence of 'serverPid'.
`boolean`	`hasSysStats()` Checks for the presence of 'sysStats'.
`boolean`	`hasSystemName()` Checks for the presence of 'systemName'.
`boolean`	`hasSystemVersion()` Checks for the presence of 'systemVersion'.
`boolean`	`hasXvmHeader()` Checks for the presence of 'xvmHeader'.
`void`	`lendAdminClientStats(SrvMonAdminClientStats val)` Adds the provided value to the list of 'adminClientStats' values and acquires a reference to it.
`void`	`lendAdminClientStats(SrvMonAdminClientStats[] val)` Lends the value of 'adminClientStats'.
`void`	`lendAdminClientStatsFrom(XIterator<SrvMonAdminClientStats> val)` Sets the value of 'adminClientStats' by lending the values from the provided iterator.
`void`	`lendAppsInfo(SrvMonAppInfo val)` Adds the provided value to the list of 'appsInfo' values and acquires a reference to it.
`void`	`lendAppsInfo(SrvMonAppInfo[] val)` Lends the value of 'appsInfo'.
`void`	`lendAppsInfoFrom(XIterator<SrvMonAppInfo> val)` Sets the value of 'appsInfo' by lending the values from the provided iterator.
`void`	`lendAppsStats(SrvMonAppStats val)` Adds the provided value to the list of 'appsStats' values and acquires a reference to it.
`void`	`lendAppsStats(SrvMonAppStats[] val)` Lends the value of 'appsStats'.
`void`	`lendAppsStatsFrom(XIterator<SrvMonAppStats> val)` Sets the value of 'appsStats' by lending the values from the provided iterator.
`void`	`lendHeartbeatLoggerStats(SrvMonAppMessageLoggerStats val)` 'Lends' a reference of the SrvMonAppMessageLoggerStats to the message for this field.
`void`	`lendPoolStats(SrvMonPoolStats val)` Adds the provided value to the list of 'poolStats' values and acquires a reference to it.
`void`	`lendPoolStats(SrvMonPoolStats[] val)` Lends the value of 'poolStats'.
`void`	`lendPoolStatsFrom(XIterator<SrvMonPoolStats> val)` Sets the value of 'poolStats' by lending the values from the provided iterator.
`void`	`lendServerHostName(XString val)` Lends the value of 'serverHostName' to this object.
`void`	`lendServerName(XString val)` Lends the value of 'serverName' to this object.
`void`	`lendServerPid(XString val)` Lends the value of 'serverPid' to this object.
`void`	`lendSysStats(SrvMonSysStats val)` 'Lends' a reference of the SrvMonSysStats to the message for this field.
`void`	`lendSystemName(XString val)` Lends the value of 'systemName' to this object.
`void`	`lendSystemVersion(XString val)` Lends the value of 'systemVersion' 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`	`setAdminClientStats(SrvMonAdminClientStats[] val)` Sets the value of 'adminClientStats'.
`void`	`setAdminClientStatsFrom(XIterator<SrvMonAdminClientStats> val)` Sets the value of 'adminClientStats' using the values from the provided iterator.
`void`	`setAppsInfo(SrvMonAppInfo[] val)` Sets the value of 'appsInfo'.
`void`	`setAppsInfoFrom(XIterator<SrvMonAppInfo> val)` Sets the value of 'appsInfo' using the values from the provided iterator.
`void`	`setAppsStats(SrvMonAppStats[] val)` Sets the value of 'appsStats'.
`void`	`setAppsStatsFrom(XIterator<SrvMonAppStats> val)` Sets the value of 'appsStats' using the values from the provided iterator.
`void`	`setCollectionEndTime(long val)` Sets the value of 'collectionEndTime'.
`void`	`setCollectionStartTime(long val)` Sets the value of 'collectionStartTime'.
`void`	`setCollectionStartWallTime(long val)` Sets the value of 'collectionStartWallTime'.
`void`	`setHeartbeatLoggerStats(SrvMonAppMessageLoggerStats val)` Sets the value of 'heartbeatLoggerStats'.
`void`	`setLoadedTime(Date val)` Sets the value of 'loadedTime'.
`void`	`setLoadedTimeAsTimestamp(long val)` Sets the date value as a timestamp.
`void`	`setPoolStats(SrvMonPoolStats[] val)` Sets the value of 'poolStats'.
`void`	`setPoolStatsFrom(XIterator<SrvMonPoolStats> val)` Sets the value of 'poolStats' using the values from the provided iterator.
`void`	`setServerHostName(String val)` Sets the value of 'serverHostName'.
`void`	`setServerHostNameFrom(long val)` Sets the value of this String field to the given numeric value.
`void`	`setServerHostNameFrom(XString val)` Copies the provided XString value into this object's 'serverHostName'.
`void`	`setServerName(String val)` Sets the value of 'serverName'.
`void`	`setServerNameFrom(long val)` Sets the value of this String field to the given numeric value.
`void`	`setServerNameFrom(XString val)` Copies the provided XString value into this object's 'serverName'.
`void`	`setServerPid(String val)` Sets the value of 'serverPid'.
`void`	`setServerPidFrom(long val)` Sets the value of this String field to the given numeric value.
`void`	`setServerPidFrom(XString val)` Copies the provided XString value into this object's 'serverPid'.
`void`	`setSysStats(SrvMonSysStats val)` Sets the value of 'sysStats'.
`void`	`setSystemName(String val)` Sets the value of 'systemName'.
`void`	`setSystemNameFrom(long val)` Sets the value of this String field to the given numeric value.
`void`	`setSystemNameFrom(XString val)` Copies the provided XString value into this object's 'systemName'.
`void`	`setSystemVersion(String val)` Sets the value of 'systemVersion'.
`void`	`setSystemVersionFrom(long val)` Sets the value of this String field to the given numeric value.
`void`	`setSystemVersionFrom(XString val)` Copies the provided XString value into this object's 'systemVersion'.
`void`	`setXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)` Sets the value of 'xvmHeader'.
`SrvMonAdminClientStats[]`	`takeAdminClientStats()` Takes the value of 'adminClientStats'.
`SrvMonAppInfo[]`	`takeAppsInfo()` Takes the value of 'appsInfo'.
`SrvMonAppStats[]`	`takeAppsStats()` Takes the value of 'appsStats'.
`SrvMonAppMessageLoggerStats`	`takeHeartbeatLoggerStats()` 'Takes' a reference to the heartbeatLoggerStats field from the message.
`SrvMonPoolStats[]`	`takePoolStats()` Takes the value of 'poolStats'.
`SrvMonSysStats`	`takeSysStats()` 'Takes' a reference to the sysStats field from the message.
`com.neeve.server.mon.common.SrvMonXvmHeader`	`takeXvmHeader()` 'Takes' a reference to the xvmHeader field from the message.

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.IRogValidatable
getValidationErrors, isValid

- Method Detail
  - setCollectionStartWallTime
```
void setCollectionStartWallTime(long val)
```
    Sets the value of 'collectionStartWallTime'.
    Field Description
    The collection start time in milliseconds since the Epoch (e.g. System.currentTimeMillis()).
    
    Parameters:
    val - The value to set.
  - getCollectionStartWallTime
```
long getCollectionStartWallTime()
```
    Gets the value of 'collectionStartWallTime'.
    Field Description
    The collection start time in milliseconds since the Epoch (e.g. System.currentTimeMillis()).
    
    Returns:
    The collection start time in milliseconds since the Epoch (e.g. System.currentTimeMillis()).
  - clearCollectionStartWallTime
```
void clearCollectionStartWallTime()
```
    Clears the value of 'collectionStartWallTime'.
    Field Description
    The collection start time in milliseconds since the Epoch (e.g. System.currentTimeMillis()).
    
    See Also:
    setCollectionStartWallTime(long)
  - hasCollectionStartWallTime
```
boolean hasCollectionStartWallTime()
```
    Checks for the presence of 'collectionStartWallTime'.
    Field Description
    The collection start time in milliseconds since the Epoch (e.g. System.currentTimeMillis()).
    
    See Also:
    getCollectionStartWallTime()
  - setCollectionStartTime
```
void setCollectionStartTime(long val)
```
    Sets the value of 'collectionStartTime'.
    Field Description
    The collection start time in nanoseconds (e.g. System.nanoTime()).
    
    Parameters:
    val - The value to set.
  - getCollectionStartTime
```
long getCollectionStartTime()
```
    Gets the value of 'collectionStartTime'.
    Field Description
    The collection start time in nanoseconds (e.g. System.nanoTime()).
    
    Returns:
    The collection start time in nanoseconds (e.g. System.nanoTime()).
  - clearCollectionStartTime
```
void clearCollectionStartTime()
```
    Clears the value of 'collectionStartTime'.
    Field Description
    The collection start time in nanoseconds (e.g. System.nanoTime()).
    
    See Also:
    setCollectionStartTime(long)
  - hasCollectionStartTime
```
boolean hasCollectionStartTime()
```
    Checks for the presence of 'collectionStartTime'.
    Field Description
    The collection start time in nanoseconds (e.g. System.nanoTime()).
    
    See Also:
    getCollectionStartTime()
  - setCollectionEndTime
```
void setCollectionEndTime(long val)
```
    Sets the value of 'collectionEndTime'.
    Field Description
    The collection end time in nanoseconds (e.g. System.nanoTime()).
    
    Parameters:
    val - The value to set.
  - getCollectionEndTime
```
long getCollectionEndTime()
```
    Gets the value of 'collectionEndTime'.
    Field Description
    The collection end time in nanoseconds (e.g. System.nanoTime()).
    
    Returns:
    The collection end time in nanoseconds (e.g. System.nanoTime()).
  - clearCollectionEndTime
```
void clearCollectionEndTime()
```
    Clears the value of 'collectionEndTime'.
    Field Description
    The collection end time in nanoseconds (e.g. System.nanoTime()).
    
    See Also:
    setCollectionEndTime(long)
  - hasCollectionEndTime
```
boolean hasCollectionEndTime()
```
    Checks for the presence of 'collectionEndTime'.
    Field Description
    The collection end time in nanoseconds (e.g. System.nanoTime()).
    
    See Also:
    getCollectionEndTime()
  - setLoadedTime
```
void setLoadedTime(Date val)
```
    Sets the value of 'loadedTime'.
    Field Description
    The time at which the XVM loaded.
    
    Parameters:
    val - The value to set.
  - getLoadedTime
```
Date getLoadedTime()
```
    Gets the value of 'loadedTime'.
    Field Description
    The time at which the XVM loaded.
    
    Returns:
    The time at which the XVM loaded.
  - setLoadedTimeAsTimestamp
```
void setLoadedTimeAsTimestamp(long val)
```
    Sets the date value as a timestamp.
    Field Description
    The time at which the XVM loaded.
    
    Parameters:
    val - The date value in milliseconds from the epoch
  - getLoadedTimeAsTimestamp
```
long getLoadedTimeAsTimestamp()
```
    Retrieves the date as a timestamp (a zero garbage operation for XBuf encoding).
    Field Description
    The time at which the XVM loaded.
    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, hasLoadedTime() should be called.
    
    Returns:
    The data as a timestamp in milliseconds from the epoch or -1 if null or not set
  - clearLoadedTime
```
void clearLoadedTime()
```
    Clears the value of 'loadedTime'.
    Field Description
    The time at which the XVM loaded.
    
    See Also:
    setLoadedTime(Date)
  - hasLoadedTime
```
boolean hasLoadedTime()
```
    Checks for the presence of 'loadedTime'.
    Field Description
    The time at which the XVM loaded.
    
    See Also:
    getLoadedTime()
  - 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
    
    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
    
    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
    
    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
    
    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
    
    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
    
    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
    
    See Also:
    setXvmHeader(SrvMonXvmHeader)
  - setServerName
```
void setServerName(String val)
```
    Sets the value of 'serverName'.
    Field Description
    The name of the XVM.
    
    Parameters:
    val - The value to set.
  - getServerName
```
String getServerName()
```
    Gets the value of 'serverName'.
    Field Description
    The name of the XVM.
    
    Returns:
    The name of the XVM.
  - lendServerName
```
void lendServerName(XString val)
```
    Lends the value of 'serverName' to this object.
    This method is equivalent to setServerName 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 XVM.
    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.
    
    Parameters:
    val - The value to set.
    
    Throws:
    
    IllegalArgumentException - If the value is mutable.
  - setServerNameFrom
```
void setServerNameFrom(long val)
```
    Sets the value of this String field to the given numeric value.
    Field Description
    The name of the XVM.
    NOTE:
    This is the same as calling setServerName(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.
  - getServerNameTo
```
<T extends XString> T getServerNameTo(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 XVM.
    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
  - setServerNameFrom
```
void setServerNameFrom(XString val)
```
    Copies the provided XString value into this object's 'serverName'.
    Field Description
    The name of the XVM.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than setServerName(String) because it avoids encoding the value into a String if the given XString is already encoded.
  - getServerNameTo
```
void getServerNameTo(XString val)
```
    Copies the value of 'serverName' into the provided XString.
    Field Description
    The name of the XVM.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than getServerName() bec because it can avoid decoding the value into an String.
    
    See Also:
    getServerName()
  - getServerNameUnsafe
```
XString getServerNameUnsafe()
```
    Gets the raw value of 'serverName'.
    Field Description
    The name of the XVM.
    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:
    getServerName()
  - clearServerName
```
void clearServerName()
```
    Clears the value of 'serverName'.
    Field Description
    The name of the XVM.
    
    See Also:
    setServerName(String)
  - hasServerName
```
boolean hasServerName()
```
    Checks for the presence of 'serverName'.
    Field Description
    The name of the XVM.
    
    See Also:
    getServerName()
  - setServerHostName
```
void setServerHostName(String val)
```
    Sets the value of 'serverHostName'.
    Field Description
    The XVM's hostname.
    
    Parameters:
    val - The value to set.
  - getServerHostName
```
String getServerHostName()
```
    Gets the value of 'serverHostName'.
    Field Description
    The XVM's hostname.
    
    Returns:
    The XVM's hostname.
  - lendServerHostName
```
void lendServerHostName(XString val)
```
    Lends the value of 'serverHostName' to this object.
    This method is equivalent to setServerHostName 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 XVM's hostname.
    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.
    
    Parameters:
    val - The value to set.
    
    Throws:
    
    IllegalArgumentException - If the value is mutable.
  - setServerHostNameFrom
```
void setServerHostNameFrom(long val)
```
    Sets the value of this String field to the given numeric value.
    Field Description
    The XVM's hostname.
    NOTE:
    This is the same as calling setServerHostName(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.
  - getServerHostNameTo
```
<T extends XString> T getServerHostNameTo(XString.Factory<T> factory)
```
    Copies the value of this String field into a new XString from the given factory.
    Field Description
    The XVM's hostname.
    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
  - setServerHostNameFrom
```
void setServerHostNameFrom(XString val)
```
    Copies the provided XString value into this object's 'serverHostName'.
    Field Description
    The XVM's hostname.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than setServerHostName(String) because it avoids encoding the value into a String if the given XString is already encoded.
  - getServerHostNameTo
```
void getServerHostNameTo(XString val)
```
    Copies the value of 'serverHostName' into the provided XString.
    Field Description
    The XVM's hostname.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than getServerHostName() bec because it can avoid decoding the value into an String.
    
    See Also:
    getServerHostName()
  - getServerHostNameUnsafe
```
XString getServerHostNameUnsafe()
```
    Gets the raw value of 'serverHostName'.
    Field Description
    The XVM's hostname.
    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:
    getServerHostName()
  - clearServerHostName
```
void clearServerHostName()
```
    Clears the value of 'serverHostName'.
    Field Description
    The XVM's hostname.
    
    See Also:
    setServerHostName(String)
  - hasServerHostName
```
boolean hasServerHostName()
```
    Checks for the presence of 'serverHostName'.
    Field Description
    The XVM's hostname.
    
    See Also:
    getServerHostName()
  - setServerPid
```
void setServerPid(String val)
```
    Sets the value of 'serverPid'.
    Field Description
    The XVM process id.
    
    Parameters:
    val - The value to set.
  - getServerPid
```
String getServerPid()
```
    Gets the value of 'serverPid'.
    Field Description
    The XVM process id.
    
    Returns:
    The XVM process id.
  - lendServerPid
```
void lendServerPid(XString val)
```
    Lends the value of 'serverPid' to this object.
    This method is equivalent to setServerPid 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 XVM process id.
    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.
    
    Parameters:
    val - The value to set.
    
    Throws:
    
    IllegalArgumentException - If the value is mutable.
  - setServerPidFrom
```
void setServerPidFrom(long val)
```
    Sets the value of this String field to the given numeric value.
    Field Description
    The XVM process id.
    NOTE:
    This is the same as calling setServerPid(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.
  - getServerPidTo
```
<T extends XString> T getServerPidTo(XString.Factory<T> factory)
```
    Copies the value of this String field into a new XString from the given factory.
    Field Description
    The XVM process id.
    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
  - setServerPidFrom
```
void setServerPidFrom(XString val)
```
    Copies the provided XString value into this object's 'serverPid'.
    Field Description
    The XVM process id.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than setServerPid(String) because it avoids encoding the value into a String if the given XString is already encoded.
  - getServerPidTo
```
void getServerPidTo(XString val)
```
    Copies the value of 'serverPid' into the provided XString.
    Field Description
    The XVM process id.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than getServerPid() bec because it can avoid decoding the value into an String.
    
    See Also:
    getServerPid()
  - getServerPidUnsafe
```
XString getServerPidUnsafe()
```
    Gets the raw value of 'serverPid'.
    Field Description
    The XVM process id.
    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:
    getServerPid()
  - clearServerPid
```
void clearServerPid()
```
    Clears the value of 'serverPid'.
    Field Description
    The XVM process id.
    
    See Also:
    setServerPid(String)
  - hasServerPid
```
boolean hasServerPid()
```
    Checks for the presence of 'serverPid'.
    Field Description
    The XVM process id.
    
    See Also:
    getServerPid()
  - setSysStats
```
void setSysStats(SrvMonSysStats val)
```
    Sets the value of 'sysStats'.
    Field Description
    Collects System System level stats such process or memory usage.
    
    Parameters:
    val - The value to set.
  - lendSysStats
```
void lendSysStats(SrvMonSysStats val)
```
    'Lends' a reference of the SrvMonSysStats to the message for this field.
    Field Description
    Collects System System level stats such process or memory usage.
    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.
    
    Parameters:
    val - the value to 'lend' to lend.
  - getSysStats
```
SrvMonSysStats getSysStats()
```
    Gets the value of 'sysStats'.
    Field Description
    Collects System System level stats such process or memory usage.
    
    Returns:
    Collects System System level stats such process or memory usage.
  - getSysStatsTo
```
void getSysStatsTo(SrvMonSysStats val)
```
    Copies the value of SrvMonSysStats into the provided value.
    IF the value is not set, then the contents of the provided SrvMonSysStats are cleared.
    
    Parameters:
    val - the value to copy into
    See Also:
    SrvMonSysStats.copyInto(SrvMonSysStats)
  - takeSysStats
```
SrvMonSysStats takeSysStats()
```
    'Takes' a reference to the sysStats field from the message.
    Field Description
    Collects System System level stats such process or memory usage.
    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.
    
    Returns:
    a 'taken' reference to the field or null if the field is not set.
  - hasSysStats
```
boolean hasSysStats()
```
    Checks for the presence of 'sysStats'.
    Field Description
    Collects System System level stats such process or memory usage.
    
    See Also:
    getSysStats()
  - clearSysStats
```
void clearSysStats()
```
    Clears the value of 'sysStats'.
    Field Description
    Collects System System level stats such process or memory usage.
    
    See Also:
    setSysStats(SrvMonSysStats)
  - setPoolStats
```
void setPoolStats(SrvMonPoolStats[] val)
```
    Sets the value of 'poolStats'.
    Field Description
    Collects process wide pooling stats.
    
    Parameters:
    val - The value to set.
  - setPoolStatsFrom
```
void setPoolStatsFrom(XIterator<SrvMonPoolStats> val)
```
    Sets the value of 'poolStats' using the values from the provided iterator.
    This method will call XIterator.toFirst() before and after setting the values, meaning that all values from the iterator will be set and the iterator will be reset on return.
    
    This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'poolStats' accessor can copy the values without iteration.
    
    Field Description
    Collects process wide pooling stats.
    NOTE:
    Passing a null or empty list has the same affect as calling setPoolStats(SrvMonPoolStats[]) with a value of null.
    
    Parameters:
    val - the values to set.
  - lendPoolStatsFrom
```
void lendPoolStatsFrom(XIterator<SrvMonPoolStats> val)
```
    Sets the value of 'poolStats' by lending the values from the provided iterator.
    This method will call XIterator.toFirst() before and after setting the values, meaning that all values from the iterator will be set and the iterator will be reset on return.
    
    This method will acquire references to each non null value in the provided iterator making it suitable for cases where the values come from another message that may be disposed.
    
    This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'poolStats' accessor can copy the values without iteration.
    
    Field Description
    Collects process wide pooling stats.
    NOTE:
    Passing a null or empty list has the same affect as calling setPoolStats(SrvMonPoolStats[]) with a value of null.
    
    Parameters:
    val - the values to set.
  - addPoolStats
```
void addPoolStats(SrvMonPoolStats val)
```
    Adds the provided value to the list of 'poolStats' values.
    This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'poolStats' accessor can copy the values without iteration.
    
    For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.
    
    Field Description
    Collects process wide pooling stats.
    
    Parameters:
    val - the value to add.
  - lendPoolStats
```
void lendPoolStats(SrvMonPoolStats val)
```
    Adds the provided value to the list of 'poolStats' values and acquires a reference to it.
    Lending of an added value is useful in cases where a field is being added from a source message to provide dispose of the source value when the source message is disposed.
    
    This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'poolStats' accessor can copy the values without iteration.
    
    For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.
    
    Field Description
    Collects process wide pooling stats.
    
    Parameters:
    val - the value to add.
  - getPoolStatsIterator
```
XIterator<SrvMonPoolStats> getPoolStatsIterator()
```
    Gets the value of 'poolStats' as iterator of values.
    This method will always return a non null iterator value. The returned iterator is not threadsafe, and the caller may not hold on to it beyond the pooling lifespan of this object. Depending on the implementation, the same iterator instance may be returned by this object on each call to avoid garbage. Each time this method is called the iterator is reset by calling its toFirst() method. Callers should therefore be especially careful about calling this method while iterating on the iterator returned by this method.
    
    The elements returned by this iterator are owned by and pooled along with this object. The caller must call acquire() on each returned object that it intends to keep beyond the either the next call to next(), toFirst() or the lifespace of this object as each object returned by this iterator is disposed on a subsequent call to next() or when this object is disposed.
    
    This method is zero garbage for Xbuf generated classes, and this method is optimized such that passing the returned iterator to another object's setXXX(XIterator method can perform a direct copy of the underlying values without iteration.
    
    Field Description
    Collects process wide pooling stats.
    
    Returns:
    An iterator containing this field values.
  - lendPoolStats
```
void lendPoolStats(SrvMonPoolStats[] val)
```
    Lends the value of 'poolStats'.
    Field Description
    Collects process wide pooling stats.
    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.
    
    Parameters:
    val - the value to 'lend' to lend.
  - getPoolStats
```
SrvMonPoolStats[] getPoolStats()
```
    Gets the value of 'poolStats'.
    If the field is not set this method will return null.
    Field Description
    Collects process wide pooling stats.
    
    Returns:
    Collects process wide pooling stats. If the field is not set this method will return null.
  - getPoolStatsEmptyIfNull
```
SrvMonPoolStats[] getPoolStatsEmptyIfNull()
```
    Gets the value of 'poolStats' or an empty array if the value is null or not set.
    Field Description
    Collects process wide pooling stats.
    
    Returns:
    Collects process wide pooling stats. or an empty array if null if not set.
    See Also:
    getPoolStats()
  - takePoolStats
```
SrvMonPoolStats[] takePoolStats()
```
    Takes the value of 'poolStats'.
    Field Description
    Collects process wide pooling stats.
    NOTE:
    A nested entity reference returned by getPoolStats() 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.
    
    Returns:
    a 'taken' reference to the field or null if the field is not set.
  - clearPoolStats
```
void clearPoolStats()
```
    Clears the value of 'poolStats'.
    Field Description
    Collects process wide pooling stats.
    
    See Also:
    setPoolStats(SrvMonPoolStats[])
  - setAppsInfo
```
void setAppsInfo(SrvMonAppInfo[] val)
```
    Sets the value of 'appsInfo'.
    Field Description
    Information about the apps configured for this XVM.
    
    Parameters:
    val - The value to set.
  - setAppsInfoFrom
```
void setAppsInfoFrom(XIterator<SrvMonAppInfo> val)
```
    Sets the value of 'appsInfo' using the values from the provided iterator.
    This method will call XIterator.toFirst() before and after setting the values, meaning that all values from the iterator will be set and the iterator will be reset on return.
    
    This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'appsInfo' accessor can copy the values without iteration.
    
    Field Description
    Information about the apps configured for this XVM.
    NOTE:
    Passing a null or empty list has the same affect as calling setAppsInfo(SrvMonAppInfo[]) with a value of null.
    
    Parameters:
    val - the values to set.
  - lendAppsInfoFrom
```
void lendAppsInfoFrom(XIterator<SrvMonAppInfo> val)
```
    Sets the value of 'appsInfo' by lending the values from the provided iterator.
    This method will call XIterator.toFirst() before and after setting the values, meaning that all values from the iterator will be set and the iterator will be reset on return.
    
    This method will acquire references to each non null value in the provided iterator making it suitable for cases where the values come from another message that may be disposed.
    
    This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'appsInfo' accessor can copy the values without iteration.
    
    Field Description
    Information about the apps configured for this XVM.
    NOTE:
    Passing a null or empty list has the same affect as calling setAppsInfo(SrvMonAppInfo[]) with a value of null.
    
    Parameters:
    val - the values to set.
  - addAppsInfo
```
void addAppsInfo(SrvMonAppInfo val)
```
    Adds the provided value to the list of 'appsInfo' values.
    This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'appsInfo' accessor can copy the values without iteration.
    
    For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.
    
    Field Description
    Information about the apps configured for this XVM.
    
    Parameters:
    val - the value to add.
  - lendAppsInfo
```
void lendAppsInfo(SrvMonAppInfo val)
```
    Adds the provided value to the list of 'appsInfo' values and acquires a reference to it.
    Lending of an added value is useful in cases where a field is being added from a source message to provide dispose of the source value when the source message is disposed.
    
    This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'appsInfo' accessor can copy the values without iteration.
    
    For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.
    
    Field Description
    Information about the apps configured for this XVM.
    
    Parameters:
    val - the value to add.
  - getAppsInfoIterator
```
XIterator<SrvMonAppInfo> getAppsInfoIterator()
```
    Gets the value of 'appsInfo' as iterator of values.
    This method will always return a non null iterator value. The returned iterator is not threadsafe, and the caller may not hold on to it beyond the pooling lifespan of this object. Depending on the implementation, the same iterator instance may be returned by this object on each call to avoid garbage. Each time this method is called the iterator is reset by calling its toFirst() method. Callers should therefore be especially careful about calling this method while iterating on the iterator returned by this method.
    
    The elements returned by this iterator are owned by and pooled along with this object. The caller must call acquire() on each returned object that it intends to keep beyond the either the next call to next(), toFirst() or the lifespace of this object as each object returned by this iterator is disposed on a subsequent call to next() or when this object is disposed.
    
    This method is zero garbage for Xbuf generated classes, and this method is optimized such that passing the returned iterator to another object's setXXX(XIterator method can perform a direct copy of the underlying values without iteration.
    
    Field Description
    Information about the apps configured for this XVM.
    
    Returns:
    An iterator containing this field values.
  - lendAppsInfo
```
void lendAppsInfo(SrvMonAppInfo[] val)
```
    Lends the value of 'appsInfo'.
    Field Description
    Information about the apps configured for this XVM.
    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.
    
    Parameters:
    val - the value to 'lend' to lend.
  - getAppsInfo
```
SrvMonAppInfo[] getAppsInfo()
```
    Gets the value of 'appsInfo'.
    If the field is not set this method will return null.
    Field Description
    Information about the apps configured for this XVM.
    
    Returns:
    Information about the apps configured for this XVM. If the field is not set this method will return null.
  - getAppsInfoEmptyIfNull
```
SrvMonAppInfo[] getAppsInfoEmptyIfNull()
```
    Gets the value of 'appsInfo' or an empty array if the value is null or not set.
    Field Description
    Information about the apps configured for this XVM.
    
    Returns:
    Information about the apps configured for this XVM. or an empty array if null if not set.
    See Also:
    getAppsInfo()
  - takeAppsInfo
```
SrvMonAppInfo[] takeAppsInfo()
```
    Takes the value of 'appsInfo'.
    Field Description
    Information about the apps configured for this XVM.
    NOTE:
    A nested entity reference returned by getAppsInfo() 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.
    
    Returns:
    a 'taken' reference to the field or null if the field is not set.
  - clearAppsInfo
```
void clearAppsInfo()
```
    Clears the value of 'appsInfo'.
    Field Description
    Information about the apps configured for this XVM.
    
    See Also:
    setAppsInfo(SrvMonAppInfo[])
  - setAppsStats
```
void setAppsStats(SrvMonAppStats[] val)
```
    Sets the value of 'appsStats'.
    Field Description
    Platform and user stats for loaded applications.
    
    Parameters:
    val - The value to set.
  - setAppsStatsFrom
```
void setAppsStatsFrom(XIterator<SrvMonAppStats> val)
```
    Sets the value of 'appsStats' using the values from the provided iterator.
    This method will call XIterator.toFirst() before and after setting the values, meaning that all values from the iterator will be set and the iterator will be reset on return.
    
    This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'appsStats' accessor can copy the values without iteration.
    
    Field Description
    Platform and user stats for loaded applications.
    NOTE:
    Passing a null or empty list has the same affect as calling setAppsStats(SrvMonAppStats[]) with a value of null.
    
    Parameters:
    val - the values to set.
  - lendAppsStatsFrom
```
void lendAppsStatsFrom(XIterator<SrvMonAppStats> val)
```
    Sets the value of 'appsStats' by lending the values from the provided iterator.
    This method will call XIterator.toFirst() before and after setting the values, meaning that all values from the iterator will be set and the iterator will be reset on return.
    
    This method will acquire references to each non null value in the provided iterator making it suitable for cases where the values come from another message that may be disposed.
    
    This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'appsStats' accessor can copy the values without iteration.
    
    Field Description
    Platform and user stats for loaded applications.
    NOTE:
    Passing a null or empty list has the same affect as calling setAppsStats(SrvMonAppStats[]) with a value of null.
    
    Parameters:
    val - the values to set.
  - addAppsStats
```
void addAppsStats(SrvMonAppStats val)
```
    Adds the provided value to the list of 'appsStats' values.
    This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'appsStats' accessor can copy the values without iteration.
    
    For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.
    
    Field Description
    Platform and user stats for loaded applications.
    
    Parameters:
    val - the value to add.
  - lendAppsStats
```
void lendAppsStats(SrvMonAppStats val)
```
    Adds the provided value to the list of 'appsStats' values and acquires a reference to it.
    Lending of an added value is useful in cases where a field is being added from a source message to provide dispose of the source value when the source message is disposed.
    
    This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'appsStats' accessor can copy the values without iteration.
    
    For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.
    
    Field Description
    Platform and user stats for loaded applications.
    
    Parameters:
    val - the value to add.
  - getAppsStatsIterator
```
XIterator<SrvMonAppStats> getAppsStatsIterator()
```
    Gets the value of 'appsStats' as iterator of values.
    This method will always return a non null iterator value. The returned iterator is not threadsafe, and the caller may not hold on to it beyond the pooling lifespan of this object. Depending on the implementation, the same iterator instance may be returned by this object on each call to avoid garbage. Each time this method is called the iterator is reset by calling its toFirst() method. Callers should therefore be especially careful about calling this method while iterating on the iterator returned by this method.
    
    The elements returned by this iterator are owned by and pooled along with this object. The caller must call acquire() on each returned object that it intends to keep beyond the either the next call to next(), toFirst() or the lifespace of this object as each object returned by this iterator is disposed on a subsequent call to next() or when this object is disposed.
    
    This method is zero garbage for Xbuf generated classes, and this method is optimized such that passing the returned iterator to another object's setXXX(XIterator method can perform a direct copy of the underlying values without iteration.
    
    Field Description
    Platform and user stats for loaded applications.
    
    Returns:
    An iterator containing this field values.
  - lendAppsStats
```
void lendAppsStats(SrvMonAppStats[] val)
```
    Lends the value of 'appsStats'.
    Field Description
    Platform and user stats for loaded applications.
    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.
    
    Parameters:
    val - the value to 'lend' to lend.
  - getAppsStats
```
SrvMonAppStats[] getAppsStats()
```
    Gets the value of 'appsStats'.
    If the field is not set this method will return null.
    Field Description
    Platform and user stats for loaded applications.
    
    Returns:
    Platform and user stats for loaded applications. If the field is not set this method will return null.
  - getAppsStatsEmptyIfNull
```
SrvMonAppStats[] getAppsStatsEmptyIfNull()
```
    Gets the value of 'appsStats' or an empty array if the value is null or not set.
    Field Description
    Platform and user stats for loaded applications.
    
    Returns:
    Platform and user stats for loaded applications. or an empty array if null if not set.
    See Also:
    getAppsStats()
  - takeAppsStats
```
SrvMonAppStats[] takeAppsStats()
```
    Takes the value of 'appsStats'.
    Field Description
    Platform and user stats for loaded applications.
    NOTE:
    A nested entity reference returned by getAppsStats() 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.
    
    Returns:
    a 'taken' reference to the field or null if the field is not set.
  - clearAppsStats
```
void clearAppsStats()
```
    Clears the value of 'appsStats'.
    Field Description
    Platform and user stats for loaded applications.
    
    See Also:
    setAppsStats(SrvMonAppStats[])
  - setAdminClientStats
```
void setAdminClientStats(SrvMonAdminClientStats[] val)
```
    Sets the value of 'adminClientStats'.
    Field Description
    Collects stats related to the admin client connections.
    
    Parameters:
    val - The value to set.
  - setAdminClientStatsFrom
```
void setAdminClientStatsFrom(XIterator<SrvMonAdminClientStats> val)
```
    Sets the value of 'adminClientStats' using the values from the provided iterator.
    This method will call XIterator.toFirst() before and after setting the values, meaning that all values from the iterator will be set and the iterator will be reset on return.
    
    This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'adminClientStats' accessor can copy the values without iteration.
    
    Field Description
    Collects stats related to the admin client connections.
    NOTE:
    Passing a null or empty list has the same affect as calling setAdminClientStats(SrvMonAdminClientStats[]) with a value of null.
    
    Parameters:
    val - the values to set.
  - lendAdminClientStatsFrom
```
void lendAdminClientStatsFrom(XIterator<SrvMonAdminClientStats> val)
```
    Sets the value of 'adminClientStats' by lending the values from the provided iterator.
    This method will call XIterator.toFirst() before and after setting the values, meaning that all values from the iterator will be set and the iterator will be reset on return.
    
    This method will acquire references to each non null value in the provided iterator making it suitable for cases where the values come from another message that may be disposed.
    
    This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'adminClientStats' accessor can copy the values without iteration.
    
    Field Description
    Collects stats related to the admin client connections.
    NOTE:
    Passing a null or empty list has the same affect as calling setAdminClientStats(SrvMonAdminClientStats[]) with a value of null.
    
    Parameters:
    val - the values to set.
  - addAdminClientStats
```
void addAdminClientStats(SrvMonAdminClientStats val)
```
    Adds the provided value to the list of 'adminClientStats' values.
    This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'adminClientStats' accessor can copy the values without iteration.
    
    For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.
    
    Field Description
    Collects stats related to the admin client connections.
    
    Parameters:
    val - the value to add.
  - lendAdminClientStats
```
void lendAdminClientStats(SrvMonAdminClientStats val)
```
    Adds the provided value to the list of 'adminClientStats' values and acquires a reference to it.
    Lending of an added value is useful in cases where a field is being added from a source message to provide dispose of the source value when the source message is disposed.
    
    This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'adminClientStats' accessor can copy the values without iteration.
    
    For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.
    
    Field Description
    Collects stats related to the admin client connections.
    
    Parameters:
    val - the value to add.
  - getAdminClientStatsIterator
```
XIterator<SrvMonAdminClientStats> getAdminClientStatsIterator()
```
    Gets the value of 'adminClientStats' as iterator of values.
    This method will always return a non null iterator value. The returned iterator is not threadsafe, and the caller may not hold on to it beyond the pooling lifespan of this object. Depending on the implementation, the same iterator instance may be returned by this object on each call to avoid garbage. Each time this method is called the iterator is reset by calling its toFirst() method. Callers should therefore be especially careful about calling this method while iterating on the iterator returned by this method.
    
    The elements returned by this iterator are owned by and pooled along with this object. The caller must call acquire() on each returned object that it intends to keep beyond the either the next call to next(), toFirst() or the lifespace of this object as each object returned by this iterator is disposed on a subsequent call to next() or when this object is disposed.
    
    This method is zero garbage for Xbuf generated classes, and this method is optimized such that passing the returned iterator to another object's setXXX(XIterator method can perform a direct copy of the underlying values without iteration.
    
    Field Description
    Collects stats related to the admin client connections.
    
    Returns:
    An iterator containing this field values.
  - lendAdminClientStats
```
void lendAdminClientStats(SrvMonAdminClientStats[] val)
```
    Lends the value of 'adminClientStats'.
    Field Description
    Collects stats related to the admin client connections.
    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.
    
    Parameters:
    val - the value to 'lend' to lend.
  - getAdminClientStats
```
SrvMonAdminClientStats[] getAdminClientStats()
```
    Gets the value of 'adminClientStats'.
    If the field is not set this method will return null.
    Field Description
    Collects stats related to the admin client connections.
    
    Returns:
    Collects stats related to the admin client connections. If the field is not set this method will return null.
  - getAdminClientStatsEmptyIfNull
```
SrvMonAdminClientStats[] getAdminClientStatsEmptyIfNull()
```
    Gets the value of 'adminClientStats' or an empty array if the value is null or not set.
    Field Description
    Collects stats related to the admin client connections.
    
    Returns:
    Collects stats related to the admin client connections. or an empty array if null if not set.
    See Also:
    getAdminClientStats()
  - takeAdminClientStats
```
SrvMonAdminClientStats[] takeAdminClientStats()
```
    Takes the value of 'adminClientStats'.
    Field Description
    Collects stats related to the admin client connections.
    NOTE:
    A nested entity reference returned by getAdminClientStats() 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.
    
    Returns:
    a 'taken' reference to the field or null if the field is not set.
  - clearAdminClientStats
```
void clearAdminClientStats()
```
    Clears the value of 'adminClientStats'.
    Field Description
    Collects stats related to the admin client connections.
    
    See Also:
    setAdminClientStats(SrvMonAdminClientStats[])
  - setSystemName
```
void setSystemName(String val)
```
    Sets the value of 'systemName'.
    Field Description
    The name of the system to which the XVM belongs.
    
    Parameters:
    val - The value to set.
  - getSystemName
```
String getSystemName()
```
    Gets the value of 'systemName'.
    Field Description
    The name of the system to which the XVM belongs.
    
    Returns:
    The name of the system to which the XVM belongs.
  - lendSystemName
```
void lendSystemName(XString val)
```
    Lends the value of 'systemName' to this object.
    This method is equivalent to setSystemName 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 system to which the XVM belongs.
    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.
    
    Parameters:
    val - The value to set.
    
    Throws:
    
    IllegalArgumentException - If the value is mutable.
  - setSystemNameFrom
```
void setSystemNameFrom(long val)
```
    Sets the value of this String field to the given numeric value.
    Field Description
    The name of the system to which the XVM belongs.
    NOTE:
    This is the same as calling setSystemName(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.
  - getSystemNameTo
```
<T extends XString> T getSystemNameTo(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 system to which the XVM belongs.
    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
  - setSystemNameFrom
```
void setSystemNameFrom(XString val)
```
    Copies the provided XString value into this object's 'systemName'.
    Field Description
    The name of the system to which the XVM belongs.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than setSystemName(String) because it avoids encoding the value into a String if the given XString is already encoded.
  - getSystemNameTo
```
void getSystemNameTo(XString val)
```
    Copies the value of 'systemName' into the provided XString.
    Field Description
    The name of the system to which the XVM belongs.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than getSystemName() bec because it can avoid decoding the value into an String.
    
    See Also:
    getSystemName()
  - getSystemNameUnsafe
```
XString getSystemNameUnsafe()
```
    Gets the raw value of 'systemName'.
    Field Description
    The name of the system to which the XVM belongs.
    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:
    getSystemName()
  - clearSystemName
```
void clearSystemName()
```
    Clears the value of 'systemName'.
    Field Description
    The name of the system to which the XVM belongs.
    
    See Also:
    setSystemName(String)
  - hasSystemName
```
boolean hasSystemName()
```
    Checks for the presence of 'systemName'.
    Field Description
    The name of the system to which the XVM belongs.
    
    See Also:
    getSystemName()
  - setSystemVersion
```
void setSystemVersion(String val)
```
    Sets the value of 'systemVersion'.
    Field Description
    The version of the system to which the XVM belongs.
    
    Parameters:
    val - The value to set.
  - getSystemVersion
```
String getSystemVersion()
```
    Gets the value of 'systemVersion'.
    Field Description
    The version of the system to which the XVM belongs.
    
    Returns:
    The version of the system to which the XVM belongs.
  - lendSystemVersion
```
void lendSystemVersion(XString val)
```
    Lends the value of 'systemVersion' to this object.
    This method is equivalent to setSystemVersion 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 version of the system to which the XVM belongs.
    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.
    
    Parameters:
    val - The value to set.
    
    Throws:
    
    IllegalArgumentException - If the value is mutable.
  - setSystemVersionFrom
```
void setSystemVersionFrom(long val)
```
    Sets the value of this String field to the given numeric value.
    Field Description
    The version of the system to which the XVM belongs.
    NOTE:
    This is the same as calling setSystemVersion(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.
  - getSystemVersionTo
```
<T extends XString> T getSystemVersionTo(XString.Factory<T> factory)
```
    Copies the value of this String field into a new XString from the given factory.
    Field Description
    The version of the system to which the XVM belongs.
    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
  - setSystemVersionFrom
```
void setSystemVersionFrom(XString val)
```
    Copies the provided XString value into this object's 'systemVersion'.
    Field Description
    The version of the system to which the XVM belongs.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than setSystemVersion(String) because it avoids encoding the value into a String if the given XString is already encoded.
  - getSystemVersionTo
```
void getSystemVersionTo(XString val)
```
    Copies the value of 'systemVersion' into the provided XString.
    Field Description
    The version of the system to which the XVM belongs.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than getSystemVersion() bec because it can avoid decoding the value into an String.
    
    See Also:
    getSystemVersion()
  - getSystemVersionUnsafe
```
XString getSystemVersionUnsafe()
```
    Gets the raw value of 'systemVersion'.
    Field Description
    The version of the system to which the XVM belongs.
    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:
    getSystemVersion()
  - clearSystemVersion
```
void clearSystemVersion()
```
    Clears the value of 'systemVersion'.
    Field Description
    The version of the system to which the XVM belongs.
    
    See Also:
    setSystemVersion(String)
  - hasSystemVersion
```
boolean hasSystemVersion()
```
    Checks for the presence of 'systemVersion'.
    Field Description
    The version of the system to which the XVM belongs.
    
    See Also:
    getSystemVersion()
  - setHeartbeatLoggerStats
```
void setHeartbeatLoggerStats(SrvMonAppMessageLoggerStats val)
```
    Sets the value of 'heartbeatLoggerStats'.
    Field Description
    Logger stats for the xvm's binary heartbeat log (if enabled).
    
    Parameters:
    val - The value to set.
  - lendHeartbeatLoggerStats
```
void lendHeartbeatLoggerStats(SrvMonAppMessageLoggerStats val)
```
    'Lends' a reference of the SrvMonAppMessageLoggerStats to the message for this field.
    Field Description
    Logger stats for the xvm's binary heartbeat log (if enabled).
    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.
    
    Parameters:
    val - the value to 'lend' to lend.
  - getHeartbeatLoggerStats
```
SrvMonAppMessageLoggerStats getHeartbeatLoggerStats()
```
    Gets the value of 'heartbeatLoggerStats'.
    Field Description
    Logger stats for the xvm's binary heartbeat log (if enabled).
    
    Returns:
    Logger stats for the xvm's binary heartbeat log (if enabled).
  - getHeartbeatLoggerStatsTo
```
void getHeartbeatLoggerStatsTo(SrvMonAppMessageLoggerStats val)
```
    Copies the value of SrvMonAppMessageLoggerStats into the provided value.
    IF the value is not set, then the contents of the provided SrvMonAppMessageLoggerStats are cleared.
    
    Parameters:
    val - the value to copy into
    See Also:
    SrvMonAppMessageLoggerStats.copyInto(SrvMonAppMessageLoggerStats)
  - takeHeartbeatLoggerStats
```
SrvMonAppMessageLoggerStats takeHeartbeatLoggerStats()
```
    'Takes' a reference to the heartbeatLoggerStats field from the message.
    Field Description
    Logger stats for the xvm's binary heartbeat log (if enabled).
    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.
    
    Returns:
    a 'taken' reference to the field or null if the field is not set.
  - hasHeartbeatLoggerStats
```
boolean hasHeartbeatLoggerStats()
```
    Checks for the presence of 'heartbeatLoggerStats'.
    Field Description
    Logger stats for the xvm's binary heartbeat log (if enabled).
    
    See Also:
    getHeartbeatLoggerStats()
  - clearHeartbeatLoggerStats
```
void clearHeartbeatLoggerStats()
```
    Clears the value of 'heartbeatLoggerStats'.
    Field Description
    Logger stats for the xvm's binary heartbeat log (if enabled).
    
    See Also:
    setHeartbeatLoggerStats(SrvMonAppMessageLoggerStats)
  - copy
```
SrvMonHeartbeatMessage copy()
```
    Creates a copy of this SrvMonHeartbeatMessage.
    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 SrvMonHeartbeatMessage's embedded entity fields.
    The returned copy will be writeable even if this SrvMonHeartbeatMessage 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<ISrvMonHeartbeatMessage>
    
    Specified by:
    
    copy in interface IRogCopyableNode<ISrvMonHeartbeatMessage>
    
    Returns:
    A copy of this SrvMonHeartbeatMessage.
    See Also:
    IRogCopyableNode, CopyableMessageView
  - copyInto
```
void copyInto(SrvMonHeartbeatMessage target)
```
    Copies the contents of this SrvMonHeartbeatMessage 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 SrvMonHeartbeatMessage's embedded entity fields.
    The returned copy will be writeable even if this SrvMonHeartbeatMessage 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.

Interface ISrvMonHeartbeatMessage

ADM Details

Nested Class Summary

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

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

Method Summary

Methods inherited from interface com.neeve.rog.IRogNode

Methods inherited from interface com.neeve.ods.IStoreObject

Methods inherited from interface com.neeve.ods.IStoreObjectMetadata

Methods inherited from interface com.neeve.sma.MapMessageView

Methods inherited from interface com.neeve.rog.IRogMetadata

Methods inherited from interface com.neeve.rog.IRogValidatable

Method Detail

setCollectionStartWallTime

Field Description

getCollectionStartWallTime

Field Description

clearCollectionStartWallTime

Field Description

hasCollectionStartWallTime

Field Description

setCollectionStartTime

Field Description

getCollectionStartTime

Field Description

clearCollectionStartTime

Field Description

hasCollectionStartTime

Field Description

setCollectionEndTime

Field Description

getCollectionEndTime

Field Description

clearCollectionEndTime

Field Description

hasCollectionEndTime

Field Description

setLoadedTime

Field Description

getLoadedTime

Field Description

setLoadedTimeAsTimestamp

Field Description

getLoadedTimeAsTimestamp

Field Description

clearLoadedTime

Field Description

hasLoadedTime

Field Description

setXvmHeader

Field Description

lendXvmHeader

Field Description

getXvmHeader

Field Description

getXvmHeaderTo

takeXvmHeader

Field Description

hasXvmHeader

Field Description

clearXvmHeader

Field Description

setServerName

Field Description

getServerName

Field Description

lendServerName

Field Description

Usage Notes

setServerNameFrom

Field Description

getServerNameTo

Field Description

setServerNameFrom

Field Description

getServerNameTo

Field Description

getServerNameUnsafe

Field Description

clearServerName