com.neeve.server.mon.cnc
Interface ISrvMonServerInfoResponse

All Superinterfaces:

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

All Known Implementing Classes:

SrvMonServerInfoResponse

@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 ISrvMonServerInfoResponse
extends IRogNode, IRogMessage, IRogCopyableNode<ISrvMonServerInfoResponse>

Response containing server details.

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	clearSystemName() Clears the value of 'systemName' Field Description The system name to which the server belongs.
void	clearSystemVersion() Clears the value of 'systemVersion' Field Description The version of the system to which the server belongs.
SrvMonServerInfoResponse	copy() Creates a copy of this SrvMonServerInfoResponse.
void	copyInto(SrvMonServerInfoResponse target) Copies the contents of this SrvMonServerInfoResponse into the target.
String	getSystemName() Gets the value of 'systemName' Field Description The system name to which the server belongs.
<T extends XString> T	getSystemNameTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getSystemNameTo(XString val) Copies the value of 'systemName' into the provided XString.
XString	getSystemNameUnsafe() Gets the raw value of 'systemName'.
String	getSystemVersion() Gets the value of 'systemVersion' Field Description The version of the system to which the server belongs.
<T extends XString> T	getSystemVersionTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getSystemVersionTo(XString val) Copies the value of 'systemVersion' into the provided XString.
XString	getSystemVersionUnsafe() Gets the raw value of 'systemVersion'.
boolean	hasSystemName() Checks for the presence of 'systemName' Field Description The system name to which the server belongs.
boolean	hasSystemVersion() Checks for the presence of 'systemVersion' Field Description The version of the system to which the server belongs.
void	lendSystemName(XString val) Sets the value of 'systemName' Field Description The system name to which the server belongs.
void	lendSystemVersion(XString val) Sets the value of 'systemVersion' Field Description The version of the system to which the server belongs.
void	setSystemName(String val) Sets the value of 'systemName' Field Description The system name to which the server belongs.
void	setSystemNameFrom(long val) Sets the value of this String field to the given numeric value.
void	setSystemNameFrom(XString val) Copies the provided XString value into this object's 'systemName'.
void	setSystemVersion(String val) Sets the value of 'systemVersion' Field Description The version of the system to which the server belongs.
void	setSystemVersionFrom(long val) Sets the value of this String field to the given numeric value.
void	setSystemVersionFrom(XString val) Copies the provided XString value into this object's 'systemVersion'.

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

setSystemName

void setSystemName(String val)

Sets the value of 'systemName'

Field Description

The system name to which the server belongs.

Parameters:

val - The value to set.

getSystemName

String getSystemName()

Gets the value of 'systemName'

Field Description

The system name to which the server belongs.

Returns:

the system name to which the server belongs.

lendSystemName

void lendSystemName(XString val)

Sets the value of 'systemName'

Field Description

The system name to which the server belongs.

Parameters:

val - The value to set.

setSystemNameFrom

void setSystemNameFrom(long val)

Sets the value of this String field to the given numeric value.

Field Description

The system name to which the server belongs.

NOTE:
This is the same as calling setSystemName(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

getSystemNameTo

<T extends XString> T getSystemNameTo(XString.Factory<T> factory)

Copies the value of this String field into a new XString from the given factory.

Field Description

The system name to which the server belongs.

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

setSystemNameFrom

void setSystemNameFrom(XString val)

Copies the provided XString value into this object's 'systemName'.

Field Description

The system name to which the server belongs.

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than setSystemName(String) because it avoids encoding the value into a String if the given XString is already encoded.

getSystemNameTo

void getSystemNameTo(XString val)

Copies the value of 'systemName' into the provided XString.

Field Description

The system name to which the server belongs.

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than getSystemName() bec because it can avoid decoding the value into an String.

See Also:

getSystemName()

getSystemNameUnsafe

XString getSystemNameUnsafe()

Gets the raw value of 'systemName'.

Field Description

The system name to which the server belongs.

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:

getSystemName()

clearSystemName

void clearSystemName()

Clears the value of 'systemName'

Field Description

The system name to which the server belongs.

See Also:

setSystemName(String)

hasSystemName

boolean hasSystemName()

Checks for the presence of 'systemName'

Field Description

The system name to which the server belongs.

See Also:

getSystemName()

setSystemVersion

void setSystemVersion(String val)

Sets the value of 'systemVersion'

Field Description

The version of the system to which the server belongs.

Parameters:

val - The value to set.

getSystemVersion

String getSystemVersion()

Gets the value of 'systemVersion'

Field Description

The version of the system to which the server belongs.

Returns:

the version of the system to which the server belongs.

lendSystemVersion

void lendSystemVersion(XString val)

Sets the value of 'systemVersion'

Field Description

The version of the system to which the server belongs.

Parameters:

val - The value to set.

setSystemVersionFrom

void setSystemVersionFrom(long val)

Sets the value of this String field to the given numeric value.

Field Description

The version of the system to which the server belongs.

NOTE:
This is the same as calling setSystemVersion(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

getSystemVersionTo

<T extends XString> T getSystemVersionTo(XString.Factory<T> factory)

Copies the value of this String field into a new XString from the given factory.

Field Description

The version of the system to which the server belongs.

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

setSystemVersionFrom

void setSystemVersionFrom(XString val)

Copies the provided XString value into this object's 'systemVersion'.

Field Description

The version of the system to which the server belongs.

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than setSystemVersion(String) because it avoids encoding the value into a String if the given XString is already encoded.

getSystemVersionTo

void getSystemVersionTo(XString val)

Copies the value of 'systemVersion' into the provided XString.

Field Description

The version of the system to which the server belongs.

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than getSystemVersion() bec because it can avoid decoding the value into an String.

See Also:

getSystemVersion()

getSystemVersionUnsafe

XString getSystemVersionUnsafe()

Gets the raw value of 'systemVersion'.

Field Description

The version of the system to which the server belongs.

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:

getSystemVersion()

clearSystemVersion

void clearSystemVersion()

Clears the value of 'systemVersion'

Field Description

The version of the system to which the server belongs.

See Also:

setSystemVersion(String)

hasSystemVersion

boolean hasSystemVersion()

Checks for the presence of 'systemVersion'

Field Description

The version of the system to which the server belongs.

See Also:

getSystemVersion()

copy

SrvMonServerInfoResponse copy()

Creates a copy of this SrvMonServerInfoResponse.

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 SrvMonServerInfoResponse's embedded entity fields.

The returned copy will be writeable even if this SrvMonServerInfoResponse 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<ISrvMonServerInfoResponse>

Specified by:

copy in interface IRogCopyableNode<ISrvMonServerInfoResponse>

Returns:

A copy of this SrvMonServerInfoResponse.

See Also:

IRogCopyableNode, CopyableMessageView

copyInto

void copyInto(SrvMonServerInfoResponse target)

Copies the contents of this SrvMonServerInfoResponse 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 SrvMonServerInfoResponse's embedded entity fields.

The returned copy will be writeable even if this SrvMonServerInfoResponse 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.