SrvMonListCommandsResponse (Talon 3.14.19 API)

java.lang.Object
- com.neeve.util.UtlListElement
- - com.neeve.sma.MessageViewImpl
  - - com.neeve.rog.impl.RogNode
    - - com.neeve.server.mon.cnc.SrvMonListCommandsResponse

All Implemented Interfaces:: com.neeve.link.ILnkMessage, IStoreObject, IStoreObjectMetadata, IRogCopyableNode<ISrvMonListCommandsResponse>, IRogJsonizable, IRogMessage, IRogMetadata, IRogNode, IRogValidatable, ISrvMonListCommandsResponse, ISrvMonXvmResponse, com.neeve.server.mon.common.IHasSrvMonXvmHeader, CopyableMessageView<ISrvMonListCommandsResponse>, MapMessageView, MessageReflector, MessageView, UtlReferenceTracker.HasReferenceTracker, com.neeve.xbuf.IXbufDesyncer

@Generated(value="com.neeve.adm.AdmXbufGenerator",
           date="Thu May 07 15:37:32 EDT 2020")
@AdmGenerated(encoding="Xbuf",
              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)")
@AdmFactoryInfo(factoryClass=SrvMonCncFactory.class,
                vfid=36,
                ofid=36,
                typeId=2)
public final class SrvMonListCommandsResponse
extends com.neeve.rog.impl.RogNode
implements ISrvMonListCommandsResponse, com.neeve.link.ILnkMessage, MessageReflector, com.neeve.xbuf.IXbufDesyncer, IRogJsonizable

Response with the list of available commands.

ADM Details

ADM Type	Message
Factory	SrvMonCncFactory

ADM Field Summary

Field	Type	Id	Description
adminClientId	String	216	The admin client targeted in the command exchange.
commands	SrvMonCommandDescription[]	16	No doc provided.
correlationId	Long	217	The request correlation ID.
xvmHeader	SrvMonXvmHeader	6019	Details about the message source.
xvmName	String	218	The name of the XVM targeted in the command exchange.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SrvMonListCommandsResponse.PacketBody` The backing packet type for SrvMonListCommandsResponse (used internally for serialization purposes).

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

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

Field Summary

Fields
Modifier and Type Field and Description

static SrvMonListCommandsResponse[] EMPTY_ARRAY
A preallocated empty array used to avoid garbage when returning empty arrays of this type.
- Fields inherited from class com.neeve.rog.impl.RogNode
  DATE_FORMAT
- Fields inherited from class com.neeve.util.UtlListElement
  count, head, next, prev

Fields
Modifier and Type	Field and Description
`static SrvMonListCommandsResponse[]`	`EMPTY_ARRAY` A preallocated empty array used to avoid garbage when returning empty arrays of this type.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addCommands(SrvMonCommandDescription val)` Adds the provided value to the list of 'commands' values.
`boolean`	`appendFieldValueTo(Object node, String[] pathComponents, XString target)` Appends a reflected field value as a string into the given XString.
`boolean`	`appendFieldValueTo(Object message, String name, XString target)` Appends a reflected field value as a string into the given XString.
`void`	`clearAdminClientId()` Clears the value of 'adminClientId'.
`void`	`clearCommands()` Clears the value of 'commands'.
`void`	`clearContent()`
`void`	`clearCorrelationId()` Clears the value of 'correlationId'.
`void`	`clearXRogType()`
`void`	`clearXvmHeader()` Clears the value of 'xvmHeader'.
`void`	`clearXvmName()` Clears the value of 'xvmName'.
`SrvMonListCommandsResponse`	`copy()` Creates a copy of this SrvMonListCommandsResponse.
`void`	`copyInto(SrvMonListCommandsResponse copy)` Copies the contents of this SrvMonListCommandsResponse into the target.
`static SrvMonListCommandsResponse`	`create()`
`static SrvMonListCommandsResponse`	`create(com.eaio.uuid.UUID id)`
`static SrvMonListCommandsResponse`	`createFrom(byte[] serializedContainer)`
`static SrvMonListCommandsResponse`	`createFrom(ByteBuffer serializedContainer)`
`static SrvMonListCommandsResponse`	`createFromJson(String json)`
`static SrvMonListCommandsResponse`	`createFromRawJson(String json)`
`static SrvMonListCommandsResponse`	`createFromSerializedXbufContainer(byte[] serializedContainer)`
`static SrvMonListCommandsResponse`	`createFromSerializedXbufContainer(ByteBuffer serializedContainer)`
`static SrvMonListCommandsResponse`	`createFromSerializedXbufContainerPacket(byte[] serializedPacket)`
`static SrvMonListCommandsResponse`	`createFromSerializedXbufContainerPacket(ByteBuffer serializedPacket)`
`static SrvMonListCommandsResponse`	`createFromXbufContainerPacket(PktPacket packet)`
`static com.neeve.xbuf.XbufSchema`	`createSchema()`
`SrvMonListCommandsResponse`	`deserialize(PktPacket packet)` Deserialize an object's data.
`SrvMonListCommandsResponse`	`deserializeFromByteArray(byte[] array)` Deserialize a view's backing message from a byte array.
`SrvMonListCommandsResponse`	`deserializeFromByteBuffer(ByteBuffer buffer)` Deserialize a view's backing message from a byte buffer.
`SrvMonListCommandsResponse`	`deserializeFromJson(String json)` Deserialize a view's backing message from a json string
`SrvMonListCommandsResponse`	`deserializeFromPacket(PktPacket packet)` Deserialize a view's backing message from a packet.
`SrvMonListCommandsResponse`	`deserializeFromProtobuf(com.google.protobuf.Message message)` Deserialize a node's data from a protobuf message.
`SrvMonListCommandsResponse`	`deserializeFromRawJson(String json)`
`int`	`desync(PktBuffer buffer, int pos, boolean frameOnly)` Desync fields from a buffer
`void`	`desyncFieldBitmask()`
`int`	`dispose()` Implementation of `IRogNode.dispose()` ROG nodes piggyback on packet pooling to perform node pooling.
`boolean`	`fieldExists(Object message, String name)` Check if a field of the supplied name exists in a message.
`String`	`getAdminClientId()` Gets the value of 'adminClientId'.
`com.neeve.xbuf.XbufStringField`	`getAdminClientIdField()`
`static int`	`getAdminClientIdFieldId()`
`<T extends XString> T`	`getAdminClientIdTo(XString.Factory<T> factory)` Copies the value of this String field into a new XString from the given factory.
`void`	`getAdminClientIdTo(XString val)` Copies the value of 'adminClientId' into the provided XString.
`XString`	`getAdminClientIdUnsafe()` Gets the raw value of 'adminClientId'.
`PktBuffer`	`getBackingBuffer()`
`SrvMonCommandDescription[]`	`getCommands()` Gets the value of 'commands'.
`SrvMonCommandDescription[]`	`getCommandsEmptyIfNull()` Gets the value of 'commands' or an empty array if the value is `null` or not set.
`static int`	`getCommandsFieldId()`
`XIterator<SrvMonCommandDescription>`	`getCommandsIterator()` Gets the value of 'commands' as iterator of values.
`IStoreObject.EncodingType`	`getContentEncodingType()` Get an object's content data encoding type.
`long`	`getCorrelationId()` Gets the value of 'correlationId'.
`com.neeve.xbuf.XbufVariableLongField`	`getCorrelationIdField()`
`static int`	`getCorrelationIdFieldId()`
`static com.neeve.xbuf.XbufDesyncPolicy`	`getDesyncPolicy()`
`XString`	`getFieldValueAsRawString(Object message, String name)` Get the value of a reflectable field in a message as a string.
`XString`	`getFieldValueAsRawString(Object message, String[] pathComponents)` Get the value of a reflectable field in a message as a string.
`String`	`getFieldValueAsString(Object message, String name)` Get the value of a reflectable field in a message as a string.
`String`	`getFieldValueAsString(Object message, String[] pathComponents)` Get the value of a reflectable field in a message as a string.
`PktPacket`	`getPacket()` Return the packet tied to this message.
`short`	`getXRogType()`
`com.neeve.xbuf.XbufVariableShortField`	`getXRogTypeField()`
`static int`	`getXRogTypeFieldId()`
`com.neeve.server.mon.common.SrvMonXvmHeader`	`getXvmHeader()` Gets the value of 'xvmHeader'.
`static int`	`getXvmHeaderFieldId()`
`void`	`getXvmHeaderTo(com.neeve.server.mon.common.SrvMonXvmHeader to)` Copies the value of SrvMonXvmHeader into the provided value.
`String`	`getXvmName()` Gets the value of 'xvmName'.
`com.neeve.xbuf.XbufStringField`	`getXvmNameField()`
`static int`	`getXvmNameFieldId()`
`<T extends XString> T`	`getXvmNameTo(XString.Factory<T> factory)` Copies the value of this String field into a new XString from the given factory.
`void`	`getXvmNameTo(XString val)` Copies the value of 'xvmName' into the provided XString.
`XString`	`getXvmNameUnsafe()` Gets the raw value of 'xvmName'.
`boolean`	`hasAdminClientId()` Checks for the presence of 'adminClientId'.
`boolean`	`hasCorrelationId()` Checks for the presence of 'correlationId'.
`boolean`	`hasXRogType()`
`boolean`	`hasXvmHeader()` Checks for the presence of 'xvmHeader'.
`boolean`	`hasXvmName()` Checks for the presence of 'xvmName'.
`boolean`	`isDirty()`
`boolean`	`isFieldReflectable(Object message, String name)` Check if a field of the supplied name is reflectable.
`void`	`lendAdminClientId(XString val)` Lends the value of 'adminClientId' to this object.
`void`	`lendCommands(SrvMonCommandDescription val)` Adds the provided value to the list of 'commands' values and acquires a reference to it.
`void`	`lendCommands(SrvMonCommandDescription[] val)` Lends the value of 'commands'.
`void`	`lendCommandsFrom(XIterator<SrvMonCommandDescription> val)` Sets the value of 'commands' by lending the values from the provided iterator.
`void`	`lendXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)` 'Lends' a reference of the SrvMonXvmHeader to the message for this field.
`void`	`lendXvmName(XString val)` Lends the value of 'xvmName' to this object.
`boolean`	`needsSync()` Check if a view needs to be sync'd for reflection.
`static void`	`optimizeFor(int val)`
`PktPacket`	`serialize()` Serialize an object's data.
`byte[]`	`serializeToByteArray()` Serialize a view's backing message to a byte array.
`ByteBuffer`	`serializeToByteBuffer()` Serialize a view's backing message to a byte buffer.
`com.neeve.io.IOBuffer`	`serializeToIOBuffer(boolean useNative)` Serializes the `MessageView` to an IOBuffer.
`String`	`serializeToJson()` Serialize a view's backing message to JSON.
`PktPacket`	`serializeToPacket()` Serialize a view's backing message to a packet.
`com.google.protobuf.Message`	`serializeToProtobuf()` Serialize a node's data to a proto message.
`String`	`serializeToRawJson()`
`void`	`setAdminClientId(String val)` Sets the value of 'adminClientId'.
`void`	`setAdminClientIdFrom(long val)` Sets the value of this String field to the given numeric value.
`void`	`setAdminClientIdFrom(com.neeve.xbuf.XbufStringField val)`
`void`	`setAdminClientIdFrom(XString val)` Copies the provided XString value into this object's 'adminClientId'.
`void`	`setAsReadOnly()` Implementation of `IRogNode.setAsReadOnly()`
`void`	`setCommands(SrvMonCommandDescription[] val)` Sets the value of 'commands'.
`void`	`setCommandsFrom(XIterator<SrvMonCommandDescription> val)` Sets the value of 'commands' using the values from the provided iterator.
`void`	`setCorrelationId(long val)` Sets the value of 'correlationId'.
`void`	`setCorrelationIdFrom(com.neeve.xbuf.XbufVariableLongField val)`
`static void`	`setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)`
`static void`	`setFieldInterest(List<Integer> fieldIds)`
`IStoreObject`	`setFieldValue(int id, Object val)`
`void`	`setPreserializedFields(PktBuffer buffer)`
`void`	`setXRogType(short val)`
`void`	`setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)`
`void`	`setXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)` Sets the value of 'xvmHeader'.
`void`	`setXvmName(String val)` Sets the value of 'xvmName'.
`void`	`setXvmNameFrom(long val)` Sets the value of this String field to the given numeric value.
`void`	`setXvmNameFrom(com.neeve.xbuf.XbufStringField val)`
`void`	`setXvmNameFrom(XString val)` Copies the provided XString value into this object's 'xvmName'.
`void`	`sync()` Ensure a view's backing message is prepared and ready for transport
`void`	`syncFieldBitmask()`
`SrvMonCommandDescription[]`	`takeCommands()` Takes the value of 'commands'.
`com.neeve.server.mon.common.SrvMonXvmHeader`	`takeXvmHeader()` 'Takes' a reference to the xvmHeader field from the message.
`String`	`toJsonString()` Get a JSON representation of an ROG entity
`String`	`toJsonString(boolean includeMetadata, String metadataObjectName, String payloadObjectName)` Get a full JSON representation of an ROG entity
`String`	`toString()` Return a string representation of an ROG node.
`void`	`undispose(com.eaio.uuid.UUID id)` Recuscitate a disposed node.

Methods inherited from class com.neeve.rog.impl.RogNode
accept, deserializeMetadata, deserializeMetadata, dump, ensureId, getAppSendBeginTs, getAppSendDoneTs, getAttachment, getBinding, getCheckpointVersion, getCommittedDataSize, getCreateTs, getEnqueueTs, getEnqueueTsMicros, getFields, getGraphId, getId, getInMsgsInTransaction, getIsInboundMessage, getIsInternal, getIsLastTransaction, getIsLiveInboundMessage, getIsMessage, getIsOutboundMessage, getIsPriority, getIsReadOnly, getIsReplayedMessage, getMessageBus, getMessageBusAsRaw, getMessageChannel, getMessageChannelAsRaw, getMessageFlow, getMessageKey, getMessageKeyAsRaw, getMessageReflector, getMessageSender, getMessageSequenceNumber, getMessageTransportHeaders, getMetadata, getOfid, getOriginTs, getOutMsgsInTransaction, getOutTs, getOutTsMicros, getParent, getParentId, getPoolingListener, getPostDeserializeTs, getPostProcessingTs, getPostProcessingTsMicros, getPostSerializeTs, getPostWireSendTs, getPostWireTs, getPreDeserializeTs, getPreProcessingTs, getPreProcessingTsMicros, getPreSerializeTs, getPreWireTs, getReceiveTs, getSendStartTs, getSendTs, getSerializedMetadataLength, getStableTransactionId, getStoreMetadata, getTransactionId, getTransactionInSequenceNumber, getTransactionOutSequenceNumber, getTypeFromJson, getValidationErrors, isPossibleDuplicate, isValid, metadataToJsonString, metadataToJsonString, metadataToString, resolveMessageKeyWith, resolveMessageKeyWith, saveMemory, serializeMetadata, setAppSendBeginTs, setAppSendDoneTs, setAsInboundMessage, setAsInternal, setAsLastTransaction, setAsMessage, setAsOutboundMessage, setAsPriority, setAsReplayedMessage, setAttachment, setBinding, setCheckpointVersion, setCommittedDataSize, setCreateTs, setEnqueueTsMicros, setFieldValue, setGraphId, setId, setInMsgsInTransaction, setMessageBus, setMessageBusAsRaw, setMessageChannel, setMessageChannelAsRaw, setMessageFlow, setMessageKey, setMessageKeyAsRaw, setMessageSender, setMessageSequenceNumber, setMessageTransportHeaders, setOriginTs, setOutMsgsInTransaction, setOutTs, setOutTsMicros, setParentId, setPoolingListener, setPossibleDuplicate, setPostDeserializeTs, setPostProcessingTs, setPostProcessingTsMicros, setPostSerializeTs, setPostWireSendTs, setPostWireTs, setPreDeserializeTs, setPreProcessingTs, setPreProcessingTsMicros, setPreSerializeTs, setPreWireTs, setReceiveTs, setSendStartTs, setSendTs, setStableTransactionId, setTransactionId, setTransactionInSequenceNumber, setTransactionOutSequenceNumber

Methods inherited from class com.neeve.sma.MessageViewImpl
acquire, getMessage, getMessageEncodingType, getOwnershipCount, getTag, getType, getVfid, referenceTracker, setTag

Methods inherited from class com.neeve.util.UtlListElement
count, insertAfter, insertBefore, isLinked, next, previous, unlink, wipe

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.neeve.ods.IStoreObject
acquire, deserializeMetadata, deserializeMetadata, getOwnershipCount, getSerializedMetadataLength, getStoreMetadata, 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

- Field Detail
  - EMPTY_ARRAY
```
public static final SrvMonListCommandsResponse[] EMPTY_ARRAY
```
    A preallocated empty array used to avoid garbage when returning empty arrays of this type.
- Method Detail
  - create
```
public static SrvMonListCommandsResponse create()
```
  - create
```
public static SrvMonListCommandsResponse create(com.eaio.uuid.UUID id)
```
  - createFromXbufContainerPacket
```
public static SrvMonListCommandsResponse createFromXbufContainerPacket(PktPacket packet)
```
  - createFromSerializedXbufContainerPacket
```
public static SrvMonListCommandsResponse createFromSerializedXbufContainerPacket(ByteBuffer serializedPacket)
```
  - createFromSerializedXbufContainerPacket
```
public static SrvMonListCommandsResponse createFromSerializedXbufContainerPacket(byte[] serializedPacket)
```
  - createFromSerializedXbufContainer
```
public static SrvMonListCommandsResponse createFromSerializedXbufContainer(ByteBuffer serializedContainer)
```
  - createFromSerializedXbufContainer
```
public static SrvMonListCommandsResponse createFromSerializedXbufContainer(byte[] serializedContainer)
```
  - createFromRawJson
```
public static SrvMonListCommandsResponse createFromRawJson(String json)
```
  - createFromJson
```
public static SrvMonListCommandsResponse createFromJson(String json)
```
  - createFrom
```
public static SrvMonListCommandsResponse createFrom(ByteBuffer serializedContainer)
```
  - createFrom
```
public static SrvMonListCommandsResponse createFrom(byte[] serializedContainer)
```
  - setDesyncPolicy
```
public static final void setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
```
  - getDesyncPolicy
```
public static final com.neeve.xbuf.XbufDesyncPolicy getDesyncPolicy()
```
  - setFieldInterest
```
public static final void setFieldInterest(List<Integer> fieldIds)
```
  - clearContent
```
public final void clearContent()
```
  - syncFieldBitmask
```
public final void syncFieldBitmask()
```
  - desyncFieldBitmask
```
public final void desyncFieldBitmask()
```
  - getBackingBuffer
```
public final PktBuffer getBackingBuffer()
```
  - optimizeFor
```
public static final void optimizeFor(int val)
```
  - getPacket
```
public final PktPacket getPacket()
```
    Description copied from interface: com.neeve.link.ILnkMessage
    
    Return the packet tied to this message.
    
    Specified by:
    
    getPacket in interface com.neeve.link.ILnkMessage
  - serializeToProtobuf
```
public final com.google.protobuf.Message serializeToProtobuf()
```
    Description copied from interface: IRogNode
    
    Serialize a node's data to a proto message.
    
    Specified by:
    
    serializeToProtobuf in interface IRogNode
  - serializeToRawJson
```
public final String serializeToRawJson()
```
  - serializeToJson
```
public final String serializeToJson()
```
    Description copied from interface: MessageView
    
    Serialize a view's backing message to JSON.
    Serializing/deserializing a message to/from JSON is an optional operation
    
    Specified by:
    
    serializeToJson in interface MessageView
  - deserializeFromProtobuf
```
public final SrvMonListCommandsResponse deserializeFromProtobuf(com.google.protobuf.Message message)
```
    Description copied from interface: IRogNode
    
    Deserialize a node's data from a protobuf message.
    
    Specified by:
    
    deserializeFromProtobuf in interface IRogNode
    
    Parameters:
    message - The protobuf message
  - deserializeFromRawJson
```
public final SrvMonListCommandsResponse deserializeFromRawJson(String json)
```
  - deserializeFromJson
```
public final SrvMonListCommandsResponse deserializeFromJson(String json)
```
    Description copied from interface: MessageView
    
    Deserialize a view's backing message from a json string
    
    Specified by:
    
    deserializeFromJson in interface MessageView
    
    Parameters:
    json - The view's backing message serialized as a json string.
    Serializing/deserializing a message to/from JSON is an optional operation
  - setAsReadOnly
```
public final void setAsReadOnly()
```
    Description copied from class: com.neeve.rog.impl.RogNode
    
    Implementation of IRogNode.setAsReadOnly()
    
    Specified by:
    
    setAsReadOnly in interface IRogNode
    
    Overrides:
    
    setAsReadOnly in class com.neeve.rog.impl.RogNode
  - dispose
```
public int dispose()
```
    Description copied from class: com.neeve.rog.impl.RogNode
    
    Implementation of IRogNode.dispose()
    ROG nodes piggyback on packet pooling to perform node pooling. When this disposed, nodes release their reference to their backing packet (if a node is not backed by a packet, the this method does nothing and the node is released for garbage collection). The reference release will cause the packet to ultimately enter into its pool (if a poolable packet type). Since nodes are tagged to packets (via TAG_ROG_ENVELOPE), nodes implictly also get pooled. To resuscitate a disposed node, the user should get the node from its packet and invoke RogNode.undispose(com.eaio.uuid.UUID)
    
    Specified by:
    
    dispose in interface IStoreObject
    
    Specified by:
    
    dispose in interface IRogNode
    
    Specified by:
    
    dispose in interface MessageView
    
    Overrides:
    
    dispose in class com.neeve.rog.impl.RogNode
    
    Returns:
    The reference count after the dispose completed.
  - undispose
```
public void undispose(com.eaio.uuid.UUID id)
```
    Description copied from class: com.neeve.rog.impl.RogNode
    
    Recuscitate a disposed node.
    
    Overrides:
    
    undispose in class com.neeve.rog.impl.RogNode
    
    Parameters:
    id - The resuscitated node's id.
    This method should be called to resuscitate a disposed node. Since the caller must release all references to a disposed node, the only place a disposed node can be obtained from is its pooled backing packet container. Upon retrieving a packet from a pool, the user should obtain the node from the TAG_ROG_ENVELOPE packet tag. If the tag is non-null, then it refers to an ROG node object. The user should invoke this method on the node before using the node.
  - setPreserializedFields
```
public final void setPreserializedFields(PktBuffer buffer)
```
  - getXRogTypeFieldId
```
public static final int getXRogTypeFieldId()
```
  - setXRogType
```
public final void setXRogType(short val)
```
  - getXRogType
```
public final short getXRogType()
```
  - setXRogTypeFrom
```
public final void setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)
```
  - getXRogTypeField
```
public final com.neeve.xbuf.XbufVariableShortField getXRogTypeField()
```
  - hasXRogType
```
public final boolean hasXRogType()
```
  - clearXRogType
```
public final void clearXRogType()
```
  - getCorrelationIdFieldId
```
public static final int getCorrelationIdFieldId()
```
  - setCorrelationId
```
public final void setCorrelationId(long val)
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Sets the value of 'correlationId'.
    Field Description
    The request correlation ID.
    
    Specified by:
    
    setCorrelationId in interface ISrvMonListCommandsResponse
    
    Specified by:
    
    setCorrelationId in interface ISrvMonXvmResponse
    
    Parameters:
    val - The value to set.
  - getCorrelationId
```
public final long getCorrelationId()
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Gets the value of 'correlationId'.
    Field Description
    The request correlation ID.
    
    Specified by:
    
    getCorrelationId in interface ISrvMonListCommandsResponse
    
    Specified by:
    
    getCorrelationId in interface ISrvMonXvmResponse
    
    Returns:
    The request correlation ID
  - setCorrelationIdFrom
```
public final void setCorrelationIdFrom(com.neeve.xbuf.XbufVariableLongField val)
```
  - getCorrelationIdField
```
public final com.neeve.xbuf.XbufVariableLongField getCorrelationIdField()
```
  - hasCorrelationId
```
public final boolean hasCorrelationId()
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Checks for the presence of 'correlationId'.
    Field Description
    The request correlation ID.
    
    Specified by:
    
    hasCorrelationId in interface ISrvMonListCommandsResponse
    
    Specified by:
    
    hasCorrelationId in interface ISrvMonXvmResponse
    
    See Also:
    ISrvMonListCommandsResponse.getCorrelationId()
  - clearCorrelationId
```
public final void clearCorrelationId()
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Clears the value of 'correlationId'.
    Field Description
    The request correlation ID.
    
    Specified by:
    
    clearCorrelationId in interface ISrvMonListCommandsResponse
    
    Specified by:
    
    clearCorrelationId in interface ISrvMonXvmResponse
    
    See Also:
    ISrvMonListCommandsResponse.setCorrelationId(long)
  - getXvmHeaderFieldId
```
public static final int getXvmHeaderFieldId()
```
  - setXvmHeader
```
public final void setXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Sets the value of 'xvmHeader'.
    Field Description
    Details about the message source.
    
    Specified by:
    
    setXvmHeader in interface ISrvMonListCommandsResponse
    
    Specified by:
    
    setXvmHeader in interface ISrvMonXvmResponse
    
    Specified by:
    
    setXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader
    
    Parameters:
    val - The value to set.
  - lendXvmHeader
```
public final void lendXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    '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 ISrvMonListCommandsResponse
    
    Specified by:
    
    lendXvmHeader in interface ISrvMonXvmResponse
    
    Specified by:
    
    lendXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader
    
    Parameters:
    val - the value to 'lend' to lend.
  - getXvmHeader
```
public final com.neeve.server.mon.common.SrvMonXvmHeader getXvmHeader()
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Gets the value of 'xvmHeader'.
    Field Description
    Details about the message source.
    
    Specified by:
    
    getXvmHeader in interface ISrvMonListCommandsResponse
    
    Specified by:
    
    getXvmHeader in interface ISrvMonXvmResponse
    
    Specified by:
    
    getXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader
    
    Returns:
    Details about the message source.
  - getXvmHeaderTo
```
public final void getXvmHeaderTo(com.neeve.server.mon.common.SrvMonXvmHeader to)
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    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 ISrvMonListCommandsResponse
    
    Specified by:
    
    getXvmHeaderTo in interface ISrvMonXvmResponse
    
    Specified by:
    
    getXvmHeaderTo in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader
    
    Parameters:
    to - the value to copy into
    See Also:
    SrvMonXvmHeader.copyInto(SrvMonXvmHeader)
  - takeXvmHeader
```
public final com.neeve.server.mon.common.SrvMonXvmHeader takeXvmHeader()
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    '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 ISrvMonListCommandsResponse
    
    Specified by:
    
    takeXvmHeader in interface ISrvMonXvmResponse
    
    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
```
public final boolean hasXvmHeader()
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Checks for the presence of 'xvmHeader'.
    Field Description
    Details about the message source.
    
    Specified by:
    
    hasXvmHeader in interface ISrvMonListCommandsResponse
    
    Specified by:
    
    hasXvmHeader in interface ISrvMonXvmResponse
    
    Specified by:
    
    hasXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader
    
    See Also:
    ISrvMonListCommandsResponse.getXvmHeader()
  - clearXvmHeader
```
public final void clearXvmHeader()
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Clears the value of 'xvmHeader'.
    Field Description
    Details about the message source.
    
    Specified by:
    
    clearXvmHeader in interface ISrvMonListCommandsResponse
    
    Specified by:
    
    clearXvmHeader in interface ISrvMonXvmResponse
    
    Specified by:
    
    clearXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader
    
    See Also:
    ISrvMonListCommandsResponse.setXvmHeader(SrvMonXvmHeader)
  - getAdminClientIdFieldId
```
public static final int getAdminClientIdFieldId()
```
  - setAdminClientId
```
public final void setAdminClientId(String val)
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Sets the value of 'adminClientId'.
    Field Description
    The admin client targeted in the command exchange.
    
    Specified by:
    
    setAdminClientId in interface ISrvMonListCommandsResponse
    
    Specified by:
    
    setAdminClientId in interface ISrvMonXvmResponse
    
    Parameters:
    val - The value to set.
  - getAdminClientId
```
public final String getAdminClientId()
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Gets the value of 'adminClientId'.
    Field Description
    The admin client targeted in the command exchange.
    
    Specified by:
    
    getAdminClientId in interface ISrvMonListCommandsResponse
    
    Specified by:
    
    getAdminClientId in interface ISrvMonXvmResponse
    
    Returns:
    The admin client targeted in the command exchange
  - lendAdminClientId
```
public final void lendAdminClientId(XString val)
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Lends the value of 'adminClientId' to this object.
    This method is equivalent to setAdminClientId 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 admin client targeted in the command exchange.
    Usage Notes
    Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.
    Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
    
    Specified by:
    
    lendAdminClientId in interface ISrvMonListCommandsResponse
    
    Specified by:
    
    lendAdminClientId in interface ISrvMonXvmResponse
    
    Parameters:
    val - The value to set.
  - setAdminClientIdFrom
```
public final void setAdminClientIdFrom(long val)
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Sets the value of this String field to the given numeric value.
    Field Description
    The admin client targeted in the command exchange.
    NOTE:
    This is the same as calling ISrvMonListCommandsResponse.setAdminClientId(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.
    
    Specified by:
    
    setAdminClientIdFrom in interface ISrvMonListCommandsResponse
    
    Specified by:
    
    setAdminClientIdFrom in interface ISrvMonXvmResponse
  - getAdminClientIdTo
```
public final <T extends XString> T getAdminClientIdTo(XString.Factory<T> factory)
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Copies the value of this String field into a new XString from the given factory.
    Field Description
    The admin client targeted in the command exchange.
    If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);
    This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;
    
    Specified by:
    
    getAdminClientIdTo in interface ISrvMonListCommandsResponse
    
    Specified by:
    
    getAdminClientIdTo in interface ISrvMonXvmResponse
    
    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.
  - setAdminClientIdFrom
```
public final void setAdminClientIdFrom(XString val)
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Copies the provided XString value into this object's 'adminClientId'.
    Field Description
    The admin client targeted in the command exchange.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than ISrvMonListCommandsResponse.setAdminClientId(String) because it avoids encoding the value into a String if the given XString is already encoded.
    
    Specified by:
    
    setAdminClientIdFrom in interface ISrvMonListCommandsResponse
    
    Specified by:
    
    setAdminClientIdFrom in interface ISrvMonXvmResponse
  - getAdminClientIdTo
```
public final void getAdminClientIdTo(XString val)
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Copies the value of 'adminClientId' into the provided XString.
    Field Description
    The admin client targeted in the command exchange.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than ISrvMonListCommandsResponse.getAdminClientId() bec because it can avoid decoding the value into an String.
    
    Specified by:
    
    getAdminClientIdTo in interface ISrvMonListCommandsResponse
    
    Specified by:
    
    getAdminClientIdTo in interface ISrvMonXvmResponse
    
    See Also:
    ISrvMonListCommandsResponse.getAdminClientId()
  - getAdminClientIdUnsafe
```
public final XString getAdminClientIdUnsafe()
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Gets the raw value of 'adminClientId'.
    Field Description
    The admin client targeted in the command exchange.
    NOTE:
    This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.
    However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.
    Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.
    
    Specified by:
    
    getAdminClientIdUnsafe in interface ISrvMonListCommandsResponse
    
    Specified by:
    
    getAdminClientIdUnsafe in interface ISrvMonXvmResponse
    
    Returns:
    the field's raw value
    See Also:
    ISrvMonListCommandsResponse.getAdminClientId()
  - setAdminClientIdFrom
```
public final void setAdminClientIdFrom(com.neeve.xbuf.XbufStringField val)
```
  - getAdminClientIdField
```
public final com.neeve.xbuf.XbufStringField getAdminClientIdField()
```
  - hasAdminClientId
```
public final boolean hasAdminClientId()
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Checks for the presence of 'adminClientId'.
    Field Description
    The admin client targeted in the command exchange.
    
    Specified by:
    
    hasAdminClientId in interface ISrvMonListCommandsResponse
    
    Specified by:
    
    hasAdminClientId in interface ISrvMonXvmResponse
    
    See Also:
    ISrvMonListCommandsResponse.getAdminClientId()
  - clearAdminClientId
```
public final void clearAdminClientId()
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Clears the value of 'adminClientId'.
    Field Description
    The admin client targeted in the command exchange.
    
    Specified by:
    
    clearAdminClientId in interface ISrvMonListCommandsResponse
    
    Specified by:
    
    clearAdminClientId in interface ISrvMonXvmResponse
    
    See Also:
    ISrvMonListCommandsResponse.setAdminClientId(String)
  - getXvmNameFieldId
```
public static final int getXvmNameFieldId()
```
  - setXvmName
```
public final void setXvmName(String val)
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Sets the value of 'xvmName'.
    Field Description
    The name of the XVM targeted in the command exchange.
    
    Specified by:
    
    setXvmName in interface ISrvMonListCommandsResponse
    
    Specified by:
    
    setXvmName in interface ISrvMonXvmResponse
    
    Parameters:
    val - The value to set.
  - getXvmName
```
public final String getXvmName()
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Gets the value of 'xvmName'.
    Field Description
    The name of the XVM targeted in the command exchange.
    
    Specified by:
    
    getXvmName in interface ISrvMonListCommandsResponse
    
    Specified by:
    
    getXvmName in interface ISrvMonXvmResponse
    
    Returns:
    The name of the XVM targeted in the command exchange
  - lendXvmName
```
public final void lendXvmName(XString val)
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Lends the value of 'xvmName' to this object.
    This method is equivalent to setXvmName 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 targeted in the command exchange.
    Usage Notes
    Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.
    Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
    
    Specified by:
    
    lendXvmName in interface ISrvMonListCommandsResponse
    
    Specified by:
    
    lendXvmName in interface ISrvMonXvmResponse
    
    Parameters:
    val - The value to set.
  - setXvmNameFrom
```
public final void setXvmNameFrom(long val)
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Sets the value of this String field to the given numeric value.
    Field Description
    The name of the XVM targeted in the command exchange.
    NOTE:
    This is the same as calling ISrvMonListCommandsResponse.setXvmName(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.
    
    Specified by:
    
    setXvmNameFrom in interface ISrvMonListCommandsResponse
    
    Specified by:
    
    setXvmNameFrom in interface ISrvMonXvmResponse
  - getXvmNameTo
```
public final <T extends XString> T getXvmNameTo(XString.Factory<T> factory)
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Copies the value of this String field into a new XString from the given factory.
    Field Description
    The name of the XVM targeted in the command exchange.
    If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);
    This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;
    
    Specified by:
    
    getXvmNameTo in interface ISrvMonListCommandsResponse
    
    Specified by:
    
    getXvmNameTo in interface ISrvMonXvmResponse
    
    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.
  - setXvmNameFrom
```
public final void setXvmNameFrom(XString val)
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Copies the provided XString value into this object's 'xvmName'.
    Field Description
    The name of the XVM targeted in the command exchange.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than ISrvMonListCommandsResponse.setXvmName(String) because it avoids encoding the value into a String if the given XString is already encoded.
    
    Specified by:
    
    setXvmNameFrom in interface ISrvMonListCommandsResponse
    
    Specified by:
    
    setXvmNameFrom in interface ISrvMonXvmResponse
  - getXvmNameTo
```
public final void getXvmNameTo(XString val)
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Copies the value of 'xvmName' into the provided XString.
    Field Description
    The name of the XVM targeted in the command exchange.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than ISrvMonListCommandsResponse.getXvmName() bec because it can avoid decoding the value into an String.
    
    Specified by:
    
    getXvmNameTo in interface ISrvMonListCommandsResponse
    
    Specified by:
    
    getXvmNameTo in interface ISrvMonXvmResponse
    
    See Also:
    ISrvMonListCommandsResponse.getXvmName()
  - getXvmNameUnsafe
```
public final XString getXvmNameUnsafe()
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Gets the raw value of 'xvmName'.
    Field Description
    The name of the XVM targeted in the command exchange.
    NOTE:
    This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.
    However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.
    Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.
    
    Specified by:
    
    getXvmNameUnsafe in interface ISrvMonListCommandsResponse
    
    Specified by:
    
    getXvmNameUnsafe in interface ISrvMonXvmResponse
    
    Returns:
    the field's raw value
    See Also:
    ISrvMonListCommandsResponse.getXvmName()
  - setXvmNameFrom
```
public final void setXvmNameFrom(com.neeve.xbuf.XbufStringField val)
```
  - getXvmNameField
```
public final com.neeve.xbuf.XbufStringField getXvmNameField()
```
  - hasXvmName
```
public final boolean hasXvmName()
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Checks for the presence of 'xvmName'.
    Field Description
    The name of the XVM targeted in the command exchange.
    
    Specified by:
    
    hasXvmName in interface ISrvMonListCommandsResponse
    
    Specified by:
    
    hasXvmName in interface ISrvMonXvmResponse
    
    See Also:
    ISrvMonListCommandsResponse.getXvmName()
  - clearXvmName
```
public final void clearXvmName()
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Clears the value of 'xvmName'.
    Field Description
    The name of the XVM targeted in the command exchange.
    
    Specified by:
    
    clearXvmName in interface ISrvMonListCommandsResponse
    
    Specified by:
    
    clearXvmName in interface ISrvMonXvmResponse
    
    See Also:
    ISrvMonListCommandsResponse.setXvmName(String)
  - getCommandsFieldId
```
public static final int getCommandsFieldId()
```
  - setCommands
```
public final void setCommands(SrvMonCommandDescription[] val)
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Sets the value of 'commands'.
    
    Specified by:
    
    setCommands in interface ISrvMonListCommandsResponse
    
    Parameters:
    val - The value to set.
  - setCommandsFrom
```
public final void setCommandsFrom(XIterator<SrvMonCommandDescription> val)
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Sets the value of 'commands' 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 'commands' accessor can copy the values without iteration.
    
    NOTE:
    Passing a null or empty list has the same affect as calling ISrvMonListCommandsResponse.setCommands(SrvMonCommandDescription[]) with a value of null.
    
    Specified by:
    
    setCommandsFrom in interface ISrvMonListCommandsResponse
    
    Parameters:
    val - the values to set.
  - lendCommandsFrom
```
public final void lendCommandsFrom(XIterator<SrvMonCommandDescription> val)
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Sets the value of 'commands' 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 'commands' accessor can copy the values without iteration.
    
    NOTE:
    Passing a null or empty list has the same affect as calling ISrvMonListCommandsResponse.setCommands(SrvMonCommandDescription[]) with a value of null.
    
    Specified by:
    
    lendCommandsFrom in interface ISrvMonListCommandsResponse
    
    Parameters:
    val - the values to set.
  - lendCommands
```
public final void lendCommands(SrvMonCommandDescription[] val)
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Lends the value of 'commands'.
    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:
    
    lendCommands in interface ISrvMonListCommandsResponse
    
    Parameters:
    val - the value to 'lend' to lend.
  - addCommands
```
public final void addCommands(SrvMonCommandDescription val)
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Adds the provided value to the list of 'commands' values.
    This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'commands' 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.
    
    Specified by:
    
    addCommands in interface ISrvMonListCommandsResponse
    
    Parameters:
    val - the value to add.
  - lendCommands
```
public final void lendCommands(SrvMonCommandDescription val)
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Adds the provided value to the list of 'commands' 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 'commands' 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.
    
    Specified by:
    
    lendCommands in interface ISrvMonListCommandsResponse
    
    Parameters:
    val - the value to add.
  - getCommands
```
public final SrvMonCommandDescription[] getCommands()
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Gets the value of 'commands'.
    If the field is not set this method will return null.
    
    Specified by:
    
    getCommands in interface ISrvMonListCommandsResponse
    
    Returns:
    The value of 'commands' If the field is not set this method will return null.
  - getCommandsEmptyIfNull
```
public final SrvMonCommandDescription[] getCommandsEmptyIfNull()
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Gets the value of 'commands' or an empty array if the value is null or not set.
    
    Specified by:
    
    getCommandsEmptyIfNull in interface ISrvMonListCommandsResponse
    
    Returns:
    The value of 'commands' or an empty array if null if not set.
    See Also:
    ISrvMonListCommandsResponse.getCommands()
  - getCommandsIterator
```
public final XIterator<SrvMonCommandDescription> getCommandsIterator()
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Gets the value of 'commands' 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.
    
    Specified by:
    
    getCommandsIterator in interface ISrvMonListCommandsResponse
    
    Returns:
    An iterator containing this field values.
  - takeCommands
```
public final SrvMonCommandDescription[] takeCommands()
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Takes the value of 'commands'.
    NOTE:
    A nested entity reference returned by ISrvMonListCommandsResponse.getCommands() 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:
    
    takeCommands in interface ISrvMonListCommandsResponse
    
    Returns:
    a 'taken' reference to the field or null if the field is not set.
  - clearCommands
```
public final void clearCommands()
```
    Description copied from interface: ISrvMonListCommandsResponse
    
    Clears the value of 'commands'.
    
    Specified by:
    
    clearCommands in interface ISrvMonListCommandsResponse
    
    See Also:
    ISrvMonListCommandsResponse.setCommands(SrvMonCommandDescription[])
  - isDirty
```
public final boolean isDirty()
```
  - createSchema
```
public static final com.neeve.xbuf.XbufSchema createSchema()
```
  - serializeToByteArray
```
public final byte[] serializeToByteArray()
```
    Description copied from interface: MessageView
    
    Serialize a view's backing message to a byte array.
    
    Specified by:
    
    serializeToByteArray in interface MessageView
  - serializeToByteBuffer
```
public final ByteBuffer serializeToByteBuffer()
```
    Description copied from interface: MessageView
    
    Serialize a view's backing message to a byte buffer.
    
    Specified by:
    
    serializeToByteBuffer in interface MessageView
  - serializeToIOBuffer
```
public final com.neeve.io.IOBuffer serializeToIOBuffer(boolean useNative)
```
    Description copied from interface: MessageView
    
    Serializes the MessageView to an IOBuffer.
    Ownership of the returned IOBuffer is given to the caller which should dispose of it when done.
    The buffer backing the IOBuffer should be flipped (ready for read) upon return.
    
    Specified by:
    
    serializeToIOBuffer in interface MessageView
    
    Overrides:
    
    serializeToIOBuffer in class MessageViewImpl
    
    Parameters:
    useNative - Whether the returned buffer should be native.
    
    Returns:
    The MessageView serialized to an IOBuffer.
  - serializeToPacket
```
public final PktPacket serializeToPacket()
```
    Description copied from interface: MessageView
    
    Serialize a view's backing message to a packet.
    
    Specified by:
    
    serializeToPacket in interface MessageView
  - deserializeFromByteArray
```
public final SrvMonListCommandsResponse deserializeFromByteArray(byte[] array)
```
    Description copied from interface: MessageView
    
    Deserialize a view's backing message from a byte array.
    
    Specified by:
    
    deserializeFromByteArray in interface MessageView
    
    Parameters:
    array - The view's backing message serialized as a byte array.
  - deserializeFromByteBuffer
```
public final SrvMonListCommandsResponse deserializeFromByteBuffer(ByteBuffer buffer)
```
    Description copied from interface: MessageView
    
    Deserialize a view's backing message from a byte buffer.
    
    Specified by:
    
    deserializeFromByteBuffer in interface MessageView
    
    Parameters:
    buffer - The view's backing message serialized as a byte buffer.
  - deserializeFromPacket
```
public final SrvMonListCommandsResponse deserializeFromPacket(PktPacket packet)
```
    Description copied from interface: MessageView
    
    Deserialize a view's backing message from a packet.
    
    Specified by:
    
    deserializeFromPacket in interface MessageView
    
    Parameters:
    packet - The view's backing message serialized as a packet.
  - sync
```
public final void sync()
```
    Description copied from interface: MessageView
    
    Ensure a view's backing message is prepared and ready for transport
    
    Specified by:
    
    sync in interface MessageView
  - copy
```
public final SrvMonListCommandsResponse copy()
```
    Creates a copy of this SrvMonListCommandsResponse.
    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 SrvMonListCommandsResponse's embedded entity fields.
    The returned copy will be writeable even if this SrvMonListCommandsResponse is read only.
    No metadata is copied except as documented IRogCopyableNode. See IRogCopyableNode for more detailed information on the semantics of this method.
    
    Xbuf Pass-through Fields
    When backed by a buffer, this operation copies the underlying buffer which means that if the message was deserialized from with unrecognized fields, such fields will be preserved in the copy as well.
    
    Specified by:
    
    copy in interface IRogCopyableNode<ISrvMonListCommandsResponse>
    
    Specified by:
    
    copy in interface ISrvMonListCommandsResponse
    
    Specified by:
    
    copy in interface CopyableMessageView<ISrvMonListCommandsResponse>
    
    Returns:
    A copy of this SrvMonListCommandsResponse.
    See Also:
    IRogCopyableNode, CopyableMessageView
  - copyInto
```
public final void copyInto(SrvMonListCommandsResponse copy)
```
    Copies the contents of this SrvMonListCommandsResponse 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 SrvMonListCommandsResponse's embedded entity fields.
    The returned copy will be writeable even if this SrvMonListCommandsResponse is read only.
    No metadata is copied except as documented IRogCopyableNode. See IRogCopyableNode for more detailed information on the semantics of this method.
    
    Xbuf Pass-through Fields
    When backed by a buffer, this operation copies the underlying buffer which means that if the message was deserialized from with unrecognized fields, such fields will be preserved in the copy as well.
    
    Specified by:
    
    copyInto in interface ISrvMonListCommandsResponse
    
    Parameters:
    copy - The target to copy into which must not be null or read only.
  - desync
```
public final int desync(PktBuffer buffer,
         int pos,
         boolean frameOnly)
```
    Description copied from interface: com.neeve.xbuf.IXbufDesyncer
    
    Desync fields from a buffer
    
    Specified by:
    
    desync in interface com.neeve.xbuf.IXbufDesyncer
    
    Parameters:
    buffer - The buffer to desync from
    pos - The position in the container's backing buffer to desync from
    frameOnly - Whether to frame the field on the underlying buffer. See XbufField.desync(PktBuffer, int, boolean) for more information
  - needsSync
```
public boolean needsSync()
```
    Description copied from interface: MessageReflector
    
    Check if a view needs to be sync'd for reflection.
    
    Specified by:
    
    needsSync in interface MessageReflector
  - fieldExists
```
public final boolean fieldExists(Object message,
                  String name)
```
    Description copied from interface: MessageReflector
    
    Check if a field of the supplied name exists in a message.
    
    Specified by:
    
    fieldExists in interface MessageReflector
    
    Parameters:
    message - The message to check in.
    name - The field to check for.
  - isFieldReflectable
```
public final boolean isFieldReflectable(Object message,
                         String name)
```
    Description copied from interface: MessageReflector
    
    Check if a field of the supplied name is reflectable.
    
    Specified by:
    
    isFieldReflectable in interface MessageReflector
    
    Parameters:
    message - The message to check in.
    name - The field to check for.
    
    Returns:
    Returns null if a field of the supplied name is either not present in the message or is of a type that makes it non-reflectable.
  - getFieldValueAsString
```
public final String getFieldValueAsString(Object message,
                           String name)
```
    Description copied from interface: MessageReflector
    
    Get the value of a reflectable field in a message as a string.
    Note that this method is generally less efficient than its variant MessageReflector.getFieldValueAsString(Object, String[]) since this method requires splitting the supplied path name into its dot separated path components. In cases where the caller intends to reuse the same path name often, it is better for the caller to supply it in split form.
    
    Specified by:
    
    getFieldValueAsString in interface MessageReflector
    
    Parameters:
    message - The message to introspect.
    name - The field whose value is to be retrieved specified as a bean path
    
    Returns:
    Returns null if a field of the supplied name is not in the message or the field is of a type that is not reflectable or the field value is null. The caller should differentiate between these various cases through the use of the MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methods
  - getFieldValueAsString
```
public final String getFieldValueAsString(Object message,
                           String[] pathComponents)
```
    Description copied from interface: MessageReflector
    
    Get the value of a reflectable field in a message as a string.
    
    Specified by:
    
    getFieldValueAsString in interface MessageReflector
    
    Parameters:
    message - The message to introspect.
    pathComponents - The path components to use to access the field.
    
    Returns:
    Returns null if a field of the supplied pathComponents is not in the message or the field is of a type that is not reflectable or the field value is null. The caller should differentiate between these various cases through the use of the MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methods
  - getFieldValueAsRawString
```
public final XString getFieldValueAsRawString(Object message,
                               String name)
```
    Description copied from interface: MessageReflector
    
    Get the value of a reflectable field in a message as a string.
    Note that this method is generally less efficient than its variant MessageReflector.getFieldValueAsString(Object, String[]) since this method requires splitting the supplied path name into its dot separated path components. In cases where the caller intends to reuse the same path name often, it is better for the caller to supply it in split form.
    
    Specified by:
    
    getFieldValueAsRawString in interface MessageReflector
    
    Parameters:
    message - The message to introspect.
    name - The field whose value is to be retrieved specified as a bean path
    
    Returns:
    Returns null if a field of the supplied name is not in the message or the field is of a type that is not reflectable or the field value is null. The caller should differentiate between these various cases through the use of the MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methods
  - getFieldValueAsRawString
```
public final XString getFieldValueAsRawString(Object message,
                               String[] pathComponents)
```
    Description copied from interface: MessageReflector
    
    Get the value of a reflectable field in a message as a string.
    
    Specified by:
    
    getFieldValueAsRawString in interface MessageReflector
    
    Parameters:
    message - The message to introspect.
    pathComponents - The path components to use to access the field.
    
    Returns:
    Returns null if a field of the supplied pathComponents is not in the message or the field is of a type that is not reflectable or the field value is null. The caller should differentiate between these various cases through the use of the MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methods
  - appendFieldValueTo
```
public final boolean appendFieldValueTo(Object message,
                         String name,
                         XString target)
```
    Description copied from class: com.neeve.rog.impl.RogNode
    
    Appends a reflected field value as a string into the given XString.
    If this node has a non-null messageReflector as returned by RogNode.getMessageReflector(), then this method will use that reflector to append the value of the field provided by it if the field is reflectable and not null.
    
    Specified by:
    
    appendFieldValueTo in interface MessageReflector
    
    Overrides:
    
    appendFieldValueTo in class com.neeve.rog.impl.RogNode
    
    Parameters:
    message - the node on which to reflect (which need not be this object).
    name - the bean path to the field on the provided object.
    target - The target XString into which to append the result.
    
    Returns:
    true if the field was reflectable and had a value which could be appended, false otherwise.
  - appendFieldValueTo
```
public final boolean appendFieldValueTo(Object node,
                         String[] pathComponents,
                         XString target)
```
    Description copied from class: com.neeve.rog.impl.RogNode
    
    Appends a reflected field value as a string into the given XString.
    If this node has a non-null messageReflector as returned by RogNode.getMessageReflector(), then this method will use that reflector to append the value of the field provided by it if the field is reflectable and not null.
    
    Specified by:
    
    appendFieldValueTo in interface MessageReflector
    
    Overrides:
    
    appendFieldValueTo in class com.neeve.rog.impl.RogNode
    
    Parameters:
    node - the node on which to reflect (which need not be this object).
    pathComponents - the bean path to the field on the provided object split by its '.' separated components. .
    target - The target XString into which to append the result.
    
    Returns:
    true if the field was reflectable and had a value which could be appended, false otherwise.
  - getContentEncodingType
```
public final IStoreObject.EncodingType getContentEncodingType()
```
    Description copied from interface: IStoreObject
    
    Get an object's content data encoding type.
    
    Specified by:
    
    getContentEncodingType in interface IStoreObject
  - serialize
```
public final PktPacket serialize()
```
    Description copied from interface: IStoreObject
    
    Serialize an object's data.
    
    Specified by:
    
    serialize in interface IStoreObject
  - deserialize
```
public final SrvMonListCommandsResponse deserialize(PktPacket packet)
```
    Description copied from interface: IStoreObject
    
    Deserialize an object's data.
    
    Specified by:
    
    deserialize in interface IStoreObject
    
    Parameters:
    packet - The object in serialized form.
    
    Returns:
    Returns 'this' object for invocation chaining.
  - setFieldValue
```
public final IStoreObject setFieldValue(int id,
                         Object val)
```
  - toJsonString
```
public final String toJsonString(boolean includeMetadata,
                  String metadataObjectName,
                  String payloadObjectName)
```
    Description copied from interface: IRogJsonizable
    
    Get a full JSON representation of an ROG entity
    
    Specified by:
    
    toJsonString in interface IRogJsonizable
    
    Parameters:
    includeMetadata - Specify this parameter for the ROG entity metadata to also be included in the JSON output. If included, the entire ROG entity object is treated as a composite object containing a nested metadata object and a nested data object. The next two parameters metadataObjectName and dataObjectName specify the names of the nested objects as they will appear in the output JSON string.
    metadataObjectName - The name of the nested metadata object as it will appear in the output JSON string. A value of null will default to using 'metadata' as the nested object name.
    payloadObjectName - The name of the nested data object as it will appear in the output JSON string. A value of null will default to using 'data' as the nested object name.
  - toJsonString
```
public final String toJsonString()
```
    Description copied from interface: IRogJsonizable
    
    Get a JSON representation of an ROG entity
    
    Specified by:
    
    toJsonString in interface IRogJsonizable
  - toString
```
public final String toString()
```
    Description copied from class: com.neeve.rog.impl.RogNode
    
    Return a string representation of an ROG node.
    
    Overrides:
    
    toString in class com.neeve.rog.impl.RogNode

Class SrvMonListCommandsResponse

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

Field Summary

Fields inherited from class com.neeve.rog.impl.RogNode

Fields inherited from class com.neeve.util.UtlListElement

Method Summary

Methods inherited from class com.neeve.rog.impl.RogNode

Methods inherited from class com.neeve.sma.MessageViewImpl

Methods inherited from class com.neeve.util.UtlListElement

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_ARRAY

Method Detail

create

create

createFromXbufContainerPacket

createFromSerializedXbufContainerPacket

createFromSerializedXbufContainerPacket

createFromSerializedXbufContainer

createFromSerializedXbufContainer

createFromRawJson

createFromJson

createFrom

createFrom

setDesyncPolicy

getDesyncPolicy

setFieldInterest

clearContent

syncFieldBitmask

desyncFieldBitmask

getBackingBuffer

optimizeFor

getPacket

serializeToProtobuf

serializeToRawJson

serializeToJson

deserializeFromProtobuf

deserializeFromRawJson

deserializeFromJson

setAsReadOnly

dispose

undispose

setPreserializedFields

getXRogTypeFieldId

setXRogType

getXRogType

setXRogTypeFrom

getXRogTypeField

hasXRogType

clearXRogType

getCorrelationIdFieldId

setCorrelationId

Field Description

getCorrelationId

Field Description

setCorrelationIdFrom

getCorrelationIdField

hasCorrelationId

Field Description

clearCorrelationId

Field Description

getXvmHeaderFieldId

setXvmHeader

Field Description

lendXvmHeader

Field Description

getXvmHeader

Field Description

getXvmHeaderTo

takeXvmHeader

Field Description

hasXvmHeader