com.neeve.server.mon.cnc
Interface ISrvMonInvokeCommandRequest

All Superinterfaces:

CopyableMessageView<ISrvMonInvokeCommandRequest>, IRogCopyableNode<ISrvMonInvokeCommandRequest>, IRogMessage, IRogMetadata, IRogNode, IRogValidatable, IStoreObject, MapMessageView, MessageView, UtlReferenceTracker.HasReferenceTracker

All Known Implementing Classes:

SrvMonInvokeCommandRequest

@Generated(value="com.neeve.adm.AdmGenerator",
           date="Wed Mar 28 10:54:31 EDT 2018")
@AdmGenerated(compatLevel="3.8.0",
              admVersion="nvx-adm v3.7.265 (build 0)",
              date="3/28/18 10:54 AM",
              buildInfo="nvx-talon-3.7.265 (nvx-codegen-plugin)")
public interface ISrvMonInvokeCommandRequest
extends IRogNode, IRogMessage, IRogCopyableNode<ISrvMonInvokeCommandRequest>

Instructs the server to inoke a command.

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

void	addParameters(String val) Adds the provided value to the list of 'parameters' values.
void	clearCommandName() Clears the value of 'commandName' Field Description The name of the command to invoke
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
void	clearTarget() Clears the value of 'target' Field Description The target (e.g. app) on which to invoke the command
SrvMonInvokeCommandRequest	copy() Creates a copy of this SrvMonInvokeCommandRequest.
void	copyInto(SrvMonInvokeCommandRequest target) Copies the contents of this SrvMonInvokeCommandRequest into the target.
String	getCommandName() Gets the value of 'commandName' Field Description The name of the command to invoke
<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'.
String[]	getParameters() Gets the value of 'parameters' If the field is not set this method will return null.
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' Field Description The target (e.g. app) on which to invoke the command
<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'.
boolean	hasCommandName() Checks for the presence of 'commandName' Field Description The name of the command to invoke
boolean	hasTarget() Checks for the presence of 'target' Field Description The target (e.g. app) on which to invoke the command
void	lendCommandName(XString val) Sets the value of 'commandName' Field Description The name of the command to invoke
void	lendTarget(XString val) Sets the value of 'target' Field Description The target (e.g. app) on which to invoke the command
void	setCommandName(String val) Sets the value of 'commandName' Field Description The name of the command to invoke
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	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
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' Field Description The target (e.g. app) on which to invoke the command
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'.

Methods inherited from interface com.neeve.rog.IRogNode

deserializeFromProtobuf, dispose, dump, getAttachment, getIsPriority, getIsReadOnly, getMetadata, getParent, getPoolingListener, getType, metadataToJsonString, serializeToProtobuf, setAsInboundMessage, setAsInternal, setAsLastTransaction, setAsMessage, setAsOutboundMessage, setAsPriority, setAsReadOnly, setAsReplayedMessage, setAttachment, setInMsgsInTransaction, setOutMsgsInTransaction, setParentId, setPoolingListener, setTransactionInSequenceNumber, setTransactionOutSequenceNumber

Methods inherited from interface com.neeve.ods.IStoreObject

acquire, deserialize, deserializeMetadata, deserializeMetadata, ensureId, getBinding, getCheckpointVersion, getContentEncodingType, getId, getOfid, getOwnershipCount, getSerializedMetadataLength, getStableTransactionId, getTransactionId, serialize, serializeMetadata, setBinding, setCheckpointVersion, setFieldValue, setId, setStableTransactionId, setTransactionId

Methods inherited from interface com.neeve.sma.MapMessageView

getMessageReflector

Methods inherited from interface com.neeve.rog.IRogMetadata

getEnqueueTs, getEnqueueTsMicros, getGraphId, getInMsgsInTransaction, getIsInboundMessage, getIsInternal, getIsLastTransaction, getIsMessage, getIsOutboundMessage, getIsReplayedMessage, getMessageBus, getMessageChannel, getMessageFlow, getMessageKey, getMessageSender, getMessageSequenceNumber, getOutMsgsInTransaction, getOutTs, getOutTsMicros, getParentId, getPreProcessingTs, getPreProcessingTsMicros, getTransactionInSequenceNumber, getTransactionOutSequenceNumber, isPossibleDuplicate, metadataToJsonString, metadataToString

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Method Detail

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)

Sets the value of 'target'

Field Description

The target (e.g. app) on which to invoke the command

Parameters:

val - The value to set.

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)

Sets the value of 'commandName'

Field Description

The name of the command to invoke

Parameters:

val - The value to set.

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.