SrvMonListCommandsRequest (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.SrvMonListCommandsRequest

All Implemented Interfaces:: com.neeve.link.ILnkMessage, IStoreObject, IStoreObjectMetadata, IRogCopyableNode<ISrvMonListCommandsRequest>, IRogJsonizable, IRogMessage, IRogMetadata, IRogNode, IRogValidatable, ISrvMonListCommandsRequest, ISrvMonXvmRequest, CopyableMessageView<ISrvMonListCommandsRequest>, 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=1)
public final class SrvMonListCommandsRequest
extends com.neeve.rog.impl.RogNode
implements ISrvMonListCommandsRequest, com.neeve.link.ILnkMessage, MessageReflector, com.neeve.xbuf.IXbufDesyncer, IRogJsonizable

Requests a List of Commands for an application.

ADM Details

ADM Type	Message
Factory	SrvMonCncFactory

ADM Field Summary

Field	Type	Id	Description
adminClientCompatLevel	String	219	The admin client's compatibility level.
adminClientId	String	216	The admin client targeted in the command exchange.
correlationId	Long	217	The request correlation ID.
entity	String	16	The app or entity for which to list commands.
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`	`SrvMonListCommandsRequest.PacketBody` The backing packet type for SrvMonListCommandsRequest (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 SrvMonListCommandsRequest[] 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 SrvMonListCommandsRequest[]`	`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
`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`	`clearAdminClientCompatLevel()` Clears the value of 'adminClientCompatLevel'.
`void`	`clearAdminClientId()` Clears the value of 'adminClientId'.
`void`	`clearContent()`
`void`	`clearCorrelationId()` Clears the value of 'correlationId'.
`void`	`clearEntity()` Clears the value of 'entity'.
`void`	`clearXRogType()`
`void`	`clearXvmName()` Clears the value of 'xvmName'.
`SrvMonListCommandsRequest`	`copy()` Creates a copy of this SrvMonListCommandsRequest.
`void`	`copyInto(SrvMonListCommandsRequest copy)` Copies the contents of this SrvMonListCommandsRequest into the target.
`static SrvMonListCommandsRequest`	`create()`
`static SrvMonListCommandsRequest`	`create(com.eaio.uuid.UUID id)`
`static SrvMonListCommandsRequest`	`createFrom(byte[] serializedContainer)`
`static SrvMonListCommandsRequest`	`createFrom(ByteBuffer serializedContainer)`
`static SrvMonListCommandsRequest`	`createFromJson(String json)`
`static SrvMonListCommandsRequest`	`createFromRawJson(String json)`
`static SrvMonListCommandsRequest`	`createFromSerializedXbufContainer(byte[] serializedContainer)`
`static SrvMonListCommandsRequest`	`createFromSerializedXbufContainer(ByteBuffer serializedContainer)`
`static SrvMonListCommandsRequest`	`createFromSerializedXbufContainerPacket(byte[] serializedPacket)`
`static SrvMonListCommandsRequest`	`createFromSerializedXbufContainerPacket(ByteBuffer serializedPacket)`
`static SrvMonListCommandsRequest`	`createFromXbufContainerPacket(PktPacket packet)`
`static com.neeve.xbuf.XbufSchema`	`createSchema()`
`SrvMonListCommandsRequest`	`deserialize(PktPacket packet)` Deserialize an object's data.
`SrvMonListCommandsRequest`	`deserializeFromByteArray(byte[] array)` Deserialize a view's backing message from a byte array.
`SrvMonListCommandsRequest`	`deserializeFromByteBuffer(ByteBuffer buffer)` Deserialize a view's backing message from a byte buffer.
`SrvMonListCommandsRequest`	`deserializeFromJson(String json)` Deserialize a view's backing message from a json string
`SrvMonListCommandsRequest`	`deserializeFromPacket(PktPacket packet)` Deserialize a view's backing message from a packet.
`SrvMonListCommandsRequest`	`deserializeFromProtobuf(com.google.protobuf.Message message)` Deserialize a node's data from a protobuf message.
`SrvMonListCommandsRequest`	`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`	`getAdminClientCompatLevel()` Gets the value of 'adminClientCompatLevel'.
`com.neeve.xbuf.XbufStringField`	`getAdminClientCompatLevelField()`
`static int`	`getAdminClientCompatLevelFieldId()`
`<T extends XString> T`	`getAdminClientCompatLevelTo(XString.Factory<T> factory)` Copies the value of this String field into a new XString from the given factory.
`void`	`getAdminClientCompatLevelTo(XString val)` Copies the value of 'adminClientCompatLevel' into the provided XString.
`XString`	`getAdminClientCompatLevelUnsafe()` Gets the raw value of 'adminClientCompatLevel'.
`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()`
`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()`
`String`	`getEntity()` Gets the value of 'entity'.
`com.neeve.xbuf.XbufStringField`	`getEntityField()`
`static int`	`getEntityFieldId()`
`<T extends XString> T`	`getEntityTo(XString.Factory<T> factory)` Copies the value of this String field into a new XString from the given factory.
`void`	`getEntityTo(XString val)` Copies the value of 'entity' into the provided XString.
`XString`	`getEntityUnsafe()` Gets the raw value of 'entity'.
`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()`
`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`	`hasAdminClientCompatLevel()` Checks for the presence of 'adminClientCompatLevel'.
`boolean`	`hasAdminClientId()` Checks for the presence of 'adminClientId'.
`boolean`	`hasCorrelationId()` Checks for the presence of 'correlationId'.
`boolean`	`hasEntity()` Checks for the presence of 'entity'.
`boolean`	`hasXRogType()`
`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`	`lendAdminClientCompatLevel(XString val)` Lends the value of 'adminClientCompatLevel' to this object.
`void`	`lendAdminClientId(XString val)` Lends the value of 'adminClientId' to this object.
`void`	`lendEntity(XString val)` Lends the value of 'entity' to this object.
`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`	`setAdminClientCompatLevel(String val)` Sets the value of 'adminClientCompatLevel'.
`void`	`setAdminClientCompatLevelFrom(long val)` Sets the value of this String field to the given numeric value.
`void`	`setAdminClientCompatLevelFrom(com.neeve.xbuf.XbufStringField val)`
`void`	`setAdminClientCompatLevelFrom(XString val)` Copies the provided XString value into this object's 'adminClientCompatLevel'.
`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`	`setCorrelationId(long val)` Sets the value of 'correlationId'.
`void`	`setCorrelationIdFrom(com.neeve.xbuf.XbufVariableLongField val)`
`static void`	`setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)`
`void`	`setEntity(String val)` Sets the value of 'entity'.
`void`	`setEntityFrom(long val)` Sets the value of this String field to the given numeric value.
`void`	`setEntityFrom(com.neeve.xbuf.XbufStringField val)`
`void`	`setEntityFrom(XString val)` Copies the provided XString value into this object's 'entity'.
`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`	`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()`
`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

Methods inherited from interface com.neeve.rog.IRogValidatable
getValidationErrors, isValid

- Field Detail
  - EMPTY_ARRAY
```
public static final SrvMonListCommandsRequest[] EMPTY_ARRAY
```
    A preallocated empty array used to avoid garbage when returning empty arrays of this type.
- Method Detail
  - create
```
public static SrvMonListCommandsRequest create()
```
  - create
```
public static SrvMonListCommandsRequest create(com.eaio.uuid.UUID id)
```
  - createFromXbufContainerPacket
```
public static SrvMonListCommandsRequest createFromXbufContainerPacket(PktPacket packet)
```
  - createFromSerializedXbufContainerPacket
```
public static SrvMonListCommandsRequest createFromSerializedXbufContainerPacket(ByteBuffer serializedPacket)
```
  - createFromSerializedXbufContainerPacket
```
public static SrvMonListCommandsRequest createFromSerializedXbufContainerPacket(byte[] serializedPacket)
```
  - createFromSerializedXbufContainer
```
public static SrvMonListCommandsRequest createFromSerializedXbufContainer(ByteBuffer serializedContainer)
```
  - createFromSerializedXbufContainer
```
public static SrvMonListCommandsRequest createFromSerializedXbufContainer(byte[] serializedContainer)
```
  - createFromRawJson
```
public static SrvMonListCommandsRequest createFromRawJson(String json)
```
  - createFromJson
```
public static SrvMonListCommandsRequest createFromJson(String json)
```
  - createFrom
```
public static SrvMonListCommandsRequest createFrom(ByteBuffer serializedContainer)
```
  - createFrom
```
public static SrvMonListCommandsRequest 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 SrvMonListCommandsRequest 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 SrvMonListCommandsRequest deserializeFromRawJson(String json)
```
  - deserializeFromJson
```
public final SrvMonListCommandsRequest 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: ISrvMonListCommandsRequest
    
    Sets the value of 'correlationId'.
    Field Description
    The request correlation ID.
    
    Specified by:
    
    setCorrelationId in interface ISrvMonListCommandsRequest
    
    Specified by:
    
    setCorrelationId in interface ISrvMonXvmRequest
    
    Parameters:
    val - The value to set.
  - getCorrelationId
```
public final long getCorrelationId()
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    Gets the value of 'correlationId'.
    Field Description
    The request correlation ID.
    
    Specified by:
    
    getCorrelationId in interface ISrvMonListCommandsRequest
    
    Specified by:
    
    getCorrelationId in interface ISrvMonXvmRequest
    
    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: ISrvMonListCommandsRequest
    
    Checks for the presence of 'correlationId'.
    Field Description
    The request correlation ID.
    
    Specified by:
    
    hasCorrelationId in interface ISrvMonListCommandsRequest
    
    Specified by:
    
    hasCorrelationId in interface ISrvMonXvmRequest
    
    See Also:
    ISrvMonListCommandsRequest.getCorrelationId()
  - clearCorrelationId
```
public final void clearCorrelationId()
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    Clears the value of 'correlationId'.
    Field Description
    The request correlation ID.
    
    Specified by:
    
    clearCorrelationId in interface ISrvMonListCommandsRequest
    
    Specified by:
    
    clearCorrelationId in interface ISrvMonXvmRequest
    
    See Also:
    ISrvMonListCommandsRequest.setCorrelationId(long)
  - getAdminClientIdFieldId
```
public static final int getAdminClientIdFieldId()
```
  - setAdminClientId
```
public final void setAdminClientId(String val)
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    Sets the value of 'adminClientId'.
    Field Description
    The admin client targeted in the command exchange.
    
    Specified by:
    
    setAdminClientId in interface ISrvMonListCommandsRequest
    
    Specified by:
    
    setAdminClientId in interface ISrvMonXvmRequest
    
    Parameters:
    val - The value to set.
  - getAdminClientId
```
public final String getAdminClientId()
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    Gets the value of 'adminClientId'.
    Field Description
    The admin client targeted in the command exchange.
    
    Specified by:
    
    getAdminClientId in interface ISrvMonListCommandsRequest
    
    Specified by:
    
    getAdminClientId in interface ISrvMonXvmRequest
    
    Returns:
    The admin client targeted in the command exchange
  - lendAdminClientId
```
public final void lendAdminClientId(XString val)
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    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 ISrvMonListCommandsRequest
    
    Specified by:
    
    lendAdminClientId in interface ISrvMonXvmRequest
    
    Parameters:
    val - The value to set.
  - setAdminClientIdFrom
```
public final void setAdminClientIdFrom(long val)
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    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 ISrvMonListCommandsRequest.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 ISrvMonListCommandsRequest
    
    Specified by:
    
    setAdminClientIdFrom in interface ISrvMonXvmRequest
  - getAdminClientIdTo
```
public final <T extends XString> T getAdminClientIdTo(XString.Factory<T> factory)
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    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 ISrvMonListCommandsRequest
    
    Specified by:
    
    getAdminClientIdTo in interface ISrvMonXvmRequest
    
    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: ISrvMonListCommandsRequest
    
    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 ISrvMonListCommandsRequest.setAdminClientId(String) because it avoids encoding the value into a String if the given XString is already encoded.
    
    Specified by:
    
    setAdminClientIdFrom in interface ISrvMonListCommandsRequest
    
    Specified by:
    
    setAdminClientIdFrom in interface ISrvMonXvmRequest
  - getAdminClientIdTo
```
public final void getAdminClientIdTo(XString val)
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    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 ISrvMonListCommandsRequest.getAdminClientId() bec because it can avoid decoding the value into an String.
    
    Specified by:
    
    getAdminClientIdTo in interface ISrvMonListCommandsRequest
    
    Specified by:
    
    getAdminClientIdTo in interface ISrvMonXvmRequest
    
    See Also:
    ISrvMonListCommandsRequest.getAdminClientId()
  - getAdminClientIdUnsafe
```
public final XString getAdminClientIdUnsafe()
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    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 ISrvMonListCommandsRequest
    
    Specified by:
    
    getAdminClientIdUnsafe in interface ISrvMonXvmRequest
    
    Returns:
    the field's raw value
    See Also:
    ISrvMonListCommandsRequest.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: ISrvMonListCommandsRequest
    
    Checks for the presence of 'adminClientId'.
    Field Description
    The admin client targeted in the command exchange.
    
    Specified by:
    
    hasAdminClientId in interface ISrvMonListCommandsRequest
    
    Specified by:
    
    hasAdminClientId in interface ISrvMonXvmRequest
    
    See Also:
    ISrvMonListCommandsRequest.getAdminClientId()
  - clearAdminClientId
```
public final void clearAdminClientId()
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    Clears the value of 'adminClientId'.
    Field Description
    The admin client targeted in the command exchange.
    
    Specified by:
    
    clearAdminClientId in interface ISrvMonListCommandsRequest
    
    Specified by:
    
    clearAdminClientId in interface ISrvMonXvmRequest
    
    See Also:
    ISrvMonListCommandsRequest.setAdminClientId(String)
  - getXvmNameFieldId
```
public static final int getXvmNameFieldId()
```
  - setXvmName
```
public final void setXvmName(String val)
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    Sets the value of 'xvmName'.
    Field Description
    The name of the XVM targeted in the command exchange.
    
    Specified by:
    
    setXvmName in interface ISrvMonListCommandsRequest
    
    Specified by:
    
    setXvmName in interface ISrvMonXvmRequest
    
    Parameters:
    val - The value to set.
  - getXvmName
```
public final String getXvmName()
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    Gets the value of 'xvmName'.
    Field Description
    The name of the XVM targeted in the command exchange.
    
    Specified by:
    
    getXvmName in interface ISrvMonListCommandsRequest
    
    Specified by:
    
    getXvmName in interface ISrvMonXvmRequest
    
    Returns:
    The name of the XVM targeted in the command exchange
  - lendXvmName
```
public final void lendXvmName(XString val)
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    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 ISrvMonListCommandsRequest
    
    Specified by:
    
    lendXvmName in interface ISrvMonXvmRequest
    
    Parameters:
    val - The value to set.
  - setXvmNameFrom
```
public final void setXvmNameFrom(long val)
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    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 ISrvMonListCommandsRequest.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 ISrvMonListCommandsRequest
    
    Specified by:
    
    setXvmNameFrom in interface ISrvMonXvmRequest
  - getXvmNameTo
```
public final <T extends XString> T getXvmNameTo(XString.Factory<T> factory)
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    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 ISrvMonListCommandsRequest
    
    Specified by:
    
    getXvmNameTo in interface ISrvMonXvmRequest
    
    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: ISrvMonListCommandsRequest
    
    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 ISrvMonListCommandsRequest.setXvmName(String) because it avoids encoding the value into a String if the given XString is already encoded.
    
    Specified by:
    
    setXvmNameFrom in interface ISrvMonListCommandsRequest
    
    Specified by:
    
    setXvmNameFrom in interface ISrvMonXvmRequest
  - getXvmNameTo
```
public final void getXvmNameTo(XString val)
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    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 ISrvMonListCommandsRequest.getXvmName() bec because it can avoid decoding the value into an String.
    
    Specified by:
    
    getXvmNameTo in interface ISrvMonListCommandsRequest
    
    Specified by:
    
    getXvmNameTo in interface ISrvMonXvmRequest
    
    See Also:
    ISrvMonListCommandsRequest.getXvmName()
  - getXvmNameUnsafe
```
public final XString getXvmNameUnsafe()
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    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 ISrvMonListCommandsRequest
    
    Specified by:
    
    getXvmNameUnsafe in interface ISrvMonXvmRequest
    
    Returns:
    the field's raw value
    See Also:
    ISrvMonListCommandsRequest.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: ISrvMonListCommandsRequest
    
    Checks for the presence of 'xvmName'.
    Field Description
    The name of the XVM targeted in the command exchange.
    
    Specified by:
    
    hasXvmName in interface ISrvMonListCommandsRequest
    
    Specified by:
    
    hasXvmName in interface ISrvMonXvmRequest
    
    See Also:
    ISrvMonListCommandsRequest.getXvmName()
  - clearXvmName
```
public final void clearXvmName()
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    Clears the value of 'xvmName'.
    Field Description
    The name of the XVM targeted in the command exchange.
    
    Specified by:
    
    clearXvmName in interface ISrvMonListCommandsRequest
    
    Specified by:
    
    clearXvmName in interface ISrvMonXvmRequest
    
    See Also:
    ISrvMonListCommandsRequest.setXvmName(String)
  - getAdminClientCompatLevelFieldId
```
public static final int getAdminClientCompatLevelFieldId()
```
  - setAdminClientCompatLevel
```
public final void setAdminClientCompatLevel(String val)
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    Sets the value of 'adminClientCompatLevel'.
    Field Description
    The admin client's compatibility level.
    
    Specified by:
    
    setAdminClientCompatLevel in interface ISrvMonListCommandsRequest
    
    Specified by:
    
    setAdminClientCompatLevel in interface ISrvMonXvmRequest
    
    Parameters:
    val - The value to set.
  - getAdminClientCompatLevel
```
public final String getAdminClientCompatLevel()
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    Gets the value of 'adminClientCompatLevel'.
    Field Description
    The admin client's compatibility level.
    
    Specified by:
    
    getAdminClientCompatLevel in interface ISrvMonListCommandsRequest
    
    Specified by:
    
    getAdminClientCompatLevel in interface ISrvMonXvmRequest
    
    Returns:
    The admin client's compatibility level
  - lendAdminClientCompatLevel
```
public final void lendAdminClientCompatLevel(XString val)
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    Lends the value of 'adminClientCompatLevel' to this object.
    This method is equivalent to setAdminClientCompatLevel 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's compatibility level.
    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:
    
    lendAdminClientCompatLevel in interface ISrvMonListCommandsRequest
    
    Specified by:
    
    lendAdminClientCompatLevel in interface ISrvMonXvmRequest
    
    Parameters:
    val - The value to set.
  - setAdminClientCompatLevelFrom
```
public final void setAdminClientCompatLevelFrom(long val)
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    Sets the value of this String field to the given numeric value.
    Field Description
    The admin client's compatibility level.
    NOTE:
    This is the same as calling ISrvMonListCommandsRequest.setAdminClientCompatLevel(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.
    
    Specified by:
    
    setAdminClientCompatLevelFrom in interface ISrvMonListCommandsRequest
    
    Specified by:
    
    setAdminClientCompatLevelFrom in interface ISrvMonXvmRequest
  - getAdminClientCompatLevelTo
```
public final <T extends XString> T getAdminClientCompatLevelTo(XString.Factory<T> factory)
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    Copies the value of this String field into a new XString from the given factory.
    Field Description
    The admin client's compatibility level.
    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:
    
    getAdminClientCompatLevelTo in interface ISrvMonListCommandsRequest
    
    Specified by:
    
    getAdminClientCompatLevelTo in interface ISrvMonXvmRequest
    
    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.
  - setAdminClientCompatLevelFrom
```
public final void setAdminClientCompatLevelFrom(XString val)
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    Copies the provided XString value into this object's 'adminClientCompatLevel'.
    Field Description
    The admin client's compatibility level.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than ISrvMonListCommandsRequest.setAdminClientCompatLevel(String) because it avoids encoding the value into a String if the given XString is already encoded.
    
    Specified by:
    
    setAdminClientCompatLevelFrom in interface ISrvMonListCommandsRequest
    
    Specified by:
    
    setAdminClientCompatLevelFrom in interface ISrvMonXvmRequest
  - getAdminClientCompatLevelTo
```
public final void getAdminClientCompatLevelTo(XString val)
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    Copies the value of 'adminClientCompatLevel' into the provided XString.
    Field Description
    The admin client's compatibility level.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than ISrvMonListCommandsRequest.getAdminClientCompatLevel() bec because it can avoid decoding the value into an String.
    
    Specified by:
    
    getAdminClientCompatLevelTo in interface ISrvMonListCommandsRequest
    
    Specified by:
    
    getAdminClientCompatLevelTo in interface ISrvMonXvmRequest
    
    See Also:
    ISrvMonListCommandsRequest.getAdminClientCompatLevel()
  - getAdminClientCompatLevelUnsafe
```
public final XString getAdminClientCompatLevelUnsafe()
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    Gets the raw value of 'adminClientCompatLevel'.
    Field Description
    The admin client's compatibility level.
    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:
    
    getAdminClientCompatLevelUnsafe in interface ISrvMonListCommandsRequest
    
    Specified by:
    
    getAdminClientCompatLevelUnsafe in interface ISrvMonXvmRequest
    
    Returns:
    the field's raw value
    See Also:
    ISrvMonListCommandsRequest.getAdminClientCompatLevel()
  - setAdminClientCompatLevelFrom
```
public final void setAdminClientCompatLevelFrom(com.neeve.xbuf.XbufStringField val)
```
  - getAdminClientCompatLevelField
```
public final com.neeve.xbuf.XbufStringField getAdminClientCompatLevelField()
```
  - hasAdminClientCompatLevel
```
public final boolean hasAdminClientCompatLevel()
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    Checks for the presence of 'adminClientCompatLevel'.
    Field Description
    The admin client's compatibility level.
    
    Specified by:
    
    hasAdminClientCompatLevel in interface ISrvMonListCommandsRequest
    
    Specified by:
    
    hasAdminClientCompatLevel in interface ISrvMonXvmRequest
    
    See Also:
    ISrvMonListCommandsRequest.getAdminClientCompatLevel()
  - clearAdminClientCompatLevel
```
public final void clearAdminClientCompatLevel()
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    Clears the value of 'adminClientCompatLevel'.
    Field Description
    The admin client's compatibility level.
    
    Specified by:
    
    clearAdminClientCompatLevel in interface ISrvMonListCommandsRequest
    
    Specified by:
    
    clearAdminClientCompatLevel in interface ISrvMonXvmRequest
    
    See Also:
    ISrvMonListCommandsRequest.setAdminClientCompatLevel(String)
  - getEntityFieldId
```
public static final int getEntityFieldId()
```
  - setEntity
```
public final void setEntity(String val)
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    Sets the value of 'entity'.
    Field Description
    The app or entity for which to list commands.
    
    Specified by:
    
    setEntity in interface ISrvMonListCommandsRequest
    
    Parameters:
    val - The value to set.
  - getEntity
```
public final String getEntity()
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    Gets the value of 'entity'.
    Field Description
    The app or entity for which to list commands.
    
    Specified by:
    
    getEntity in interface ISrvMonListCommandsRequest
    
    Returns:
    The app or entity for which to list commands
  - lendEntity
```
public final void lendEntity(XString val)
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    Lends the value of 'entity' to this object.
    This method is equivalent to setEntity 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 app or entity for which to list commands.
    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:
    
    lendEntity in interface ISrvMonListCommandsRequest
    
    Parameters:
    val - The value to set.
  - setEntityFrom
```
public final void setEntityFrom(long val)
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    Sets the value of this String field to the given numeric value.
    Field Description
    The app or entity for which to list commands.
    NOTE:
    This is the same as calling ISrvMonListCommandsRequest.setEntity(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.
    
    Specified by:
    
    setEntityFrom in interface ISrvMonListCommandsRequest
  - getEntityTo
```
public final <T extends XString> T getEntityTo(XString.Factory<T> factory)
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    Copies the value of this String field into a new XString from the given factory.
    Field Description
    The app or entity for which to list commands.
    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:
    
    getEntityTo in interface ISrvMonListCommandsRequest
    
    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.
  - setEntityFrom
```
public final void setEntityFrom(XString val)
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    Copies the provided XString value into this object's 'entity'.
    Field Description
    The app or entity for which to list commands.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than ISrvMonListCommandsRequest.setEntity(String) because it avoids encoding the value into a String if the given XString is already encoded.
    
    Specified by:
    
    setEntityFrom in interface ISrvMonListCommandsRequest
  - getEntityTo
```
public final void getEntityTo(XString val)
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    Copies the value of 'entity' into the provided XString.
    Field Description
    The app or entity for which to list commands.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than ISrvMonListCommandsRequest.getEntity() bec because it can avoid decoding the value into an String.
    
    Specified by:
    
    getEntityTo in interface ISrvMonListCommandsRequest
    
    See Also:
    ISrvMonListCommandsRequest.getEntity()
  - getEntityUnsafe
```
public final XString getEntityUnsafe()
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    Gets the raw value of 'entity'.
    Field Description
    The app or entity for which to list commands.
    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:
    
    getEntityUnsafe in interface ISrvMonListCommandsRequest
    
    Returns:
    the field's raw value
    See Also:
    ISrvMonListCommandsRequest.getEntity()
  - setEntityFrom
```
public final void setEntityFrom(com.neeve.xbuf.XbufStringField val)
```
  - getEntityField
```
public final com.neeve.xbuf.XbufStringField getEntityField()
```
  - hasEntity
```
public final boolean hasEntity()
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    Checks for the presence of 'entity'.
    Field Description
    The app or entity for which to list commands.
    
    Specified by:
    
    hasEntity in interface ISrvMonListCommandsRequest
    
    See Also:
    ISrvMonListCommandsRequest.getEntity()
  - clearEntity
```
public final void clearEntity()
```
    Description copied from interface: ISrvMonListCommandsRequest
    
    Clears the value of 'entity'.
    Field Description
    The app or entity for which to list commands.
    
    Specified by:
    
    clearEntity in interface ISrvMonListCommandsRequest
    
    See Also:
    ISrvMonListCommandsRequest.setEntity(String)
  - 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 SrvMonListCommandsRequest 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 SrvMonListCommandsRequest 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 SrvMonListCommandsRequest 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 SrvMonListCommandsRequest copy()
```
    Creates a copy of this SrvMonListCommandsRequest.
    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 SrvMonListCommandsRequest's embedded entity fields.
    The returned copy will be writeable even if this SrvMonListCommandsRequest 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<ISrvMonListCommandsRequest>
    
    Specified by:
    
    copy in interface ISrvMonListCommandsRequest
    
    Specified by:
    
    copy in interface CopyableMessageView<ISrvMonListCommandsRequest>
    
    Returns:
    A copy of this SrvMonListCommandsRequest.
    See Also:
    IRogCopyableNode, CopyableMessageView
  - copyInto
```
public final void copyInto(SrvMonListCommandsRequest copy)
```
    Copies the contents of this SrvMonListCommandsRequest 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 SrvMonListCommandsRequest's embedded entity fields.
    The returned copy will be writeable even if this SrvMonListCommandsRequest 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 ISrvMonListCommandsRequest
    
    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 SrvMonListCommandsRequest 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 SrvMonListCommandsRequest

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

Methods inherited from interface com.neeve.rog.IRogValidatable

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

getAdminClientIdFieldId

setAdminClientId

Field Description

getAdminClientId

Field Description

lendAdminClientId

Field Description

Usage Notes

setAdminClientIdFrom

Field Description