GetBucketStateMessage (documentapi 7.502.22 API)

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 is GetBucketStateReply.

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

Methods inherited from class com.yahoo.messagebus.Routable
discard, getCallStack, getContext, getTrace, popHandler, pushHandler, setContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - 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 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 class DocumentMessage
    
    Returns:
    
    The created reply.
  - getSequenceId
```
public long getSequenceId()
```
    Overrides:
    
    getSequenceId in class com.yahoo.messagebus.Message
  - getApproxSize
```
public int getApproxSize()
```
    Overrides:
    
    getApproxSize in class DocumentMessage
  - getType
```
public int getType()
```
    Specified by:
    
    getType in class com.yahoo.messagebus.Routable