com.neeve.server.mon.cnc

Interface ISrvMonXvmRequest

All Superinterfaces:

IRogValidatable

All Known Subinterfaces:

ISrvMonGetLoadedAppsRequest, ISrvMonGetTraceHistoryRequest, ISrvMonInvokeCommandRequest, ISrvMonListCommandsRequest, ISrvMonStartAppWatchCommand, ISrvMonStartTraceWatchRequest, ISrvMonStopAppWatchCommand, ISrvMonStopTraceWatchRequest, ISrvMonXvmInfoRequest

All Known Implementing Classes:

SrvMonGetLoadedAppsRequest, SrvMonGetTraceHistoryRequest, SrvMonInvokeCommandRequest, SrvMonListCommandsRequest, SrvMonStartAppWatchCommand, SrvMonStartTraceWatchRequest, SrvMonStopAppWatchCommand, SrvMonStopTraceWatchRequest, SrvMonXvmInfoRequest, SrvMonXvmRequest

@Generated(value="com.neeve.adm.AdmGenerator",
           date="Thu May 07 15:37:32 EDT 2020")
@AdmGenerated(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)")
public interface ISrvMonXvmRequest
extends IRogValidatable

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	204	The admin client's compatibility level.
adminClientId	String	201	The admin client targeted in the command exchange.
correlationId	Long	202	The request correlation ID.
xvmName	String	203	The name of the XVM targeted in the command exchange.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAdminClientCompatLevel() Clears the value of 'adminClientCompatLevel'.
void	clearAdminClientId() Clears the value of 'adminClientId'.
void	clearCorrelationId() Clears the value of 'correlationId'.
void	clearXvmName() Clears the value of 'xvmName'.
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'.
long	getCorrelationId() Gets the value of 'correlationId'.
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	hasCorrelationId() Checks for the presence of 'correlationId'.
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	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	setCorrelationId(long val) Sets the value of 'correlationId'.
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.rog.IRogValidatable

getValidationErrors, isValid

Method Detail

setCorrelationId

void setCorrelationId(long val)

Sets the value of 'correlationId'.

Field Description

The request correlation ID.

Parameters:

val - The value to set.

getCorrelationId

long getCorrelationId()

Gets the value of 'correlationId'.

Field Description

The request correlation ID.

Returns:

The request correlation ID

clearCorrelationId

void clearCorrelationId()

Clears the value of 'correlationId'.

Field Description

The request correlation ID.

See Also:

setCorrelationId(long)

hasCorrelationId

boolean hasCorrelationId()

Checks for the presence of 'correlationId'.

Field Description

The request correlation ID.

See Also:

getCorrelationId()

setAdminClientId

void setAdminClientId(String val)

Sets the value of 'adminClientId'.

Field Description

The admin client targeted in the command exchange.

Parameters:

val - The value to set.

getAdminClientId

String getAdminClientId()

Gets the value of 'adminClientId'.

Field Description

The admin client targeted in the command exchange.

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.

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.

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;

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.

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.

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.

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.

See Also:

setAdminClientId(String)

hasAdminClientId

boolean hasAdminClientId()

Checks for the presence of 'adminClientId'.

Field Description

The admin client targeted in the command exchange.

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.

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.

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.

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.

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;

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.

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.

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.

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.

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.

See Also:

getXvmName()

setAdminClientCompatLevel

void setAdminClientCompatLevel(String val)

Sets the value of 'adminClientCompatLevel'.

Field Description

The admin client's compatibility level.

Parameters:

val - The value to set.

getAdminClientCompatLevel

String getAdminClientCompatLevel()

Gets the value of 'adminClientCompatLevel'.

Field Description

The admin client's compatibility level.

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.

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.

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;

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.

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.

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.

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.

See Also:

setAdminClientCompatLevel(String)

hasAdminClientCompatLevel

boolean hasAdminClientCompatLevel()

Checks for the presence of 'adminClientCompatLevel'.

Field Description

The admin client's compatibility level.

See Also:

getAdminClientCompatLevel()