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
This message is a request to return the state of a given bucket. The corresponding reply is
GetBucketStateReply
.- Author:
- Simon Thoresen Hult
-
Constructor Summary
ConstructorDescriptionGetBucketStateMessage
(com.yahoo.document.BucketId bucket) Constructs a new reply with initial content. -
Method Summary
Modifier and TypeMethodDescriptionCreates and returns a reply to this message.int
com.yahoo.document.BucketId
Returns the bucket whose state this contains.long
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
Methods inherited from class com.yahoo.messagebus.Routable
discard, getCallStack, getContext, getTrace, popHandler, pushHandler, setContext
-
Constructor Details
-
GetBucketStateMessage
public GetBucketStateMessage(com.yahoo.document.BucketId bucket) Constructs a new reply with initial content.- Parameters:
bucket
- The bucket whose state to reply with.
-
-
Method Details
-
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
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
-