com.neeve.server.mon.alert
Interface ISrvMonAppStuckAlertMessage

All Superinterfaces:

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

All Known Implementing Classes:

SrvMonAppStuckAlertMessage

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

Event used to notify of a stuck AepEngine.

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	clearDescription() Clears the value of 'description' Field Description A human readable description of the stuck alert condition.
void	clearIncompleteCommitCount() Clears the value of 'incompleteCommitCount' Field Description The number of commits that are outstanding (millis since the epoch).
void	clearLastCommitCompletionTimestamp() Clears the value of 'lastCommitCompletionTimestamp' Field Description The timestamp at which the last AepEngine commit completion was processed (millis since the epoch).
void	clearLastEventProcessedTimestamp() Clears the value of 'lastEventProcessedTimestamp' Field Description The timestamp at which the last AepEngine event was processed (millis since the epoch).
void	clearReason() Clears the value of 'reason' Field Description The reason for which the event was issued (a hung transaction pipeline or a hung message handler).
void	clearTimestamp() Clears the value of 'timestamp' Field Description The timestamp at which this event occurred (millis since the epoch).
SrvMonAppStuckAlertMessage	copy() Creates a copy of this SrvMonAppStuckAlertMessage.
void	copyInto(SrvMonAppStuckAlertMessage target) Copies the contents of this SrvMonAppStuckAlertMessage into the target.
String	getDescription() Gets the value of 'description' Field Description A human readable description of the stuck alert condition.
<T extends XString> T	getDescriptionTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getDescriptionTo(XString val) Copies the value of 'description' into the provided XString.
XString	getDescriptionUnsafe() Gets the raw value of 'description'.
int	getIncompleteCommitCount() Gets the value of 'incompleteCommitCount' Field Description The number of commits that are outstanding (millis since the epoch).
long	getLastCommitCompletionTimestamp() Gets the value of 'lastCommitCompletionTimestamp' Field Description The timestamp at which the last AepEngine commit completion was processed (millis since the epoch).
long	getLastEventProcessedTimestamp() Gets the value of 'lastEventProcessedTimestamp' Field Description The timestamp at which the last AepEngine event was processed (millis since the epoch).
String	getReason() Gets the value of 'reason' Field Description The reason for which the event was issued (a hung transaction pipeline or a hung message handler).
<T extends XString> T	getReasonTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getReasonTo(XString val) Copies the value of 'reason' into the provided XString.
XString	getReasonUnsafe() Gets the raw value of 'reason'.
long	getTimestamp() Gets the value of 'timestamp' Field Description The timestamp at which this event occurred (millis since the epoch).
boolean	hasDescription() Checks for the presence of 'description' Field Description A human readable description of the stuck alert condition.
boolean	hasIncompleteCommitCount() Checks for the presence of 'incompleteCommitCount' Field Description The number of commits that are outstanding (millis since the epoch).
boolean	hasLastCommitCompletionTimestamp() Checks for the presence of 'lastCommitCompletionTimestamp' Field Description The timestamp at which the last AepEngine commit completion was processed (millis since the epoch).
boolean	hasLastEventProcessedTimestamp() Checks for the presence of 'lastEventProcessedTimestamp' Field Description The timestamp at which the last AepEngine event was processed (millis since the epoch).
boolean	hasReason() Checks for the presence of 'reason' Field Description The reason for which the event was issued (a hung transaction pipeline or a hung message handler).
boolean	hasTimestamp() Checks for the presence of 'timestamp' Field Description The timestamp at which this event occurred (millis since the epoch).
void	lendDescription(XString val) Sets the value of 'description' Field Description A human readable description of the stuck alert condition.
void	lendReason(XString val) Sets the value of 'reason' Field Description The reason for which the event was issued (a hung transaction pipeline or a hung message handler).
void	setDescription(String val) Sets the value of 'description' Field Description A human readable description of the stuck alert condition.
void	setDescriptionFrom(long val) Sets the value of this String field to the given numeric value.
void	setDescriptionFrom(XString val) Copies the provided XString value into this object's 'description'.
void	setIncompleteCommitCount(int val) Sets the value of 'incompleteCommitCount' Field Description The number of commits that are outstanding (millis since the epoch).
void	setLastCommitCompletionTimestamp(long val) Sets the value of 'lastCommitCompletionTimestamp' Field Description The timestamp at which the last AepEngine commit completion was processed (millis since the epoch).
void	setLastEventProcessedTimestamp(long val) Sets the value of 'lastEventProcessedTimestamp' Field Description The timestamp at which the last AepEngine event was processed (millis since the epoch).
void	setReason(String val) Sets the value of 'reason' Field Description The reason for which the event was issued (a hung transaction pipeline or a hung message handler).
void	setReasonFrom(long val) Sets the value of this String field to the given numeric value.
void	setReasonFrom(XString val) Copies the provided XString value into this object's 'reason'.
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()

setLastEventProcessedTimestamp

void setLastEventProcessedTimestamp(long val)

Sets the value of 'lastEventProcessedTimestamp'

Field Description

The timestamp at which the last AepEngine event was processed (millis since the epoch).

Parameters:

val - The value to set.

getLastEventProcessedTimestamp

long getLastEventProcessedTimestamp()

Gets the value of 'lastEventProcessedTimestamp'

Field Description

The timestamp at which the last AepEngine event was processed (millis since the epoch).

Returns:

The timestamp at which the last AepEngine event was processed (millis since the epoch).

clearLastEventProcessedTimestamp

void clearLastEventProcessedTimestamp()

Clears the value of 'lastEventProcessedTimestamp'

Field Description

The timestamp at which the last AepEngine event was processed (millis since the epoch).

See Also:

setLastEventProcessedTimestamp(long)

hasLastEventProcessedTimestamp

boolean hasLastEventProcessedTimestamp()

Checks for the presence of 'lastEventProcessedTimestamp'

Field Description

The timestamp at which the last AepEngine event was processed (millis since the epoch).

See Also:

getLastEventProcessedTimestamp()

setLastCommitCompletionTimestamp

void setLastCommitCompletionTimestamp(long val)

Sets the value of 'lastCommitCompletionTimestamp'

Field Description

The timestamp at which the last AepEngine commit completion was processed (millis since the epoch).

Parameters:

val - The value to set.

getLastCommitCompletionTimestamp

long getLastCommitCompletionTimestamp()

Gets the value of 'lastCommitCompletionTimestamp'

Field Description

The timestamp at which the last AepEngine commit completion was processed (millis since the epoch).

Returns:

The timestamp at which the last AepEngine commit completion was processed (millis since the epoch).

clearLastCommitCompletionTimestamp

void clearLastCommitCompletionTimestamp()

Clears the value of 'lastCommitCompletionTimestamp'

Field Description

The timestamp at which the last AepEngine commit completion was processed (millis since the epoch).

See Also:

setLastCommitCompletionTimestamp(long)

hasLastCommitCompletionTimestamp

boolean hasLastCommitCompletionTimestamp()

Checks for the presence of 'lastCommitCompletionTimestamp'

Field Description

The timestamp at which the last AepEngine commit completion was processed (millis since the epoch).

See Also:

getLastCommitCompletionTimestamp()

setIncompleteCommitCount

void setIncompleteCommitCount(int val)

Sets the value of 'incompleteCommitCount'

Field Description

The number of commits that are outstanding (millis since the epoch).

Parameters:

val - The value to set.

getIncompleteCommitCount

int getIncompleteCommitCount()

Gets the value of 'incompleteCommitCount'

Field Description

The number of commits that are outstanding (millis since the epoch).

Returns:

The number of commits that are outstanding (millis since the epoch).

clearIncompleteCommitCount

void clearIncompleteCommitCount()

Clears the value of 'incompleteCommitCount'

Field Description

The number of commits that are outstanding (millis since the epoch).

See Also:

setIncompleteCommitCount(int)

hasIncompleteCommitCount

boolean hasIncompleteCommitCount()

Checks for the presence of 'incompleteCommitCount'

Field Description

The number of commits that are outstanding (millis since the epoch).

See Also:

getIncompleteCommitCount()

setReason

void setReason(String val)

Sets the value of 'reason'

Field Description

The reason for which the event was issued (a hung transaction pipeline or a hung message handler).

Parameters:

val - The value to set.

getReason

String getReason()

Gets the value of 'reason'

Field Description

The reason for which the event was issued (a hung transaction pipeline or a hung message handler).

Returns:

The reason for which the event was issued (a hung transaction pipeline or a hung message handler).

lendReason

void lendReason(XString val)

Sets the value of 'reason'

Field Description

The reason for which the event was issued (a hung transaction pipeline or a hung message handler).

Parameters:

val - The value to set.

setReasonFrom

void setReasonFrom(long val)

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

Field Description

The reason for which the event was issued (a hung transaction pipeline or a hung message handler).

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

getReasonTo

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

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

Field Description

The reason for which the event was issued (a hung transaction pipeline or a hung message handler).

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

setReasonFrom

void setReasonFrom(XString val)

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

Field Description

The reason for which the event was issued (a hung transaction pipeline or a hung message handler).

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

getReasonTo

void getReasonTo(XString val)

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

Field Description

The reason for which the event was issued (a hung transaction pipeline or a hung message handler).

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

See Also:

getReason()

getReasonUnsafe

XString getReasonUnsafe()

Gets the raw value of 'reason'.

Field Description

The reason for which the event was issued (a hung transaction pipeline or a hung message handler).

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:

getReason()

clearReason

void clearReason()

Clears the value of 'reason'

Field Description

The reason for which the event was issued (a hung transaction pipeline or a hung message handler).

See Also:

setReason(String)

hasReason

boolean hasReason()

Checks for the presence of 'reason'

Field Description

The reason for which the event was issued (a hung transaction pipeline or a hung message handler).

See Also:

getReason()

setDescription

void setDescription(String val)

Sets the value of 'description'

Field Description

A human readable description of the stuck alert condition.

Parameters:

val - The value to set.

getDescription

String getDescription()

Gets the value of 'description'

Field Description

A human readable description of the stuck alert condition.

Returns:

A human readable description of the stuck alert condition.

lendDescription

void lendDescription(XString val)

Sets the value of 'description'

Field Description

A human readable description of the stuck alert condition.

Parameters:

val - The value to set.

setDescriptionFrom

void setDescriptionFrom(long val)

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

Field Description

A human readable description of the stuck alert condition.

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

getDescriptionTo

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

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

Field Description

A human readable description of the stuck alert condition.

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

setDescriptionFrom

void setDescriptionFrom(XString val)

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

Field Description

A human readable description of the stuck alert condition.

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

getDescriptionTo

void getDescriptionTo(XString val)

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

Field Description

A human readable description of the stuck alert condition.

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

See Also:

getDescription()

getDescriptionUnsafe

XString getDescriptionUnsafe()

Gets the raw value of 'description'.

Field Description

A human readable description of the stuck alert condition.

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:

getDescription()

clearDescription

void clearDescription()

Clears the value of 'description'

Field Description

A human readable description of the stuck alert condition.

See Also:

setDescription(String)

hasDescription

boolean hasDescription()

Checks for the presence of 'description'

Field Description

A human readable description of the stuck alert condition.

See Also:

getDescription()

copy

SrvMonAppStuckAlertMessage copy()

Creates a copy of this SrvMonAppStuckAlertMessage.

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

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

Specified by:

copy in interface IRogCopyableNode<ISrvMonAppStuckAlertMessage>

Returns:

A copy of this SrvMonAppStuckAlertMessage.

See Also:

IRogCopyableNode, CopyableMessageView

copyInto

void copyInto(SrvMonAppStuckAlertMessage target)

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

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