com.neeve.server.mon.alert
Interface ISrvMonAppStatsAlertMessage

All Superinterfaces:

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

All Known Implementing Classes:

SrvMonAppStatsAlertMessage

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

Event notifying an AEP application of a statistics triggered alert.

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	clearAlertType() Clears the value of 'alertType' Field Description The type of the alert (AboveThreshold, BelowThreshold or Abated).
void	clearMetricAlertThreshold() Clears the value of 'metricAlertThreshold' Field Description The threshold value that triggered the alert.
void	clearMetricName() Clears the value of 'metricName' Field Description The name of the metric that triggered the alert.
void	clearMetricValue() Clears the value of 'metricValue' Field Description The value of the metric when the alert was triggered.
void	clearTimestamp() Clears the value of 'timestamp' Field Description The timestamp at which this event occurred (millis since the epoch).
SrvMonAppStatsAlertMessage	copy() Creates a copy of this SrvMonAppStatsAlertMessage.
void	copyInto(SrvMonAppStatsAlertMessage target) Copies the contents of this SrvMonAppStatsAlertMessage into the target.
String	getAlertType() Gets the value of 'alertType' Field Description The type of the alert (AboveThreshold, BelowThreshold or Abated).
<T extends XString> T	getAlertTypeTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getAlertTypeTo(XString val) Copies the value of 'alertType' into the provided XString.
XString	getAlertTypeUnsafe() Gets the raw value of 'alertType'.
String	getMetricAlertThreshold() Gets the value of 'metricAlertThreshold' Field Description The threshold value that triggered the alert.
<T extends XString> T	getMetricAlertThresholdTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getMetricAlertThresholdTo(XString val) Copies the value of 'metricAlertThreshold' into the provided XString.
XString	getMetricAlertThresholdUnsafe() Gets the raw value of 'metricAlertThreshold'.
String	getMetricName() Gets the value of 'metricName' Field Description The name of the metric that triggered the alert.
<T extends XString> T	getMetricNameTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getMetricNameTo(XString val) Copies the value of 'metricName' into the provided XString.
XString	getMetricNameUnsafe() Gets the raw value of 'metricName'.
String	getMetricValue() Gets the value of 'metricValue' Field Description The value of the metric when the alert was triggered.
<T extends XString> T	getMetricValueTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getMetricValueTo(XString val) Copies the value of 'metricValue' into the provided XString.
XString	getMetricValueUnsafe() Gets the raw value of 'metricValue'.
long	getTimestamp() Gets the value of 'timestamp' Field Description The timestamp at which this event occurred (millis since the epoch).
boolean	hasAlertType() Checks for the presence of 'alertType' Field Description The type of the alert (AboveThreshold, BelowThreshold or Abated).
boolean	hasMetricAlertThreshold() Checks for the presence of 'metricAlertThreshold' Field Description The threshold value that triggered the alert.
boolean	hasMetricName() Checks for the presence of 'metricName' Field Description The name of the metric that triggered the alert.
boolean	hasMetricValue() Checks for the presence of 'metricValue' Field Description The value of the metric when the alert was triggered.
boolean	hasTimestamp() Checks for the presence of 'timestamp' Field Description The timestamp at which this event occurred (millis since the epoch).
void	lendAlertType(XString val) Sets the value of 'alertType' Field Description The type of the alert (AboveThreshold, BelowThreshold or Abated).
void	lendMetricAlertThreshold(XString val) Sets the value of 'metricAlertThreshold' Field Description The threshold value that triggered the alert.
void	lendMetricName(XString val) Sets the value of 'metricName' Field Description The name of the metric that triggered the alert.
void	lendMetricValue(XString val) Sets the value of 'metricValue' Field Description The value of the metric when the alert was triggered.
void	setAlertType(String val) Sets the value of 'alertType' Field Description The type of the alert (AboveThreshold, BelowThreshold or Abated).
void	setAlertTypeFrom(long val) Sets the value of this String field to the given numeric value.
void	setAlertTypeFrom(XString val) Copies the provided XString value into this object's 'alertType'.
void	setMetricAlertThreshold(String val) Sets the value of 'metricAlertThreshold' Field Description The threshold value that triggered the alert.
void	setMetricAlertThresholdFrom(long val) Sets the value of this String field to the given numeric value.
void	setMetricAlertThresholdFrom(XString val) Copies the provided XString value into this object's 'metricAlertThreshold'.
void	setMetricName(String val) Sets the value of 'metricName' Field Description The name of the metric that triggered the alert.
void	setMetricNameFrom(long val) Sets the value of this String field to the given numeric value.
void	setMetricNameFrom(XString val) Copies the provided XString value into this object's 'metricName'.
void	setMetricValue(String val) Sets the value of 'metricValue' Field Description The value of the metric when the alert was triggered.
void	setMetricValueFrom(long val) Sets the value of this String field to the given numeric value.
void	setMetricValueFrom(XString val) Copies the provided XString value into this object's 'metricValue'.
void	setTimestamp(long val) Sets the value of 'timestamp' Field Description The timestamp at which this event occurred (millis since the epoch).

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

setTimestamp

void setTimestamp(long val)

Sets the value of 'timestamp'

Field Description

The timestamp at which this event occurred (millis since the epoch).

Parameters:

val - The value to set.

getTimestamp

long getTimestamp()

Gets the value of 'timestamp'

Field Description

The timestamp at which this event occurred (millis since the epoch).

Returns:

The timestamp at which this event occurred (millis since the epoch).

clearTimestamp

void clearTimestamp()

Clears the value of 'timestamp'

Field Description

The timestamp at which this event occurred (millis since the epoch).

See Also:

setTimestamp(long)

hasTimestamp

boolean hasTimestamp()

Checks for the presence of 'timestamp'

Field Description

The timestamp at which this event occurred (millis since the epoch).

See Also:

getTimestamp()

setMetricName

void setMetricName(String val)

Sets the value of 'metricName'

Field Description

The name of the metric that triggered the alert.

Parameters:

val - The value to set.

getMetricName

String getMetricName()

Gets the value of 'metricName'

Field Description

The name of the metric that triggered the alert.

Returns:

The name of the metric that triggered the alert.

lendMetricName

void lendMetricName(XString val)

Sets the value of 'metricName'

Field Description

The name of the metric that triggered the alert.

Parameters:

val - The value to set.

setMetricNameFrom

void setMetricNameFrom(long val)

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

Field Description

The name of the metric that triggered the alert.

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

getMetricNameTo

<T extends XString> T getMetricNameTo(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 metric that triggered the alert.

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

setMetricNameFrom

void setMetricNameFrom(XString val)

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

Field Description

The name of the metric that triggered the alert.

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

getMetricNameTo

void getMetricNameTo(XString val)

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

Field Description

The name of the metric that triggered the alert.

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

See Also:

getMetricName()

getMetricNameUnsafe

XString getMetricNameUnsafe()

Gets the raw value of 'metricName'.

Field Description

The name of the metric that triggered the alert.

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:

getMetricName()

clearMetricName

void clearMetricName()

Clears the value of 'metricName'

Field Description

The name of the metric that triggered the alert.

See Also:

setMetricName(String)

hasMetricName

boolean hasMetricName()

Checks for the presence of 'metricName'

Field Description

The name of the metric that triggered the alert.

See Also:

getMetricName()

setMetricValue

void setMetricValue(String val)

Sets the value of 'metricValue'

Field Description

The value of the metric when the alert was triggered.

Parameters:

val - The value to set.

getMetricValue

String getMetricValue()

Gets the value of 'metricValue'

Field Description

The value of the metric when the alert was triggered.

Returns:

The value of the metric when the alert was triggered.

lendMetricValue

void lendMetricValue(XString val)

Sets the value of 'metricValue'

Field Description

The value of the metric when the alert was triggered.

Parameters:

val - The value to set.

setMetricValueFrom

void setMetricValueFrom(long val)

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

Field Description

The value of the metric when the alert was triggered.

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

getMetricValueTo

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

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

Field Description

The value of the metric when the alert was triggered.

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

setMetricValueFrom

void setMetricValueFrom(XString val)

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

Field Description

The value of the metric when the alert was triggered.

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

getMetricValueTo

void getMetricValueTo(XString val)

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

Field Description

The value of the metric when the alert was triggered.

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

See Also:

getMetricValue()

getMetricValueUnsafe

XString getMetricValueUnsafe()

Gets the raw value of 'metricValue'.

Field Description

The value of the metric when the alert was triggered.

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:

getMetricValue()

clearMetricValue

void clearMetricValue()

Clears the value of 'metricValue'

Field Description

The value of the metric when the alert was triggered.

See Also:

setMetricValue(String)

hasMetricValue

boolean hasMetricValue()

Checks for the presence of 'metricValue'

Field Description

The value of the metric when the alert was triggered.

See Also:

getMetricValue()

setMetricAlertThreshold

void setMetricAlertThreshold(String val)

Sets the value of 'metricAlertThreshold'

Field Description

The threshold value that triggered the alert.

Parameters:

val - The value to set.

getMetricAlertThreshold

String getMetricAlertThreshold()

Gets the value of 'metricAlertThreshold'

Field Description

The threshold value that triggered the alert.

Returns:

The threshold value that triggered the alert.

lendMetricAlertThreshold

void lendMetricAlertThreshold(XString val)

Sets the value of 'metricAlertThreshold'

Field Description

The threshold value that triggered the alert.

Parameters:

val - The value to set.

setMetricAlertThresholdFrom

void setMetricAlertThresholdFrom(long val)

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

Field Description

The threshold value that triggered the alert.

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

getMetricAlertThresholdTo

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

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

Field Description

The threshold value that triggered the alert.

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

setMetricAlertThresholdFrom

void setMetricAlertThresholdFrom(XString val)

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

Field Description

The threshold value that triggered the alert.

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

getMetricAlertThresholdTo

void getMetricAlertThresholdTo(XString val)

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

Field Description

The threshold value that triggered the alert.

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

See Also:

getMetricAlertThreshold()

getMetricAlertThresholdUnsafe

XString getMetricAlertThresholdUnsafe()

Gets the raw value of 'metricAlertThreshold'.

Field Description

The threshold value that triggered the alert.

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:

getMetricAlertThreshold()

clearMetricAlertThreshold

void clearMetricAlertThreshold()

Clears the value of 'metricAlertThreshold'

Field Description

The threshold value that triggered the alert.

See Also:

setMetricAlertThreshold(String)

hasMetricAlertThreshold

boolean hasMetricAlertThreshold()

Checks for the presence of 'metricAlertThreshold'

Field Description

The threshold value that triggered the alert.

See Also:

getMetricAlertThreshold()

setAlertType

void setAlertType(String val)

Sets the value of 'alertType'

Field Description

The type of the alert (AboveThreshold, BelowThreshold or Abated).

Parameters:

val - The value to set.

getAlertType

String getAlertType()

Gets the value of 'alertType'

Field Description

The type of the alert (AboveThreshold, BelowThreshold or Abated).

Returns:

The type of the alert (AboveThreshold, BelowThreshold or Abated).

lendAlertType

void lendAlertType(XString val)

Sets the value of 'alertType'

Field Description

The type of the alert (AboveThreshold, BelowThreshold or Abated).

Parameters:

val - The value to set.

setAlertTypeFrom

void setAlertTypeFrom(long val)

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

Field Description

The type of the alert (AboveThreshold, BelowThreshold or Abated).

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

getAlertTypeTo

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

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

Field Description

The type of the alert (AboveThreshold, BelowThreshold or Abated).

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

setAlertTypeFrom

void setAlertTypeFrom(XString val)

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

Field Description

The type of the alert (AboveThreshold, BelowThreshold or Abated).

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

getAlertTypeTo

void getAlertTypeTo(XString val)

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

Field Description

The type of the alert (AboveThreshold, BelowThreshold or Abated).

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

See Also:

getAlertType()

getAlertTypeUnsafe

XString getAlertTypeUnsafe()

Gets the raw value of 'alertType'.

Field Description

The type of the alert (AboveThreshold, BelowThreshold or Abated).

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:

getAlertType()

clearAlertType

void clearAlertType()

Clears the value of 'alertType'

Field Description

The type of the alert (AboveThreshold, BelowThreshold or Abated).

See Also:

setAlertType(String)

hasAlertType

boolean hasAlertType()

Checks for the presence of 'alertType'

Field Description

The type of the alert (AboveThreshold, BelowThreshold or Abated).

See Also:

getAlertType()

copy

SrvMonAppStatsAlertMessage copy()

Creates a copy of this SrvMonAppStatsAlertMessage.

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

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

Specified by:

copy in interface IRogCopyableNode<ISrvMonAppStatsAlertMessage>

Returns:

A copy of this SrvMonAppStatsAlertMessage.

See Also:

IRogCopyableNode, CopyableMessageView

copyInto

void copyInto(SrvMonAppStatsAlertMessage target)

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

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