SrvMonXvmRequest (Talon 3.14.19 API)

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

All Implemented Interfaces:: IRogValidatable, ISrvMonXvmRequest, UtlPool.Item<SrvMonXvmRequest>, 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=303)
public final class SrvMonXvmRequest
extends Object
implements com.neeve.xbuf.IXbufDesyncer, UtlPool.Item<SrvMonXvmRequest>, ISrvMonXvmRequest

Defines request 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
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.
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`	`SrvMonXvmRequest.Field` The SrvMonXvmRequest xbuf field (used internally when this entity is used as a field of another entity).
`static class`	`SrvMonXvmRequest.ListField` The SrvMonXvmRequest list field (used internally when this entity is used as an array field of another entity).

Field Summary

Fields
Modifier and Type Field and Description

static SrvMonXvmRequest[] EMPTY_ARRAY
A preallocated empty array used to avoid garbage when returning empty arrays of this type.

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

Constructor Summary

Constructors
Constructor and Description

SrvMonXvmRequest()

SrvMonXvmRequest(int initialBackingBufferSize)

Constructors
Constructor and Description
`SrvMonXvmRequest()`
`SrvMonXvmRequest(int initialBackingBufferSize)`

Method Summary

Methods
Modifier and Type	Method and Description
`SrvMonXvmRequest`	`acquire()`
`void`	`clearAdminClientCompatLevel()` Clears the value of 'adminClientCompatLevel'.
`void`	`clearAdminClientId()` Clears the value of 'adminClientId'.
`void`	`clearContent()`
`void`	`clearCorrelationId()` Clears the value of 'correlationId'.
`void`	`clearXRogType()`
`void`	`clearXvmName()` Clears the value of 'xvmName'.
`Object`	`clone()` Creates a clone of this object.
`SrvMonXvmRequest`	`copy()` Creates a copy of this SrvMonXvmRequest.
`void`	`copyInto(SrvMonXvmRequest copy)` Copies the contents of this SrvMonXvmRequest into the target.
`static SrvMonXvmRequest`	`create()`
`static SrvMonXvmRequest`	`createFrom(byte[] serializedContainer)`
`static SrvMonXvmRequest`	`createFrom(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)`
`static SrvMonXvmRequest`	`createFromSerializedXbufContainer(byte[] serializedContainer)`
`static SrvMonXvmRequest`	`createFromSerializedXbufContainer(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)`
`static com.neeve.xbuf.XbufSchema`	`createSchema()`
`SrvMonXvmRequest`	`deserializeFromByteArray(byte[] array)`
`SrvMonXvmRequest`	`deserializeFromByteArray(byte[] array, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)`
`SrvMonXvmRequest`	`deserializeFromByteBuffer(ByteBuffer buffer)`
`SrvMonXvmRequest`	`deserializeFromByteBuffer(ByteBuffer buffer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)`
`SrvMonXvmRequest`	`deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length)`
`SrvMonXvmRequest`	`deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)`
`SrvMonXvmRequest`	`deserializeFromNative(long address, int offset, int length)`
`SrvMonXvmRequest`	`deserializeFromNative(long address, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)`
`int`	`desync(PktBuffer buffer, int pos, boolean frameOnly)` Desync fields from a buffer
`void`	`desyncFieldBitmask()`
`void`	`dispose()`
`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()`
`long`	`getCorrelationId()` Gets the value of 'correlationId'.
`com.neeve.xbuf.XbufVariableLongField`	`getCorrelationIdField()`
`static int`	`getCorrelationIdFieldId()`
`static com.neeve.xbuf.XbufDesyncPolicy`	`getDesyncPolicy()`
`boolean`	`getIsReadOnly()`
`int`	`getOwnerCount()`
`UtlPool<SrvMonXvmRequest>`	`getPool()` Get a pool item's pool.
`int`	`getSerializeToNativeLength()`
`void`	`getValidationErrors(List<XString> results, String errorPrefix)` Collects validation errors into the provided list.
`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`	`hasXRogType()`
`boolean`	`hasXvmName()` Checks for the presence of 'xvmName'.
`SrvMonXvmRequest`	`init()` Initialize an item.
`boolean`	`isBufferBacked()`
`boolean`	`isDirty()`
`boolean`	`isReferenceCounted()`
`boolean`	`isValid()` Tests if this object has any validation errors.
`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`	`lendXvmName(XString val)` Lends the value of 'xvmName' to this object.
`static void`	`optimizeFor(int val)`
`byte[]`	`serializeToByteArray()`
`ByteBuffer`	`serializeToByteBuffer()`
`com.neeve.io.IOBuffer`	`serializeToIOBuffer(boolean useNative)`
`int`	`serializeToNative(long address, int addressOffset)`
`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()`
`void`	`setCorrelationId(long val)` Sets the value of 'correlationId'.
`void`	`setCorrelationIdFrom(com.neeve.xbuf.XbufVariableLongField val)`
`static void`	`setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)`
`static void`	`setFieldInterest(List<Integer> fieldIds)`
`SrvMonXvmRequest`	`setPool(UtlPool<SrvMonXvmRequest> pool)` Set a pool item's pool.
`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()`
`void`	`syncFieldBitmask()`
`String`	`toString()`

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

- Field Detail
  - EMPTY_ARRAY
```
public static final SrvMonXvmRequest[] EMPTY_ARRAY
```
    A preallocated empty array used to avoid garbage when returning empty arrays of this type.
- Constructor Detail
  - SrvMonXvmRequest
```
public SrvMonXvmRequest()
```
  - SrvMonXvmRequest
```
public SrvMonXvmRequest(int initialBackingBufferSize)
```
- Method Detail
  - create
```
public static SrvMonXvmRequest create()
```
  - createFromSerializedXbufContainer
```
public static SrvMonXvmRequest createFromSerializedXbufContainer(byte[] serializedContainer,
                                                 com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
```
  - createFromSerializedXbufContainer
```
public static SrvMonXvmRequest createFromSerializedXbufContainer(byte[] serializedContainer)
```
  - createFrom
```
public static SrvMonXvmRequest createFrom(byte[] serializedContainer,
                          com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
```
  - createFrom
```
public static SrvMonXvmRequest 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)
```
  - setAsReadOnly
```
public final void setAsReadOnly()
```
  - getIsReadOnly
```
public final boolean getIsReadOnly()
```
  - 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: ISrvMonXvmRequest
    
    Sets the value of 'correlationId'.
    Field Description
    The request correlation ID.
    
    Specified by:
    
    setCorrelationId in interface ISrvMonXvmRequest
    
    Parameters:
    val - The value to set.
  - getCorrelationId
```
public final long getCorrelationId()
```
    Description copied from interface: ISrvMonXvmRequest
    
    Gets the value of 'correlationId'.
    Field Description
    The request correlation ID.
    
    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: ISrvMonXvmRequest
    
    Checks for the presence of 'correlationId'.
    Field Description
    The request correlation ID.
    
    Specified by:
    
    hasCorrelationId in interface ISrvMonXvmRequest
    
    See Also:
    ISrvMonXvmRequest.getCorrelationId()
  - clearCorrelationId
```
public final void clearCorrelationId()
```
    Description copied from interface: ISrvMonXvmRequest
    
    Clears the value of 'correlationId'.
    Field Description
    The request correlation ID.
    
    Specified by:
    
    clearCorrelationId in interface ISrvMonXvmRequest
    
    See Also:
    ISrvMonXvmRequest.setCorrelationId(long)
  - getAdminClientIdFieldId
```
public static final int getAdminClientIdFieldId()
```
  - setAdminClientId
```
public final void setAdminClientId(String val)
```
    Description copied from interface: ISrvMonXvmRequest
    
    Sets the value of 'adminClientId'.
    Field Description
    The admin client targeted in the command exchange.
    
    Specified by:
    
    setAdminClientId in interface ISrvMonXvmRequest
    
    Parameters:
    val - The value to set.
  - getAdminClientId
```
public final String getAdminClientId()
```
    Description copied from interface: ISrvMonXvmRequest
    
    Gets the value of 'adminClientId'.
    Field Description
    The admin client targeted in the command exchange.
    
    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: ISrvMonXvmRequest
    
    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 ISrvMonXvmRequest
    
    Parameters:
    val - The value to set.
  - setAdminClientIdFrom
```
public final void setAdminClientIdFrom(long val)
```
    Description copied from interface: ISrvMonXvmRequest
    
    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 ISrvMonXvmRequest.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 ISrvMonXvmRequest
  - getAdminClientIdTo
```
public final <T extends XString> T getAdminClientIdTo(XString.Factory<T> factory)
```
    Description copied from interface: ISrvMonXvmRequest
    
    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 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: ISrvMonXvmRequest
    
    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 ISrvMonXvmRequest.setAdminClientId(String) because it avoids encoding the value into a String if the given XString is already encoded.
    
    Specified by:
    
    setAdminClientIdFrom in interface ISrvMonXvmRequest
  - getAdminClientIdTo
```
public final void getAdminClientIdTo(XString val)
```
    Description copied from interface: ISrvMonXvmRequest
    
    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 ISrvMonXvmRequest.getAdminClientId() bec because it can avoid decoding the value into an String.
    
    Specified by:
    
    getAdminClientIdTo in interface ISrvMonXvmRequest
    
    See Also:
    ISrvMonXvmRequest.getAdminClientId()
  - getAdminClientIdUnsafe
```
public final XString getAdminClientIdUnsafe()
```
    Description copied from interface: ISrvMonXvmRequest
    
    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 ISrvMonXvmRequest
    
    Returns:
    the field's raw value
    See Also:
    ISrvMonXvmRequest.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: ISrvMonXvmRequest
    
    Checks for the presence of 'adminClientId'.
    Field Description
    The admin client targeted in the command exchange.
    
    Specified by:
    
    hasAdminClientId in interface ISrvMonXvmRequest
    
    See Also:
    ISrvMonXvmRequest.getAdminClientId()
  - clearAdminClientId
```
public final void clearAdminClientId()
```
    Description copied from interface: ISrvMonXvmRequest
    
    Clears the value of 'adminClientId'.
    Field Description
    The admin client targeted in the command exchange.
    
    Specified by:
    
    clearAdminClientId in interface ISrvMonXvmRequest
    
    See Also:
    ISrvMonXvmRequest.setAdminClientId(String)
  - getXvmNameFieldId
```
public static final int getXvmNameFieldId()
```
  - setXvmName
```
public final void setXvmName(String val)
```
    Description copied from interface: ISrvMonXvmRequest
    
    Sets the value of 'xvmName'.
    Field Description
    The name of the XVM targeted in the command exchange.
    
    Specified by:
    
    setXvmName in interface ISrvMonXvmRequest
    
    Parameters:
    val - The value to set.
  - getXvmName
```
public final String getXvmName()
```
    Description copied from interface: ISrvMonXvmRequest
    
    Gets the value of 'xvmName'.
    Field Description
    The name of the XVM targeted in the command exchange.
    
    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: ISrvMonXvmRequest
    
    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 ISrvMonXvmRequest
    
    Parameters:
    val - The value to set.
  - setXvmNameFrom
```
public final void setXvmNameFrom(long val)
```
    Description copied from interface: ISrvMonXvmRequest
    
    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 ISrvMonXvmRequest.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 ISrvMonXvmRequest
  - getXvmNameTo
```
public final <T extends XString> T getXvmNameTo(XString.Factory<T> factory)
```
    Description copied from interface: ISrvMonXvmRequest
    
    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 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: ISrvMonXvmRequest
    
    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 ISrvMonXvmRequest.setXvmName(String) because it avoids encoding the value into a String if the given XString is already encoded.
    
    Specified by:
    
    setXvmNameFrom in interface ISrvMonXvmRequest
  - getXvmNameTo
```
public final void getXvmNameTo(XString val)
```
    Description copied from interface: ISrvMonXvmRequest
    
    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 ISrvMonXvmRequest.getXvmName() bec because it can avoid decoding the value into an String.
    
    Specified by:
    
    getXvmNameTo in interface ISrvMonXvmRequest
    
    See Also:
    ISrvMonXvmRequest.getXvmName()
  - getXvmNameUnsafe
```
public final XString getXvmNameUnsafe()
```
    Description copied from interface: ISrvMonXvmRequest
    
    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 ISrvMonXvmRequest
    
    Returns:
    the field's raw value
    See Also:
    ISrvMonXvmRequest.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: ISrvMonXvmRequest
    
    Checks for the presence of 'xvmName'.
    Field Description
    The name of the XVM targeted in the command exchange.
    
    Specified by:
    
    hasXvmName in interface ISrvMonXvmRequest
    
    See Also:
    ISrvMonXvmRequest.getXvmName()
  - clearXvmName
```
public final void clearXvmName()
```
    Description copied from interface: ISrvMonXvmRequest
    
    Clears the value of 'xvmName'.
    Field Description
    The name of the XVM targeted in the command exchange.
    
    Specified by:
    
    clearXvmName in interface ISrvMonXvmRequest
    
    See Also:
    ISrvMonXvmRequest.setXvmName(String)
  - getAdminClientCompatLevelFieldId
```
public static final int getAdminClientCompatLevelFieldId()
```
  - setAdminClientCompatLevel
```
public final void setAdminClientCompatLevel(String val)
```
    Description copied from interface: ISrvMonXvmRequest
    
    Sets the value of 'adminClientCompatLevel'.
    Field Description
    The admin client's compatibility level.
    
    Specified by:
    
    setAdminClientCompatLevel in interface ISrvMonXvmRequest
    
    Parameters:
    val - The value to set.
  - getAdminClientCompatLevel
```
public final String getAdminClientCompatLevel()
```
    Description copied from interface: ISrvMonXvmRequest
    
    Gets the value of 'adminClientCompatLevel'.
    Field Description
    The admin client's compatibility level.
    
    Specified by:
    
    getAdminClientCompatLevel in interface ISrvMonXvmRequest
    
    Returns:
    The admin client's compatibility level
  - lendAdminClientCompatLevel
```
public final void lendAdminClientCompatLevel(XString val)
```
    Description copied from interface: ISrvMonXvmRequest
    
    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 ISrvMonXvmRequest
    
    Parameters:
    val - The value to set.
  - setAdminClientCompatLevelFrom
```
public final void setAdminClientCompatLevelFrom(long val)
```
    Description copied from interface: ISrvMonXvmRequest
    
    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 ISrvMonXvmRequest.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 ISrvMonXvmRequest
  - getAdminClientCompatLevelTo
```
public final <T extends XString> T getAdminClientCompatLevelTo(XString.Factory<T> factory)
```
    Description copied from interface: ISrvMonXvmRequest
    
    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 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: ISrvMonXvmRequest
    
    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 ISrvMonXvmRequest.setAdminClientCompatLevel(String) because it avoids encoding the value into a String if the given XString is already encoded.
    
    Specified by:
    
    setAdminClientCompatLevelFrom in interface ISrvMonXvmRequest
  - getAdminClientCompatLevelTo
```
public final void getAdminClientCompatLevelTo(XString val)
```
    Description copied from interface: ISrvMonXvmRequest
    
    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 ISrvMonXvmRequest.getAdminClientCompatLevel() bec because it can avoid decoding the value into an String.
    
    Specified by:
    
    getAdminClientCompatLevelTo in interface ISrvMonXvmRequest
    
    See Also:
    ISrvMonXvmRequest.getAdminClientCompatLevel()
  - getAdminClientCompatLevelUnsafe
```
public final XString getAdminClientCompatLevelUnsafe()
```
    Description copied from interface: ISrvMonXvmRequest
    
    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 ISrvMonXvmRequest
    
    Returns:
    the field's raw value
    See Also:
    ISrvMonXvmRequest.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: ISrvMonXvmRequest
    
    Checks for the presence of 'adminClientCompatLevel'.
    Field Description
    The admin client's compatibility level.
    
    Specified by:
    
    hasAdminClientCompatLevel in interface ISrvMonXvmRequest
    
    See Also:
    ISrvMonXvmRequest.getAdminClientCompatLevel()
  - clearAdminClientCompatLevel
```
public final void clearAdminClientCompatLevel()
```
    Description copied from interface: ISrvMonXvmRequest
    
    Clears the value of 'adminClientCompatLevel'.
    Field Description
    The admin client's compatibility level.
    
    Specified by:
    
    clearAdminClientCompatLevel in interface ISrvMonXvmRequest
    
    See Also:
    ISrvMonXvmRequest.setAdminClientCompatLevel(String)
  - isDirty
```
public final boolean isDirty()
```
  - createSchema
```
public static final com.neeve.xbuf.XbufSchema createSchema()
```
  - serializeToByteArray
```
public final byte[] serializeToByteArray()
```
  - serializeToByteBuffer
```
public final ByteBuffer serializeToByteBuffer()
```
  - serializeToIOBuffer
```
public final com.neeve.io.IOBuffer serializeToIOBuffer(boolean useNative)
```
  - isBufferBacked
```
public final boolean isBufferBacked()
```
  - getSerializeToNativeLength
```
public final int getSerializeToNativeLength()
```
  - serializeToNative
```
public final int serializeToNative(long address,
                    int addressOffset)
```
  - deserializeFromIOElasticBuffer
```
public final SrvMonXvmRequest deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
                                              int offset,
                                              int length,
                                              com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
```
  - deserializeFromIOElasticBuffer
```
public final SrvMonXvmRequest deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
                                              int offset,
                                              int length)
```
  - deserializeFromByteArray
```
public final SrvMonXvmRequest deserializeFromByteArray(byte[] array,
                                        com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
```
  - deserializeFromByteArray
```
public final SrvMonXvmRequest deserializeFromByteArray(byte[] array)
```
  - deserializeFromByteBuffer
```
public final SrvMonXvmRequest deserializeFromByteBuffer(ByteBuffer buffer,
                                         com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
```
  - deserializeFromByteBuffer
```
public final SrvMonXvmRequest deserializeFromByteBuffer(ByteBuffer buffer)
```
  - deserializeFromNative
```
public final SrvMonXvmRequest deserializeFromNative(long address,
                                     int offset,
                                     int length,
                                     com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
```
  - deserializeFromNative
```
public final SrvMonXvmRequest deserializeFromNative(long address,
                                     int offset,
                                     int length)
```
  - sync
```
public final void sync()
```
  - 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
  - init
```
public final SrvMonXvmRequest 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<SrvMonXvmRequest>
    
    Returns:
    Return 'this' object for method invocation chaining.
  - setPool
```
public final SrvMonXvmRequest setPool(UtlPool<SrvMonXvmRequest> 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<SrvMonXvmRequest>
    
    Returns:
    Return 'this' object for method invocation chaining.
  - getPool
```
public final UtlPool<SrvMonXvmRequest> 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<SrvMonXvmRequest>
    
    Returns:
    the pool set using UtlPool.Item.setPool(com.neeve.util.UtlPool<T>)
  - isReferenceCounted
```
public final boolean isReferenceCounted()
```
  - acquire
```
public final SrvMonXvmRequest acquire()
```
  - getOwnerCount
```
public final int getOwnerCount()
```
  - 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
  - copy
```
public final SrvMonXvmRequest copy()
```
    Creates a copy of this SrvMonXvmRequest.
    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 SrvMonXvmRequest's embedded entity fields.
    The returned copy will be writeable even if this SrvMonXvmRequest is read only.
    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.
    
    Returns:
    The copied entity.
  - copyInto
```
public final void copyInto(SrvMonXvmRequest copy)
```
    Copies the contents of this SrvMonXvmRequest 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 SrvMonXvmRequest's embedded entity fields.
    The returned copy will be writeable even if this SrvMonXvmRequest is read only.
    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.
    
    Parameters:
    copy - The target into which to copy.
  - 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 SrvMonXvmRequest

ADM Details

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_ARRAY

Constructor Detail

SrvMonXvmRequest

SrvMonXvmRequest

Method Detail

create

createFromSerializedXbufContainer

createFromSerializedXbufContainer

createFrom

createFrom

setDesyncPolicy

getDesyncPolicy

setFieldInterest

clearContent

syncFieldBitmask

desyncFieldBitmask

getBackingBuffer

optimizeFor

setAsReadOnly

getIsReadOnly

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

getAdminClientIdTo

Field Description

setAdminClientIdFrom

Field Description

getAdminClientIdTo

Field Description

getAdminClientIdUnsafe

Field Description

setAdminClientIdFrom

getAdminClientIdField

hasAdminClientId

Field Description

clearAdminClientId

Field Description

getXvmNameFieldId

setXvmName

Field Description

getXvmName

Field Description

lendXvmName

Field Description

Usage Notes

setXvmNameFrom