Class GetBucketStateMessage
- java.lang.Object
-
- com.yahoo.messagebus.Routable
-
- com.yahoo.messagebus.Message
-
- com.yahoo.documentapi.messagebus.protocol.DocumentMessage
-
- com.yahoo.documentapi.messagebus.protocol.GetBucketStateMessage
-
public class GetBucketStateMessage extends DocumentMessage
This message is a request to return the state of a given bucket. The corresponding reply isGetBucketStateReply
.- Author:
- Simon Thoresen Hult
-
-
Constructor Summary
Constructors Constructor Description GetBucketStateMessage(com.yahoo.document.BucketId bucket)
Constructs a new reply with initial content.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DocumentReply
createReply()
Creates and returns a reply to this message.int
getApproxSize()
com.yahoo.document.BucketId
getBucketId()
Returns the bucket whose state this contains.long
getSequenceId()
int
getType()
void
setBucketId(com.yahoo.document.BucketId bucket)
Sets the bucket whose state this contains.-
Methods inherited from class com.yahoo.documentapi.messagebus.protocol.DocumentMessage
getLoadType, getPriority, getProtocol, setLoadType, setPriority, swapState
-
Methods inherited from class com.yahoo.messagebus.Message
getBucketSequence, getRetry, getRetryEnabled, getRoute, getTimeReceived, getTimeRemaining, getTimeRemainingNow, hasBucketSequence, hasSequenceId, isExpired, setRetry, setRetryEnabled, setRoute, setTimeReceived, setTimeReceivedNow, setTimeRemaining
-
-
-
-
Method Detail
-
getBucketId
public com.yahoo.document.BucketId getBucketId()
Returns the bucket whose state this contains.- Returns:
- The bucket id.
-
setBucketId
public void setBucketId(com.yahoo.document.BucketId bucket)
Sets the bucket whose state this contains.- Parameters:
bucket
- The bucket id 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.
-
getSequenceId
public long getSequenceId()
- Overrides:
getSequenceId
in classcom.yahoo.messagebus.Message
-
getApproxSize
public int getApproxSize()
- Overrides:
getApproxSize
in classDocumentMessage
-
getType
public int getType()
- Specified by:
getType
in classcom.yahoo.messagebus.Routable
-
-