SrvMonXvmResponse (Rumi 4.0.595 API)

java.lang.Object
- com.neeve.server.mon.cnc.SrvMonXvmResponse

All Implemented Interfaces:: AdmRuntime.BufferSizer, com.neeve.query.impl.index.IdxMappable, IRogValidatable, ISrvMonXvmResponse, com.neeve.server.mon.common.IHasSrvMonXvmHeader, MessageReflector, UtlPool.Item<SrvMonXvmResponse>

@Generated(value="com.neeve.protobuf.adm.ProtobufAdmNodeGenerator",
           date="Tue Sep 16 04:36:05 UTC 2025")
 @AdmGenerated(encoding="xbuf",
              compatLevel="5.0.0",
              admVersion="Unknown Version",
              date="9/16/25 4:36 AM",
              buildInfo="nvx-rumi-server-4.0.595 (Rumi ADM Maven Plugin)")
 @AdmFactoryInfo(factoryClass=SrvMonCncFactory.class,
                vfid=36,
                ofid=36,
                typeId=304)
public final class SrvMonXvmResponse
extends Object
implements ISrvMonXvmResponse, MessageReflector, com.neeve.query.impl.index.IdxMappable, UtlPool.Item<SrvMonXvmResponse>, AdmRuntime.BufferSizer

Defines response header fields.

Command and control request metadata about the admin client that initiated the request or is targeted in a repsonse.

ADM Details

ADM Type	Embedded Entity
Factory	SrvMonCncFactory

ADM Field Summary

Field	Type	Id	Description
adminClientId	String	216	The admin client targeted in the command exchange.
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`	`SrvMonXvmResponse.Deserializer` The deserializer
`static class`	`SrvMonXvmResponse.PacketBody` The backing packet type for SrvMonXvmResponse (used internally for serialization purposes).
`static class`	`SrvMonXvmResponse.Pojo` The POJO
`static class`	`SrvMonXvmResponse.Serializer` The serializer

Field Summary

Fields
Modifier and Type Field and Description

static SrvMonXvmResponse[] EMPTY_ARRAY

Fields
Modifier and Type	Field and Description
`static SrvMonXvmResponse[]`	`EMPTY_ARRAY`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`SrvMonXvmResponse`	`acquire()`
`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`	`clear()`
`void`	`clear(boolean disposeMembers)`
`void`	`clearAdminClientId()` Clears the value of 'adminClientId'.
`void`	`clearContent()` Deprecated.
`void`	`clearCorrelationId()` Clears the value of 'correlationId'.
`void`	`clearXvmHeader()` Clears the value of 'xvmHeader'.
`void`	`clearXvmName()` Clears the value of 'xvmName'.
`Object`	`clone()` Creates a clone of this object.
`SrvMonXvmResponse`	`copy()`
`void`	`copyInto(SrvMonXvmResponse copy)`
`static SrvMonXvmResponse`	`create()`
`SrvMonXvmResponse`	`deserializeFrom(byte[] array, int offset, int len)`
`SrvMonXvmResponse`	`deserializeFrom(ByteBuffer buffer)`
`SrvMonXvmResponse`	`deserializeFrom(IOBuffer buffer, int offset, int len)`
`SrvMonXvmResponse`	`deserializeFrom(IOElasticBuffer buffer, int offset, int len)`
`SrvMonXvmResponse`	`deserializeFrom(long addr, int offset, int len)`
`SrvMonXvmResponse`	`deserializeFrom(PktPacket packet)`
`SrvMonXvmResponse`	`deserializeFrom(SrvMonXvmResponse.Deserializer deserializer)`
`SrvMonXvmResponse`	`deserializeFrom(SrvMonXvmResponse val)`
`SrvMonXvmResponse`	`deserializeFromByteArray(byte[] array)`
`SrvMonXvmResponse`	`deserializeFromByteBuffer(ByteBuffer buffer)`
`SrvMonXvmResponse`	`deserializeFromJson(String json)`
`SrvMonXvmResponse`	`deserializeFromNative(long addr, int offset, int len)` Deprecated.
`SrvMonXvmResponse`	`deserializeFromPacket(PktPacket packet)`
`SrvMonXvmResponse`	`deserializeFromRawJson(String json)`
`SrvMonXvmResponse.Deserializer`	`deserializer()`
`SrvMonXvmResponse.Deserializer`	`deserializer(boolean createBuffer)`
`void`	`dispose()`
`void`	`disposeDeserializer()`
`void`	`disposePojo()`
`void`	`disposePojo(boolean sync)`
`void`	`disposeSerializedBuffer()`
`void`	`disposeSerializedBuffer(boolean gcDisposed)`
`void`	`disposeSerializer()`
`long`	`ensureCapacity(long addr, int capacity)` Method invoked by the serializer to ensure there is enough space in the target buffer to accommodate a field being serialized
`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'.
`static int`	`getAdminClientIdFieldId()`
`<T extends XString> T`	`getAdminClientIdTo(IXStringFactory<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'.
`long`	`getCorrelationId()` Gets the value of 'correlationId'.
`Long`	`getCorrelationIdAsObject()` Gets the value of 'correlationId'.
`static int`	`getCorrelationIdFieldId()`
`static <T> IRogFieldReflector<SrvMonXvmResponse,T>`	`getFieldReflector(String name)` Get a field reflector.
`static <T> IRogFieldReflector<SrvMonXvmResponse,T>`	`getFieldReflector(String[] pathComponents)` Get a field reflector.
`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.
`int`	`getOwnershipCount()`
`UtlPool<SrvMonXvmResponse>`	`getPool()` Get a pool item's pool.
`Object`	`getQueryFieldValue(String name)` Gets an indexable value identified by a key.
`long`	`getSerializedBuffer()`
`int`	`getSerializedBufferCapacity()`
`int`	`getSerializedBufferLength()`
`int`	`getSerializeToNativeLength()` Deprecated.
`void`	`getValidationErrors(List<XString> results, String errorPrefix)` Collects validation errors into the provided list.
`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'.
`static int`	`getXvmNameFieldId()`
`<T extends XString> T`	`getXvmNameTo(IXStringFactory<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`	`hasDirtyPojo()`
`boolean`	`hasPojo()`
`boolean`	`hasSerializedBuffer()`
`boolean`	`hasXvmHeader()` Checks for the presence of 'xvmHeader'.
`boolean`	`hasXvmName()` Checks for the presence of 'xvmName'.
`SrvMonXvmResponse`	`init()` Initialize an item.
`boolean`	`isFieldReflectable(Object message, String name)` Check if a field of the supplied name is reflectable.
`boolean`	`isValid()` Tests if this object has any validation errors.
`void`	`lendAdminClientId(XString val)` Lends the value of 'adminClientId' to this object.
`void`	`lendXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)` 'Lends' a reference of the SrvMonXvmHeader to the message for this field.
`void`	`lendXvmName(XString val)` Lends the value of 'xvmName' to this object.
`boolean`	`needsSync()` Check if a view needs to be sync'd for reflection.
`SrvMonXvmResponse.Pojo`	`pojo()`
`SrvMonXvmResponse.Pojo`	`pojo(boolean onlyPojos)`
`void`	`reset()`
`void`	`reset(boolean disposeMembers)`
`SrvMonXvmResponse.Serializer`	`serializer()`
`SrvMonXvmResponse.Serializer`	`serializer(int minimumLength)`
`SrvMonXvmResponse.Serializer`	`serializer(int length, boolean autoResizeTargetBuffer)`
`int`	`serializeTo(byte[] array, int offset)`
`int`	`serializeTo(ByteBuffer buffer)`
`int`	`serializeTo(IOBuffer buffer, int offset)`
`int`	`serializeTo(IOElasticBuffer buffer, int offset)`
`int`	`serializeTo(long addr, int offset)`
`int`	`serializeTo(PktPacket packet)`
`int`	`serializeTo(SrvMonXvmResponse.Serializer serializer)`
`byte[]`	`serializeToByteArray()`
`ByteBuffer`	`serializeToByteBuffer()`
`IOBuffer`	`serializeToIOBuffer(boolean useNative)`
`String`	`serializeToJson()`
`int`	`serializeToNative(long addr, int offset)` Deprecated.
`PktPacket`	`serializeToPacket()`
`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(XString val)` Copies the provided XString value into this object's 'adminClientId'.
`void`	`setAsReadOnly()`
`void`	`setCorrelationId(long val)` Sets the value of 'correlationId'.
`SrvMonXvmResponse`	`setPool(UtlPool<SrvMonXvmResponse> pool)` Set a pool item's pool.
`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(XString val)` Copies the provided XString value into this object's 'xvmName'.
`void`	`sync()`
`com.neeve.server.mon.common.SrvMonXvmHeader`	`takeXvmHeader()` 'Takes' a reference to the xvmHeader field from the message.
`String`	`toString()`
`SrvMonXvmResponse`	`wrap(IOBuffer buffer, int len)`

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

- Field Detail
  - EMPTY_ARRAY
```
public static final SrvMonXvmResponse[] EMPTY_ARRAY
```
- Method Detail
  - create
```
public static SrvMonXvmResponse create()
```
  - hasSerializedBuffer
```
public final boolean hasSerializedBuffer()
```
  - getSerializedBuffer
```
public final long getSerializedBuffer()
```
  - getSerializedBufferCapacity
```
public final int getSerializedBufferCapacity()
```
  - getSerializedBufferLength
```
public final int getSerializedBufferLength()
```
  - getSerializeToNativeLength
```
@Deprecated
public final int getSerializeToNativeLength()
```
    Deprecated.
  - serializer
```
public final SrvMonXvmResponse.Serializer serializer(int length,
                                                     boolean autoResizeTargetBuffer)
```
  - serializer
```
public final SrvMonXvmResponse.Serializer serializer(int minimumLength)
```
  - serializer
```
public final SrvMonXvmResponse.Serializer serializer()
```
  - ensureCapacity
```
public final long ensureCapacity(long addr,
                                 int capacity)
```
    Description copied from interface: AdmRuntime.BufferSizer
    
    Method invoked by the serializer to ensure there is enough space in the target buffer to accommodate a field being serialized
    
    Specified by:
    
    ensureCapacity in interface AdmRuntime.BufferSizer
    
    Parameters:
    
    addr - The native address of the target buffer
    
    capacity - The required capacity of the buffer
    
    Returns:
    
    long Returns the address of the buffer that has at least the requested capacity. This could be the same buffer that is passed in if the buffer has the capacity or a reallocated buffer if the passed in buffer did not have the requested capacity and needed to be reallocated
    This method is invoked by a serializer each time it serializes a field or part of a field to the target buffer to ensure that the target buffer has the desired capacity to hold the data being added.
  - deserializer
```
public final SrvMonXvmResponse.Deserializer deserializer(boolean createBuffer)
```
  - deserializer
```
public final SrvMonXvmResponse.Deserializer deserializer()
```
  - hasPojo
```
public final boolean hasPojo()
```
  - hasDirtyPojo
```
public final boolean hasDirtyPojo()
```
  - pojo
```
public final SrvMonXvmResponse.Pojo pojo(boolean onlyPojos)
```
  - pojo
```
public final SrvMonXvmResponse.Pojo pojo()
```
  - disposeSerializedBuffer
```
public final void disposeSerializedBuffer(boolean gcDisposed)
```
  - disposeSerializedBuffer
```
public final void disposeSerializedBuffer()
```
  - disposeSerializer
```
public final void disposeSerializer()
```
  - disposeDeserializer
```
public final void disposeDeserializer()
```
  - disposePojo
```
public final void disposePojo(boolean sync)
```
  - disposePojo
```
public final void disposePojo()
```
  - clear
```
public final void clear(boolean disposeMembers)
```
  - clear
```
public final void clear()
```
  - clearContent
```
@Deprecated
public final void clearContent()
```
    Deprecated.
  - reset
```
public final void reset(boolean disposeMembers)
```
  - reset
```
public final void reset()
```
  - serializeToRawJson
```
public final String serializeToRawJson()
```
  - serializeTo
```
public final int serializeTo(SrvMonXvmResponse.Serializer serializer)
```
  - sync
```
public final void sync()
```
  - serializeToByteArray
```
public final byte[] serializeToByteArray()
```
  - serializeTo
```
public final int serializeTo(byte[] array,
                             int offset)
```
  - serializeToByteBuffer
```
public final ByteBuffer serializeToByteBuffer()
```
  - serializeTo
```
public final int serializeTo(ByteBuffer buffer)
```
  - serializeToIOBuffer
```
public final IOBuffer serializeToIOBuffer(boolean useNative)
```
  - serializeTo
```
public final int serializeTo(IOBuffer buffer,
                             int offset)
```
  - serializeTo
```
public final int serializeTo(IOElasticBuffer buffer,
                             int offset)
```
  - serializeToPacket
```
public final PktPacket serializeToPacket()
```
  - serializeTo
```
public final int serializeTo(PktPacket packet)
```
  - serializeTo
```
public final int serializeTo(long addr,
                             int offset)
```
  - serializeToNative
```
@Deprecated
public final int serializeToNative(long addr,
                                               int offset)
```
    Deprecated.
  - serializeToJson
```
public final String serializeToJson()
```
  - deserializeFromRawJson
```
public final SrvMonXvmResponse deserializeFromRawJson(String json)
```
  - deserializeFrom
```
public final SrvMonXvmResponse deserializeFrom(SrvMonXvmResponse.Deserializer deserializer)
```
  - deserializeFrom
```
public final SrvMonXvmResponse deserializeFrom(SrvMonXvmResponse val)
```
  - wrap
```
public final SrvMonXvmResponse wrap(IOBuffer buffer,
                                    int len)
```
  - deserializeFromByteArray
```
public final SrvMonXvmResponse deserializeFromByteArray(byte[] array)
```
  - deserializeFrom
```
public final SrvMonXvmResponse deserializeFrom(byte[] array,
                                               int offset,
                                               int len)
```
  - deserializeFromByteBuffer
```
public final SrvMonXvmResponse deserializeFromByteBuffer(ByteBuffer buffer)
```
  - deserializeFrom
```
public final SrvMonXvmResponse deserializeFrom(ByteBuffer buffer)
```
  - deserializeFrom
```
public final SrvMonXvmResponse deserializeFrom(IOBuffer buffer,
                                               int offset,
                                               int len)
```
  - deserializeFrom
```
public final SrvMonXvmResponse deserializeFrom(IOElasticBuffer buffer,
                                               int offset,
                                               int len)
```
  - deserializeFromPacket
```
public final SrvMonXvmResponse deserializeFromPacket(PktPacket packet)
```
  - deserializeFrom
```
public final SrvMonXvmResponse deserializeFrom(PktPacket packet)
```
  - deserializeFrom
```
public final SrvMonXvmResponse deserializeFrom(long addr,
                                               int offset,
                                               int len)
```
  - deserializeFromNative
```
@Deprecated
public final SrvMonXvmResponse deserializeFromNative(long addr,
                                                                 int offset,
                                                                 int len)
```
    Deprecated.
  - deserializeFromJson
```
public final SrvMonXvmResponse deserializeFromJson(String json)
```
  - copyInto
```
public final void copyInto(SrvMonXvmResponse copy)
```
  - copy
```
public final SrvMonXvmResponse copy()
```
  - 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 interface: MessageReflector
    
    Appends a reflected field value as a string into the given XString.
    If the field is reflectable and has a non null value, then it will be appended otherwise, this method must return false.
    
    Specified by:
    
    appendFieldValueTo in interface MessageReflector
    
    Parameters:
    
    message - the node on which to reflect (which need not be this object).
    
    name - the bean path to the field.
    
    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 interface: MessageReflector
    
    Appends a reflected field value as a string into the given XString.
    If the field is reflectable and has a non null value, then it will be appended otherwise, this method must return false.
    
    Specified by:
    
    appendFieldValueTo in interface MessageReflector
    
    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.
  - setAsReadOnly
```
public final void setAsReadOnly()
```
  - getCorrelationIdFieldId
```
public static final int getCorrelationIdFieldId()
```
  - setCorrelationId
```
public final void setCorrelationId(long val)
```
    Description copied from interface: ISrvMonXvmResponse
    
    Sets the value of 'correlationId'.
    Field Description
    The request correlation ID.
    
    Specified by:
    
    setCorrelationId in interface ISrvMonXvmResponse
    
    Parameters:
    
    val - The value to set.
  - getCorrelationId
```
public final long getCorrelationId()
```
    Description copied from interface: ISrvMonXvmResponse
    
    Gets the value of 'correlationId'.
    Field Description
    The request correlation ID.
    
    Specified by:
    
    getCorrelationId in interface ISrvMonXvmResponse
    
    Returns:
    
    The request correlation ID
  - getCorrelationIdAsObject
```
public final Long getCorrelationIdAsObject()
```
    Description copied from interface: ISrvMonXvmResponse
    
    Gets the value of 'correlationId'.
    Field Description
    The request correlation ID.
    
    Specified by:
    
    getCorrelationIdAsObject in interface ISrvMonXvmResponse
    
    Returns:
    
    The request correlation ID
  - hasCorrelationId
```
public final boolean hasCorrelationId()
```
    Description copied from interface: ISrvMonXvmResponse
    
    Checks for the presence of 'correlationId'.
    Field Description
    The request correlation ID.
    
    Specified by:
    
    hasCorrelationId in interface ISrvMonXvmResponse
    
    See Also:
    
    ISrvMonXvmResponse.getCorrelationId()
  - clearCorrelationId
```
public final void clearCorrelationId()
```
    Description copied from interface: ISrvMonXvmResponse
    
    Clears the value of 'correlationId'.
    Field Description
    The request correlation ID.
    
    Specified by:
    
    clearCorrelationId in interface ISrvMonXvmResponse
    
    See Also:
    
    ISrvMonXvmResponse.setCorrelationId(long)
  - getXvmHeaderFieldId
```
public static final int getXvmHeaderFieldId()
```
  - setXvmHeader
```
public final void setXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)
```
    Description copied from interface: ISrvMonXvmResponse
    
    Sets the value of 'xvmHeader'.
    Field Description
    Details about the message source.
    
    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: ISrvMonXvmResponse
    
    '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 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: ISrvMonXvmResponse
    
    Gets the value of 'xvmHeader'.
    Field Description
    Details about the message source.
    
    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: ISrvMonXvmResponse
    
    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 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: ISrvMonXvmResponse
    
    '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 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: ISrvMonXvmResponse
    
    Checks for the presence of 'xvmHeader'.
    Field Description
    Details about the message source.
    
    Specified by:
    
    hasXvmHeader in interface ISrvMonXvmResponse
    
    Specified by:
    
    hasXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader
    
    See Also:
    
    ISrvMonXvmResponse.getXvmHeader()
  - clearXvmHeader
```
public final void clearXvmHeader()
```
    Description copied from interface: ISrvMonXvmResponse
    
    Clears the value of 'xvmHeader'.
    Field Description
    Details about the message source.
    
    Specified by:
    
    clearXvmHeader in interface ISrvMonXvmResponse
    
    Specified by:
    
    clearXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader
    
    See Also:
    
    ISrvMonXvmResponse.setXvmHeader(SrvMonXvmHeader)
  - getAdminClientIdFieldId
```
public static final int getAdminClientIdFieldId()
```
  - setAdminClientId
```
public final void setAdminClientId(String val)
```
    Description copied from interface: ISrvMonXvmResponse
    
    Sets the value of 'adminClientId'.
    Field Description
    The admin client targeted in the command exchange.
    
    Specified by:
    
    setAdminClientId in interface ISrvMonXvmResponse
    
    Parameters:
    
    val - The value to set.
  - getAdminClientId
```
public final String getAdminClientId()
```
    Description copied from interface: ISrvMonXvmResponse
    
    Gets the value of 'adminClientId'.
    Field Description
    The admin client targeted in the command exchange.
    
    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: ISrvMonXvmResponse
    
    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 ISrvMonXvmResponse
    
    Parameters:
    
    val - The value to set.
  - setAdminClientIdFrom
```
public final void setAdminClientIdFrom(long val)
```
    Description copied from interface: ISrvMonXvmResponse
    
    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 ISrvMonXvmResponse.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 ISrvMonXvmResponse
  - getAdminClientIdTo
```
public final <T extends XString> T getAdminClientIdTo(IXStringFactory<T> factory)
```
    Description copied from interface: ISrvMonXvmResponse
    
    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 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: ISrvMonXvmResponse
    
    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 ISrvMonXvmResponse.setAdminClientId(String) because it avoids encoding the value into a String if the given XString is already encoded.
    
    Specified by:
    
    setAdminClientIdFrom in interface ISrvMonXvmResponse
  - getAdminClientIdTo
```
public final void getAdminClientIdTo(XString val)
```
    Description copied from interface: ISrvMonXvmResponse
    
    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 ISrvMonXvmResponse.getAdminClientId() bec because it can avoid decoding the value into an String.
    
    Specified by:
    
    getAdminClientIdTo in interface ISrvMonXvmResponse
    
    See Also:
    
    ISrvMonXvmResponse.getAdminClientId()
  - getAdminClientIdUnsafe
```
public final XString getAdminClientIdUnsafe()
```
    Description copied from interface: ISrvMonXvmResponse
    
    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 ISrvMonXvmResponse
    
    Returns:
    
    the field's raw value
    
    See Also:
    
    ISrvMonXvmResponse.getAdminClientId()
  - hasAdminClientId
```
public final boolean hasAdminClientId()
```
    Description copied from interface: ISrvMonXvmResponse
    
    Checks for the presence of 'adminClientId'.
    Field Description
    The admin client targeted in the command exchange.
    
    Specified by:
    
    hasAdminClientId in interface ISrvMonXvmResponse
    
    See Also:
    
    ISrvMonXvmResponse.getAdminClientId()
  - clearAdminClientId
```
public final void clearAdminClientId()
```
    Description copied from interface: ISrvMonXvmResponse
    
    Clears the value of 'adminClientId'.
    Field Description
    The admin client targeted in the command exchange.
    
    Specified by:
    
    clearAdminClientId in interface ISrvMonXvmResponse
    
    See Also:
    
    ISrvMonXvmResponse.setAdminClientId(String)
  - getXvmNameFieldId
```
public static final int getXvmNameFieldId()
```
  - setXvmName
```
public final void setXvmName(String val)
```
    Description copied from interface: ISrvMonXvmResponse
    
    Sets the value of 'xvmName'.
    Field Description
    The name of the XVM targeted in the command exchange.
    
    Specified by:
    
    setXvmName in interface ISrvMonXvmResponse
    
    Parameters:
    
    val - The value to set.
  - getXvmName
```
public final String getXvmName()
```
    Description copied from interface: ISrvMonXvmResponse
    
    Gets the value of 'xvmName'.
    Field Description
    The name of the XVM targeted in the command exchange.
    
    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: ISrvMonXvmResponse
    
    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 ISrvMonXvmResponse
    
    Parameters:
    
    val - The value to set.
  - setXvmNameFrom
```
public final void setXvmNameFrom(long val)
```
    Description copied from interface: ISrvMonXvmResponse
    
    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 ISrvMonXvmResponse.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 ISrvMonXvmResponse
  - getXvmNameTo
```
public final <T extends XString> T getXvmNameTo(IXStringFactory<T> factory)
```
    Description copied from interface: ISrvMonXvmResponse
    
    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 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: ISrvMonXvmResponse
    
    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 ISrvMonXvmResponse.setXvmName(String) because it avoids encoding the value into a String if the given XString is already encoded.
    
    Specified by:
    
    setXvmNameFrom in interface ISrvMonXvmResponse
  - getXvmNameTo
```
public final void getXvmNameTo(XString val)
```
    Description copied from interface: ISrvMonXvmResponse
    
    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 ISrvMonXvmResponse.getXvmName() bec because it can avoid decoding the value into an String.
    
    Specified by:
    
    getXvmNameTo in interface ISrvMonXvmResponse
    
    See Also:
    
    ISrvMonXvmResponse.getXvmName()
  - getXvmNameUnsafe
```
public final XString getXvmNameUnsafe()
```
    Description copied from interface: ISrvMonXvmResponse
    
    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 ISrvMonXvmResponse
    
    Returns:
    
    the field's raw value
    
    See Also:
    
    ISrvMonXvmResponse.getXvmName()
  - hasXvmName
```
public final boolean hasXvmName()
```
    Description copied from interface: ISrvMonXvmResponse
    
    Checks for the presence of 'xvmName'.
    Field Description
    The name of the XVM targeted in the command exchange.
    
    Specified by:
    
    hasXvmName in interface ISrvMonXvmResponse
    
    See Also:
    
    ISrvMonXvmResponse.getXvmName()
  - clearXvmName
```
public final void clearXvmName()
```
    Description copied from interface: ISrvMonXvmResponse
    
    Clears the value of 'xvmName'.
    Field Description
    The name of the XVM targeted in the command exchange.
    
    Specified by:
    
    clearXvmName in interface ISrvMonXvmResponse
    
    See Also:
    
    ISrvMonXvmResponse.setXvmName(String)
  - getFieldReflector
```
public static final <T> IRogFieldReflector<SrvMonXvmResponse,T> getFieldReflector(String name)
```
    Get a field reflector.
    
    Parameters:
    
    name - The name of the field ('.' delimited for nested fields)
    
    Returns:
    
    The reflectable field reflector for the field of the supplied name or null if no reflectable field of the supplied name exists
  - getFieldReflector
```
public static final <T> IRogFieldReflector<SrvMonXvmResponse,T> getFieldReflector(String[] pathComponents)
```
    Get a field reflector.
    
    Parameters:
    
    pathComponents - The path to the field whose reflector is to be returned
    
    Returns:
    
    The reflectable field reflector for the field of the supplied path or null if no reflectable field of the supplied name exists
  - getQueryFieldValue
```
public final Object getQueryFieldValue(String name)
```
    Description copied from interface: com.neeve.query.impl.index.IdxMappable
    
    Gets an indexable value identified by a key.
    Implementation should ensure that the the type of the value returned is consistent across types.
    
    Specified by:
    
    getQueryFieldValue in interface com.neeve.query.impl.index.IdxMappable
    
    Parameters:
    
    name - The name of the field whose value is to be accessed.
    
    Returns:
    
    The value.
  - init
```
public final SrvMonXvmResponse init()
```
    Description copied from interface: UtlPool.Item
    
    Initialize an item.
    This method is invoked by an item pool very time an item is put into the pool. The method should wipe the contents of the item so as to present a fresh instance of the item to the caller when retrieved from the pool.
    
    Specified by:
    
    init in interface UtlPool.Item<SrvMonXvmResponse>
    
    Returns:
    
    Return 'this' object for method invocation chaining.
  - setPool
```
public final SrvMonXvmResponse setPool(UtlPool<SrvMonXvmResponse> pool)
```
    Description copied from interface: UtlPool.Item
    
    Set a pool item's pool.
    This method is invoked by an item pool at the time an item is added to the pool. The intent is to record the item's source pool in the item so it can be disposed back into the pool when the user is done working with it.
    
    Specified by:
    
    setPool in interface UtlPool.Item<SrvMonXvmResponse>
    
    Returns:
    
    Return 'this' object for method invocation chaining.
  - getPool
```
public final UtlPool<SrvMonXvmResponse> getPool()
```
    Description copied from interface: UtlPool.Item
    
    Get a pool item's pool.
    This method should return the pool set using UtlPool.Item.setPool(com.neeve.util.UtlPool<T>)
    
    Specified by:
    
    getPool in interface UtlPool.Item<SrvMonXvmResponse>
    
    Returns:
    
    the pool set using UtlPool.Item.setPool(com.neeve.util.UtlPool<T>)
  - acquire
```
public final SrvMonXvmResponse acquire()
```
  - getOwnershipCount
```
public final int getOwnershipCount()
```
  - dispose
```
public final void dispose()
```
  - clone
```
public final Object clone()
```
    Creates a clone of this object.
    This method differs from the copy() method in that:
    - For protobuf and xbuf generated objects pass-through fields are not preserved. Pass through fields are fields not defined by ADM model that generated this class, but may exist in the backing buffer or protobuf message for the object.
    - The copy method may replace empty arrays with a null value whereas this method preserves empty array fields.
    Overrides:
    
    clone in class Object
  - isValid
```
public final boolean isValid()
```
    Description copied from interface: IRogValidatable
    
    Tests if this object has any validation errors.
    
    Specified by:
    
    isValid in interface IRogValidatable
  - getValidationErrors
```
public final void getValidationErrors(List<XString> results,
                                      String errorPrefix)
```
    Description copied from interface: IRogValidatable
    
    Collects validation errors into the provided list. It is illegal for the caller to hold onto the List of XStrings beyond the lifespace of this object.
    
    Specified by:
    
    getValidationErrors in interface IRogValidatable
    
    Parameters:
    
    results - A results list into which validation errors will be collected.
    
    errorPrefix - The bean path prefix to use when identifying invalid fields or null if validating a top level entity.
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object

Class SrvMonXvmResponse

ADM Details

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_ARRAY

Method Detail

create

hasSerializedBuffer

getSerializedBuffer

getSerializedBufferCapacity

getSerializedBufferLength

getSerializeToNativeLength

serializer

serializer

serializer

ensureCapacity

deserializer

deserializer

hasPojo

hasDirtyPojo

pojo

pojo

disposeSerializedBuffer

disposeSerializedBuffer

disposeSerializer

disposeDeserializer

disposePojo

disposePojo

clear

clear

clearContent

reset

reset

serializeToRawJson

serializeTo

sync

serializeToByteArray

serializeTo

serializeToByteBuffer

serializeTo

serializeToIOBuffer

serializeTo

serializeTo

serializeToPacket

serializeTo

serializeTo

serializeToNative

serializeToJson

deserializeFromRawJson

deserializeFrom

deserializeFrom

wrap

deserializeFromByteArray

deserializeFrom

deserializeFromByteBuffer

deserializeFrom

deserializeFrom

deserializeFrom

deserializeFromPacket

deserializeFrom

deserializeFrom

deserializeFromNative

deserializeFromJson

copyInto

copy

needsSync

fieldExists

isFieldReflectable

getFieldValueAsString

getFieldValueAsString

getFieldValueAsRawString

getFieldValueAsRawString

appendFieldValueTo

appendFieldValueTo

setAsReadOnly

getCorrelationIdFieldId

setCorrelationId