Class UpdateDocumentMessage
- java.lang.Object
-
- com.yahoo.messagebus.Routable
-
- com.yahoo.messagebus.Message
-
- com.yahoo.documentapi.messagebus.protocol.DocumentMessage
-
- com.yahoo.documentapi.messagebus.protocol.TestAndSetMessage
-
- com.yahoo.documentapi.messagebus.protocol.UpdateDocumentMessage
-
public class UpdateDocumentMessage extends TestAndSetMessage
- Author:
- Simon Thoresen Hult
-
-
Constructor Summary
Constructors Constructor Description UpdateDocumentMessage(com.yahoo.document.DocumentUpdate upd)
Constructs a new document update message.UpdateDocumentMessage(LazyDecoder decoder, com.yahoo.document.serialization.DocumentDeserializer buffer)
Constructs a new message from a byte buffer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static UpdateDocumentMessage
createEmpty()
Creates an empty UpdateDocumentMessageDocumentReply
createReply()
Creates and returns a reply to this message.com.yahoo.document.TestAndSetCondition
getCondition()
com.yahoo.document.DocumentUpdate
getDocumentUpdate()
Returns the document update to perform.long
getNewTimestamp()
Returns the timestamp to assign to the updated document.long
getOldTimestamp()
Returns the timestamp required for this update to be applied.long
getSequenceId()
int
getType()
boolean
hasSequenceId()
void
setCondition(com.yahoo.document.TestAndSetCondition condition)
void
setDocumentUpdate(com.yahoo.document.DocumentUpdate upd)
Sets the document update to perform.void
setNewTimestamp(long time)
Sets the timestamp to assign to the updated document.void
setOldTimestamp(long time)
Sets the timestamp required for this update to be applied.-
Methods inherited from class com.yahoo.documentapi.messagebus.protocol.DocumentMessage
getApproxSize, getLoadType, getPriority, getProtocol, setLoadType, setPriority, swapState
-
Methods inherited from class com.yahoo.messagebus.Message
getBucketSequence, getRetry, getRetryEnabled, getRoute, getTimeReceived, getTimeRemaining, getTimeRemainingNow, hasBucketSequence, isExpired, setRetry, setRetryEnabled, setRoute, setTimeReceived, setTimeReceivedNow, setTimeRemaining
-
-
-
-
Constructor Detail
-
UpdateDocumentMessage
public UpdateDocumentMessage(LazyDecoder decoder, com.yahoo.document.serialization.DocumentDeserializer buffer)
Constructs a new message from a byte buffer.- Parameters:
decoder
- The decoder to use for deserialization.buffer
- A byte buffer that contains a serialized message.
-
UpdateDocumentMessage
public UpdateDocumentMessage(com.yahoo.document.DocumentUpdate upd)
Constructs a new document update message.- Parameters:
upd
- The document update to perform.
-
-
Method Detail
-
createEmpty
public static UpdateDocumentMessage createEmpty()
Creates an empty UpdateDocumentMessage
-
getDocumentUpdate
public com.yahoo.document.DocumentUpdate getDocumentUpdate()
Returns the document update to perform.- Returns:
- The update.
-
setDocumentUpdate
public void setDocumentUpdate(com.yahoo.document.DocumentUpdate upd)
Sets the document update to perform.- Parameters:
upd
- The document update to set.
-
getOldTimestamp
public long getOldTimestamp()
Returns the timestamp required for this update to be applied.- Returns:
- The document timestamp.
-
setOldTimestamp
public void setOldTimestamp(long time)
Sets the timestamp required for this update to be applied.- Parameters:
time
- The timestamp to set.
-
getNewTimestamp
public long getNewTimestamp()
Returns the timestamp to assign to the updated document.- Returns:
- The document timestamp.
-
setNewTimestamp
public void setNewTimestamp(long time)
Sets the timestamp to assign to the updated document.- Parameters:
time
- The timestamp to set.
-
createReply
public DocumentReply createReply()
Description copied from class:DocumentMessage
Creates and returns a reply to this message.- Specified by:
createReply
in classDocumentMessage
- Returns:
- The created reply.
-
hasSequenceId
public boolean hasSequenceId()
- Overrides:
hasSequenceId
in classcom.yahoo.messagebus.Message
-
getSequenceId
public long getSequenceId()
- Overrides:
getSequenceId
in classcom.yahoo.messagebus.Message
-
getType
public int getType()
- Specified by:
getType
in classcom.yahoo.messagebus.Routable
-
getCondition
public com.yahoo.document.TestAndSetCondition getCondition()
- Specified by:
getCondition
in classTestAndSetMessage
-
setCondition
public void setCondition(com.yahoo.document.TestAndSetCondition condition)
- Specified by:
setCondition
in classTestAndSetMessage
-
-