ISrvMonInvokeCommandRequest (Talon 3.16.63 API)

All Superinterfaces:: CopyableMessageView<ISrvMonInvokeCommandRequest>, IRogCopyableNode<ISrvMonInvokeCommandRequest>, IRogMessage, IRogMetadata, IRogNode, IRogValidatable, ISrvMonXvmRequest, IStoreObject, IStoreObjectMetadata, MapMessageView, MessageView, UtlReferenceTracker.HasReferenceTracker

All Known Implementing Classes:: SrvMonInvokeCommandRequest

@Generated(value="com.neeve.adm.AdmGenerator",
           date="Fri Dec 05 13:32:50 UTC 2025")
 @AdmGenerated(compatLevel="4.1.0",
              admVersion="Unknown Version",
              date="12/5/25 1:32 PM",
              buildInfo="nvx-talon-3.16.63 (nvx-codegen-plugin)")
public interface ISrvMonInvokeCommandRequest
extends IRogNode, IRogMessage, IRogCopyableNode<ISrvMonInvokeCommandRequest>, ISrvMonXvmRequest

Instructs the XVM to inoke a command.

ADM Details

ADM Type	Message
Factory	SrvMonCncFactory

ADM Field Summary

Field	Type	Id	Description
adminClientCompatLevel	String	204	The admin client's compatibility level.
adminClientId	String	201	The admin client targeted in the command exchange.
commandName	String	2	The name of the command to invoke.
correlationId	Long	202	The request correlation ID.
parameters	String[]	3	The list of options and arguments for the command. For example when invoking MyApp doSend --rate 20 --count 1000 true the parameters would look like: --rate 20 --count 1000 true
target	String	1	The target (e.g. app) on which to invoke the command.
xvmName	String	203	The name of the XVM targeted in the command exchange.

Nested Class Summary
- Nested classes/interfaces inherited from interface com.neeve.rog.IRogNode
  IRogNode.PoolingListener
- Nested classes/interfaces inherited from interface com.neeve.ods.IStoreObject
  IStoreObject.EncodingType

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addParameters(String val)` Adds the provided value to the list of 'parameters' values.
`void`	`clearAdminClientCompatLevel()` Clears the value of 'adminClientCompatLevel'.
`void`	`clearAdminClientId()` Clears the value of 'adminClientId'.
`void`	`clearCommandName()` Clears the value of 'commandName'.
`void`	`clearCorrelationId()` Clears the value of 'correlationId'.
`void`	`clearParameters()` Clears the value of 'parameters'.
`void`	`clearTarget()` Clears the value of 'target'.
`void`	`clearXvmName()` Clears the value of 'xvmName'.
`SrvMonInvokeCommandRequest`	`copy()` Creates a copy of this SrvMonInvokeCommandRequest.
`void`	`copyInto(SrvMonInvokeCommandRequest target)` Copies the contents of this SrvMonInvokeCommandRequest into the target.
`String`	`getAdminClientCompatLevel()` Gets the value of 'adminClientCompatLevel'.
`<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'.
`<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'.
`String`	`getCommandName()` Gets the value of 'commandName'.
`<T extends XString> T`	`getCommandNameTo(XString.Factory<T> factory)` Copies the value of this String field into a new XString from the given factory.
`void`	`getCommandNameTo(XString val)` Copies the value of 'commandName' into the provided XString.
`XString`	`getCommandNameUnsafe()` Gets the raw value of 'commandName'.
`long`	`getCorrelationId()` Gets the value of 'correlationId'.
`Long`	`getCorrelationIdAsObject()` Gets the value of 'correlationId'.
`String[]`	`getParameters()` Gets the value of 'parameters'.
`String[]`	`getParametersEmptyIfNull()` Gets the value of 'parameters' or an empty array if the value is `null` or not set.
`XStringIterator`	`getParametersIterator()` Gets the value of 'parameters' as iterator of values.
`String`	`getTarget()` Gets the value of 'target'.
`<T extends XString> T`	`getTargetTo(XString.Factory<T> factory)` Copies the value of this String field into a new XString from the given factory.
`void`	`getTargetTo(XString val)` Copies the value of 'target' into the provided XString.
`XString`	`getTargetUnsafe()` Gets the raw value of 'target'.
`String`	`getXvmName()` Gets the value of 'xvmName'.
`<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`	`hasCommandName()` Checks for the presence of 'commandName'.
`boolean`	`hasCorrelationId()` Checks for the presence of 'correlationId'.
`boolean`	`hasTarget()` Checks for the presence of 'target'.
`boolean`	`hasXvmName()` Checks for the presence of 'xvmName'.
`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`	`lendCommandName(XString val)` Lends the value of 'commandName' to this object.
`void`	`lendTarget(XString val)` Lends the value of 'target' to this object.
`void`	`lendXvmName(XString val)` Lends the value of 'xvmName' to this object.
`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(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(XString val)` Copies the provided XString value into this object's 'adminClientId'.
`void`	`setCommandName(String val)` Sets the value of 'commandName'.
`void`	`setCommandNameFrom(long val)` Sets the value of this String field to the given numeric value.
`void`	`setCommandNameFrom(XString val)` Copies the provided XString value into this object's 'commandName'.
`void`	`setCorrelationId(long val)` Sets the value of 'correlationId'.
`void`	`setCorrelationIdAsObject(Long val)` Sets the value of 'correlationId'.
`void`	`setParameters(String[] val)` Sets the value of 'parameters'.
`void`	`setParametersFrom(XIterator<String> val)` Sets the value of 'parameters' using the values from the provided iterator.
`void`	`setTarget(String val)` Sets the value of 'target'.
`void`	`setTargetFrom(long val)` Sets the value of this String field to the given numeric value.
`void`	`setTargetFrom(XString val)` Copies the provided XString value into this object's 'target'.
`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'.

Methods inherited from interface com.neeve.ods.IStoreObject
acquire, deserialize, deserializeMetadata, deserializeMetadata, getContentEncodingType, getOwnershipCount, getSerializedMetadataLength, getStoreMetadata, saveMemory, serialize, serializeMetadata, setFieldValue

Methods inherited from interface com.neeve.ods.IStoreObjectMetadata
ensureId, getBinding, getCheckpointVersion, getCommittedDataSize, getId, getOfid, getStableTransactionId, getTransactionId, setBinding, setCheckpointVersion, setCommittedDataSize, setId, setStableTransactionId, setTransactionId

Methods inherited from interface com.neeve.sma.MapMessageView
getMessageReflector

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

- Method Detail
  - setCorrelationId
```
void setCorrelationId(long val)
```
    Sets the value of 'correlationId'.
    Field Description
    The request correlation ID.
    
    Specified by:
    
    setCorrelationId in interface ISrvMonXvmRequest
    
    Parameters:
    
    val - The value to set.
  - setCorrelationIdAsObject
```
void setCorrelationIdAsObject(Long val)
```
    Sets the value of 'correlationId'.
    Field Description
    The request correlation ID.
    
    Specified by:
    
    setCorrelationIdAsObject in interface ISrvMonXvmRequest
    
    Parameters:
    
    val - The value to set.
  - getCorrelationId
```
long getCorrelationId()
```
    Gets the value of 'correlationId'.
    Field Description
    The request correlation ID.
    
    Specified by:
    
    getCorrelationId in interface ISrvMonXvmRequest
    
    Returns:
    
    The request correlation ID
  - getCorrelationIdAsObject
```
Long getCorrelationIdAsObject()
```
    Gets the value of 'correlationId'.
    Field Description
    The request correlation ID.
    
    Specified by:
    
    getCorrelationIdAsObject in interface ISrvMonXvmRequest
    
    Returns:
    
    The request correlation ID
  - clearCorrelationId
```
void clearCorrelationId()
```
    Clears the value of 'correlationId'.
    Field Description
    The request correlation ID.
    
    Specified by:
    
    clearCorrelationId in interface ISrvMonXvmRequest
    
    See Also:
    
    setCorrelationId(long)
  - hasCorrelationId
```
boolean hasCorrelationId()
```
    Checks for the presence of 'correlationId'.
    Field Description
    The request correlation ID.
    
    Specified by:
    
    hasCorrelationId in interface ISrvMonXvmRequest
    
    See Also:
    
    getCorrelationId()
  - setAdminClientId
```
void setAdminClientId(String val)
```
    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
```
String getAdminClientId()
```
    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
```
void lendAdminClientId(XString val)
```
    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.
    
    Throws:
    
    IllegalArgumentException - If the value is mutable.
  - setAdminClientIdFrom
```
void setAdminClientIdFrom(long val)
```
    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 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
```
<T extends XString> T getAdminClientIdTo(XString.Factory<T> factory)
```
    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.
    
    Throws:
    
    NullPointerException - if the provided factory is null
  - setAdminClientIdFrom
```
void setAdminClientIdFrom(XString val)
```
    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 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
```
void getAdminClientIdTo(XString val)
```
    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 getAdminClientId() bec because it can avoid decoding the value into an String.
    
    Specified by:
    
    getAdminClientIdTo in interface ISrvMonXvmRequest
    
    See Also:
    
    getAdminClientId()
  - getAdminClientIdUnsafe
```
XString getAdminClientIdUnsafe()
```
    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:
    
    getAdminClientId()
  - clearAdminClientId
```
void clearAdminClientId()
```
    Clears the value of 'adminClientId'.
    Field Description
    The admin client targeted in the command exchange.
    
    Specified by:
    
    clearAdminClientId in interface ISrvMonXvmRequest
    
    See Also:
    
    setAdminClientId(String)
  - hasAdminClientId
```
boolean hasAdminClientId()
```
    Checks for the presence of 'adminClientId'.
    Field Description
    The admin client targeted in the command exchange.
    
    Specified by:
    
    hasAdminClientId in interface ISrvMonXvmRequest
    
    See Also:
    
    getAdminClientId()
  - setXvmName
```
void setXvmName(String val)
```
    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
```
String getXvmName()
```
    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
```
void lendXvmName(XString val)
```
    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.
    
    Throws:
    
    IllegalArgumentException - If the value is mutable.
  - setXvmNameFrom
```
void setXvmNameFrom(long val)
```
    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 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
```
<T extends XString> T getXvmNameTo(XString.Factory<T> factory)
```
    Copies the value of this String field into a new XString from the given factory.
    Field Description
    The name of the XVM 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.
    
    Throws:
    
    NullPointerException - if the provided factory is null
  - setXvmNameFrom
```
void setXvmNameFrom(XString val)
```
    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 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
```
void getXvmNameTo(XString val)
```
    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 getXvmName() bec because it can avoid decoding the value into an String.
    
    Specified by:
    
    getXvmNameTo in interface ISrvMonXvmRequest
    
    See Also:
    
    getXvmName()
  - getXvmNameUnsafe
```
XString getXvmNameUnsafe()
```
    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:
    
    getXvmName()
  - clearXvmName
```
void clearXvmName()
```
    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:
    
    setXvmName(String)
  - hasXvmName
```
boolean hasXvmName()
```
    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:
    
    getXvmName()
  - setAdminClientCompatLevel
```
void setAdminClientCompatLevel(String val)
```
    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
```
String getAdminClientCompatLevel()
```
    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
```
void lendAdminClientCompatLevel(XString val)
```
    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.
    
    Throws:
    
    IllegalArgumentException - If the value is mutable.
  - setAdminClientCompatLevelFrom
```
void setAdminClientCompatLevelFrom(long val)
```
    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 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
```
<T extends XString> T getAdminClientCompatLevelTo(XString.Factory<T> factory)
```
    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.
    
    Throws:
    
    NullPointerException - if the provided factory is null
  - setAdminClientCompatLevelFrom
```
void setAdminClientCompatLevelFrom(XString val)
```
    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 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
```
void getAdminClientCompatLevelTo(XString val)
```
    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 getAdminClientCompatLevel() bec because it can avoid decoding the value into an String.
    
    Specified by:
    
    getAdminClientCompatLevelTo in interface ISrvMonXvmRequest
    
    See Also:
    
    getAdminClientCompatLevel()
  - getAdminClientCompatLevelUnsafe
```
XString getAdminClientCompatLevelUnsafe()
```
    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:
    
    getAdminClientCompatLevel()
  - clearAdminClientCompatLevel
```
void clearAdminClientCompatLevel()
```
    Clears the value of 'adminClientCompatLevel'.
    Field Description
    The admin client's compatibility level.
    
    Specified by:
    
    clearAdminClientCompatLevel in interface ISrvMonXvmRequest
    
    See Also:
    
    setAdminClientCompatLevel(String)
  - hasAdminClientCompatLevel
```
boolean hasAdminClientCompatLevel()
```
    Checks for the presence of 'adminClientCompatLevel'.
    Field Description
    The admin client's compatibility level.
    
    Specified by:
    
    hasAdminClientCompatLevel in interface ISrvMonXvmRequest
    
    See Also:
    
    getAdminClientCompatLevel()
  - setTarget
```
void setTarget(String val)
```
    Sets the value of 'target'.
    Field Description
    The target (e.g. app) on which to invoke the command.
    
    Parameters:
    
    val - The value to set.
  - getTarget
```
String getTarget()
```
    Gets the value of 'target'.
    Field Description
    The target (e.g. app) on which to invoke the command.
    
    Returns:
    
    The target (e.g. app) on which to invoke the command.
  - lendTarget
```
void lendTarget(XString val)
```
    Lends the value of 'target' to this object.
    This method is equivalent to setTarget 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 target (e.g. app) on which to invoke the command.
    Usage Notes
    Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.
    Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
    
    Parameters:
    
    val - The value to set.
    
    Throws:
    
    IllegalArgumentException - If the value is mutable.
  - setTargetFrom
```
void setTargetFrom(long val)
```
    Sets the value of this String field to the given numeric value.
    Field Description
    The target (e.g. app) on which to invoke the command.
    NOTE:
    This is the same as calling setTarget(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.
  - getTargetTo
```
<T extends XString> T getTargetTo(XString.Factory<T> factory)
```
    Copies the value of this String field into a new XString from the given factory.
    Field Description
    The target (e.g. app) on which to invoke the command.
    If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);
    This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;
    
    Parameters:
    
    factory - The factory from which to get the XString to copy into and return
    
    Returns:
    
    a new XString from the provided factory if this field is set or null.
    
    Throws:
    
    NullPointerException - if the provided factory is null
  - setTargetFrom
```
void setTargetFrom(XString val)
```
    Copies the provided XString value into this object's 'target'.
    Field Description
    The target (e.g. app) on which to invoke the command.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than setTarget(String) because it avoids encoding the value into a String if the given XString is already encoded.
  - getTargetTo
```
void getTargetTo(XString val)
```
    Copies the value of 'target' into the provided XString.
    Field Description
    The target (e.g. app) on which to invoke the command.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than getTarget() bec because it can avoid decoding the value into an String.
    
    See Also:
    
    getTarget()
  - getTargetUnsafe
```
XString getTargetUnsafe()
```
    Gets the raw value of 'target'.
    Field Description
    The target (e.g. app) on which to invoke the command.
    NOTE:
    This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.
    However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.
    Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.
    
    Returns:
    
    the field's raw value
    
    See Also:
    
    getTarget()
  - clearTarget
```
void clearTarget()
```
    Clears the value of 'target'.
    Field Description
    The target (e.g. app) on which to invoke the command.
    
    See Also:
    
    setTarget(String)
  - hasTarget
```
boolean hasTarget()
```
    Checks for the presence of 'target'.
    Field Description
    The target (e.g. app) on which to invoke the command.
    
    See Also:
    
    getTarget()
  - setCommandName
```
void setCommandName(String val)
```
    Sets the value of 'commandName'.
    Field Description
    The name of the command to invoke.
    
    Parameters:
    
    val - The value to set.
  - getCommandName
```
String getCommandName()
```
    Gets the value of 'commandName'.
    Field Description
    The name of the command to invoke.
    
    Returns:
    
    The name of the command to invoke.
  - lendCommandName
```
void lendCommandName(XString val)
```
    Lends the value of 'commandName' to this object.
    This method is equivalent to setCommandName 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 command to invoke.
    Usage Notes
    Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.
    Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
    
    Parameters:
    
    val - The value to set.
    
    Throws:
    
    IllegalArgumentException - If the value is mutable.
  - setCommandNameFrom
```
void setCommandNameFrom(long val)
```
    Sets the value of this String field to the given numeric value.
    Field Description
    The name of the command to invoke.
    NOTE:
    This is the same as calling setCommandName(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.
  - getCommandNameTo
```
<T extends XString> T getCommandNameTo(XString.Factory<T> factory)
```
    Copies the value of this String field into a new XString from the given factory.
    Field Description
    The name of the command to invoke.
    If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);
    This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;
    
    Parameters:
    
    factory - The factory from which to get the XString to copy into and return
    
    Returns:
    
    a new XString from the provided factory if this field is set or null.
    
    Throws:
    
    NullPointerException - if the provided factory is null
  - setCommandNameFrom
```
void setCommandNameFrom(XString val)
```
    Copies the provided XString value into this object's 'commandName'.
    Field Description
    The name of the command to invoke.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than setCommandName(String) because it avoids encoding the value into a String if the given XString is already encoded.
  - getCommandNameTo
```
void getCommandNameTo(XString val)
```
    Copies the value of 'commandName' into the provided XString.
    Field Description
    The name of the command to invoke.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than getCommandName() bec because it can avoid decoding the value into an String.
    
    See Also:
    
    getCommandName()
  - getCommandNameUnsafe
```
XString getCommandNameUnsafe()
```
    Gets the raw value of 'commandName'.
    Field Description
    The name of the command to invoke.
    NOTE:
    This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.
    However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.
    Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.
    
    Returns:
    
    the field's raw value
    
    See Also:
    
    getCommandName()
  - clearCommandName
```
void clearCommandName()
```
    Clears the value of 'commandName'.
    Field Description
    The name of the command to invoke.
    
    See Also:
    
    setCommandName(String)
  - hasCommandName
```
boolean hasCommandName()
```
    Checks for the presence of 'commandName'.
    Field Description
    The name of the command to invoke.
    
    See Also:
    
    getCommandName()
  - setParameters
```
void setParameters(String[] val)
```
    Sets the value of 'parameters'.
    Field Description
    The list of options and arguments for the command.
    
    For example when invoking MyApp doSend --rate 20 --count 1000 true the parameters would look like:
    - --rate
    - 20
    - --count
    - 1000
    - true
    Parameters:
    
    val - The value to set.
  - setParametersFrom
```
void setParametersFrom(XIterator<String> val)
```
    Sets the value of 'parameters' using the values from the provided iterator.
    This method will call XIterator.toFirst() before and after setting the values, meaning that all values from the iterator will be set and the iterator will be reset on return.
    
    This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'parameters' accessor can copy the values without iteration.
    
    Field Description
    The list of options and arguments for the command.
    
    For example when invoking MyApp doSend --rate 20 --count 1000 true the parameters would look like:
    - --rate
    - 20
    - --count
    - 1000
    - true
    NOTE:
    Passing a null or empty iterator has the same affect as calling setParameters(String[]) with a value of null.
    Parameters:
    
    val - the values to set.
  - addParameters
```
void addParameters(String val)
```
    Adds the provided value to the list of 'parameters' values.
    This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'parameters' accessor can copy the values without iteration.
    
    For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.
    
    Field Description
    The list of options and arguments for the command.
    
    For example when invoking MyApp doSend --rate 20 --count 1000 true the parameters would look like:
    - --rate
    - 20
    - --count
    - 1000
    - true
    Parameters:
    
    val - the value to add.
  - getParametersIterator
```
XStringIterator getParametersIterator()
```
    Gets the value of 'parameters' as iterator of values.
    This method will always return a non null iterator value. The returned iterator is not threadsafe, and the caller may not hold on to it beyond the pooling lifespan of this object. Depending on the implementation, the same iterator instance may be returned by this object on each call to avoid garbage. Each time this method is called the iterator is reset by calling its toFirst() method. Callers should therefore be especially careful about calling this method while iterating on the iterator returned by this method.
    
    This method is zero garbage for Xbuf generated classes, and this method is optimized such that passing the returned iterator to another object's setXXX(com.neeve.lang.XStringIterator) method can perform a direct copy of the underlying values without iteration.
    
    Field Description
    The list of options and arguments for the command.
    
    For example when invoking MyApp doSend --rate 20 --count 1000 true the parameters would look like:
    - --rate
    - 20
    - --count
    - 1000
    - true
    Returns:
    
    An XStringIterator containing this field values.
  - getParameters
```
String[] getParameters()
```
    Gets the value of 'parameters'.
    If the field is not set this method will return null.
    Field Description
    The list of options and arguments for the command.
    
    For example when invoking MyApp doSend --rate 20 --count 1000 true the parameters would look like:
    - --rate
    - 20
    - --count
    - 1000
    - true
    Returns:
    
    The list of options and arguments for the command. If the field is not set this method will return null.
  - getParametersEmptyIfNull
```
String[] getParametersEmptyIfNull()
```
    Gets the value of 'parameters' or an empty array if the value is null or not set.
    Field Description
    The list of options and arguments for the command.
    
    For example when invoking MyApp doSend --rate 20 --count 1000 true the parameters would look like:
    - --rate
    - 20
    - --count
    - 1000
    - true
    Returns:
    
    The list of options and arguments for the command. or an empty array if null if not set.
    
    See Also:
    
    getParameters()
  - clearParameters
```
void clearParameters()
```
    Clears the value of 'parameters'.
    Field Description
    The list of options and arguments for the command.
    
    For example when invoking MyApp doSend --rate 20 --count 1000 true the parameters would look like:
    - --rate
    - 20
    - --count
    - 1000
    - true
    See Also:
    
    setParameters(String[])
  - copy
```
SrvMonInvokeCommandRequest copy()
```
    Creates a copy of this SrvMonInvokeCommandRequest.
    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 SrvMonInvokeCommandRequest's embedded entity fields.
    The returned copy will be writeable even if this SrvMonInvokeCommandRequest is read only.
    No metadata is copied except as documented IRogCopyableNode. See IRogCopyableNode for more detailed information on the semantics of this method.
    
    Specified by:
    
    copy in interface CopyableMessageView<ISrvMonInvokeCommandRequest>
    
    Specified by:
    
    copy in interface IRogCopyableNode<ISrvMonInvokeCommandRequest>
    
    Returns:
    
    A copy of this SrvMonInvokeCommandRequest.
    
    See Also:
    
    IRogCopyableNode, CopyableMessageView
  - copyInto
```
void copyInto(SrvMonInvokeCommandRequest target)
```
    Copies the contents of this SrvMonInvokeCommandRequest 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 SrvMonInvokeCommandRequest's embedded entity fields.
    The returned copy will be writeable even if this SrvMonInvokeCommandRequest is read only.
    No metadata is copied except as documented IRogCopyableNode. See IRogCopyableNode for more detailed information on the semantics of this method.
    
    Parameters:
    
    target - The target to copy into which must not be null or read only.

Interface ISrvMonInvokeCommandRequest

ADM Details

Nested Class Summary

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

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

Method Summary

Methods inherited from interface com.neeve.rog.IRogNode

Methods inherited from interface com.neeve.ods.IStoreObject

Methods inherited from interface com.neeve.ods.IStoreObjectMetadata

Methods inherited from interface com.neeve.sma.MapMessageView

Methods inherited from interface com.neeve.rog.IRogMetadata

Methods inherited from interface com.neeve.rog.IRogValidatable

Method Detail

setCorrelationId

Field Description

setCorrelationIdAsObject

Field Description

getCorrelationId

Field Description

getCorrelationIdAsObject

Field Description

clearCorrelationId

Field Description

hasCorrelationId

Field Description

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

clearAdminClientId

Field Description

hasAdminClientId

Field Description

setXvmName

Field Description

getXvmName

Field Description

lendXvmName

Field Description

Usage Notes

setXvmNameFrom

Field Description

getXvmNameTo

Field Description

setXvmNameFrom

Field Description

getXvmNameTo

Field Description

getXvmNameUnsafe

Field Description

clearXvmName

Field Description

hasXvmName

Field Description

setAdminClientCompatLevel

Field Description

getAdminClientCompatLevel

Field Description

lendAdminClientCompatLevel

Field Description

Usage Notes

setAdminClientCompatLevelFrom

Field Description

getAdminClientCompatLevelTo

Field Description

setAdminClientCompatLevelFrom

Field Description