com.neeve.server.mon.lifecycle
Interface ISrvMonAppStoreBindingRoleChangedMessage

All Superinterfaces:

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

All Known Implementing Classes:

SrvMonAppStoreBindingRoleChangedMessage

@Generated(value="com.neeve.adm.AdmGenerator",
           date="Wed Mar 28 10:54:30 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 ISrvMonAppStoreBindingRoleChangedMessage
extends IRogNode, IRogMessage, IRogCopyableNode<ISrvMonAppStoreBindingRoleChangedMessage>

Represents the event indicating that a binding's (member) role has changed.

This event is dispatched to the user to notify that the role of the member represented by a store binding is changing. The event is dispatched before the binding's new role takes effect i.e. a user's query to retrieve the binding's role will return the old role.

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	clearRole() Clears the value of 'role' Field Description The new cluster role.
void	clearTimestamp() Clears the value of 'timestamp' Field Description The timestamp at which this event occurred (millis since the epoch).
SrvMonAppStoreBindingRoleChangedMessage	copy() Creates a copy of this SrvMonAppStoreBindingRoleChangedMessage.
void	copyInto(SrvMonAppStoreBindingRoleChangedMessage target) Copies the contents of this SrvMonAppStoreBindingRoleChangedMessage into the target.
String	getRole() Gets the value of 'role' Field Description The new cluster role.
<T extends XString> T	getRoleTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getRoleTo(XString val) Copies the value of 'role' into the provided XString.
XString	getRoleUnsafe() Gets the raw value of 'role'.
long	getTimestamp() Gets the value of 'timestamp' Field Description The timestamp at which this event occurred (millis since the epoch).
boolean	hasRole() Checks for the presence of 'role' Field Description The new cluster role.
boolean	hasTimestamp() Checks for the presence of 'timestamp' Field Description The timestamp at which this event occurred (millis since the epoch).
void	lendRole(XString val) Sets the value of 'role' Field Description The new cluster role.
void	setRole(String val) Sets the value of 'role' Field Description The new cluster role.
void	setRoleFrom(long val) Sets the value of this String field to the given numeric value.
void	setRoleFrom(XString val) Copies the provided XString value into this object's 'role'.
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()

setRole

void setRole(String val)

Sets the value of 'role'

Field Description

The new cluster role.

Parameters:

val - The value to set.

getRole

String getRole()

Gets the value of 'role'

Field Description

The new cluster role.

Returns:

The new cluster role.

lendRole

void lendRole(XString val)

Sets the value of 'role'

Field Description

The new cluster role.

Parameters:

val - The value to set.

setRoleFrom

void setRoleFrom(long val)

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

Field Description

The new cluster role.

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

getRoleTo

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

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

Field Description

The new cluster role.

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

setRoleFrom

void setRoleFrom(XString val)

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

Field Description

The new cluster role.

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

getRoleTo

void getRoleTo(XString val)

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

Field Description

The new cluster role.

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

See Also:

getRole()

getRoleUnsafe

XString getRoleUnsafe()

Gets the raw value of 'role'.

Field Description

The new cluster role.

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:

getRole()

clearRole

void clearRole()

Clears the value of 'role'

Field Description

The new cluster role.

See Also:

setRole(String)

hasRole

boolean hasRole()

Checks for the presence of 'role'

Field Description

The new cluster role.

See Also:

getRole()

copy

SrvMonAppStoreBindingRoleChangedMessage copy()

Creates a copy of this SrvMonAppStoreBindingRoleChangedMessage.

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

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

Specified by:

copy in interface IRogCopyableNode<ISrvMonAppStoreBindingRoleChangedMessage>

Returns:

A copy of this SrvMonAppStoreBindingRoleChangedMessage.

See Also:

IRogCopyableNode, CopyableMessageView

copyInto

void copyInto(SrvMonAppStoreBindingRoleChangedMessage target)

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

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