BucketProperties (Riak Client for Java 1.0.7 API)

All Known Subinterfaces:

Bucket

All Known Implementing Classes:

DefaultBucket, DefaultBucketProperties, LazyBucketProperties
```
public interface BucketProperties
```
The set of properties for a bucket, things like n_val, allow_mult, default read quorum.
Depending on what the underlying transport exposes some of these values will be null. I'm working on (a) updating the low-level clients to return all available values and (b) updating Riak's protocol buffers interface to return all the bucket properties.

Author:

russell

Method Summary

Methods
Modifier and Type	Method and Description
`Boolean`	`getAllowSiblings()` The allow_mult value for the bucket.
`String`	`getBackend()` The backend used by this bucket.
`Boolean`	`getBasicQuorum()` Should a read request return early in some failure cases? E.g.
`Integer`	`getBigVClock()` the big_vclock property for this bucket.
`NamedErlangFunction`	`getChashKeyFunction()` The chash_keyfun for this bucket.
`Quorum`	`getDW()` The default `dw` quorum for this bucket.
`Boolean`	`getLastWriteWins()` The last_write_wins value for the bucket.
`NamedErlangFunction`	`getLinkWalkFunction()` The linkwalk_fun for this bucket.
`Boolean`	`getNotFoundOK()` True if a vnode returning notfound for a key increments the r tally.
`Integer`	`getNVal()` This bucket's n_val.
`Long`	`getOldVClock()` the old_vclock property for this bucket.
`Collection<NamedErlangFunction>`	`getPostcommitHooks()` The set of postcommit hooks for this bucket.
`Quorum`	`getPR()` The default `pr` quorum for this bucket.
`Collection<NamedFunction>`	`getPrecommitHooks()` The set of precommit_hooks for this bucket.
`Quorum`	`getPW()` The default `pw` quorum for this bucket.
`Quorum`	`getR()` The default `r` quorum for this bucket.
`Quorum`	`getRW()` The default `rw` quorum for this bucket.
`Boolean`	`getSearch()` The search property
`Integer`	`getSmallVClock()` the small_vclock property for this bucket.
`Quorum`	`getW()` The default `w` quorum for this bucket.
`Long`	`getYoungVClock()` The young_vclcok property for this bucket.
`boolean`	`isSearchEnabled()` Is search enabled on this bucket

- Method Detail
  - getAllowSiblings
```
Boolean getAllowSiblings()
```
    The allow_mult value for the bucket.
    
    Returns:
    the allowSiblings if set, or null if not
  - getLastWriteWins
```
Boolean getLastWriteWins()
```
    The last_write_wins value for the bucket.
    
    Returns:
    the lastWriteWins if set or null if not
  - getNVal
```
Integer getNVal()
```
    This bucket's n_val.
    
    Returns:
    the nVal if set or null if not
  - getBackend
```
String getBackend()
```
    The backend used by this bucket.
    
    Returns:
    the backend if set, or null.
  - getSmallVClock
```
Integer getSmallVClock()
```
    the small_vclock property for this bucket. See controlling vector clock growth for details.
    
    Returns:
    the small vector clock pruning property if set, or null.
  - getBigVClock
```
Integer getBigVClock()
```
    the big_vclock property for this bucket. See controlling vector clock growth for details.
    
    Returns:
    the big vclock pruning size property if set, or null.
  - getYoungVClock
```
Long getYoungVClock()
```
    The young_vclcok property for this bucket. See controlling vector clock growth for details.
    
    Returns:
    the young vclock prune property if set, or null.
  - getOldVClock
```
Long getOldVClock()
```
    the old_vclock property for this bucket. See controlling vector clock growth for details.
    
    Returns:
    the old vclock prune property if set, or null
  - getPrecommitHooks
```
Collection<NamedFunction> getPrecommitHooks()
```
    The set of precommit_hooks for this bucket. See pre and post commit hooks for more details.
    
    Returns:
    the precommit hooks, if any, or null
  - getPostcommitHooks
```
Collection<NamedErlangFunction> getPostcommitHooks()
```
    The set of postcommit hooks for this bucket. See pre and post commit hooks for more details.
    
    Returns:
    the post commit hooks, if any, or null
  - getR
```
Quorum getR()
```
    The default r quorum for this bucket.
    
    Returns:
    the default CAP read quorum for this bucket, or null.
  - getW
```
Quorum getW()
```
    The default w quorum for this bucket.
    
    Returns:
    the default CAP write quorum for this bucket, or null.
  - getRW
```
Quorum getRW()
```
    The default rw quorum for this bucket.
    
    Returns:
    the default CAP RW (delete) quorum for this bucket, or null.
  - getDW
```
Quorum getDW()
```
    The default dw quorum for this bucket.
    
    Returns:
    the default CAP durable write quorum for this bucket, or null.
  - getPR
```
Quorum getPR()
```
    The default pr quorum for this bucket.
    
    Returns:
    the default number of partitions in the primary preference list that must return from read request, for this bucket, or null.
  - getPW
```
Quorum getPW()
```
    The default pw quorum for this bucket.
    
    Returns:
    the default number of partitions in the primary preference list that must return from a write request, for this bucket, or null.
  - getBasicQuorum
```
Boolean getBasicQuorum()
```
    Should a read request return early in some failure cases? E.g. If a quorum of nodes has already returned notfound/error, don't wait around for the rest.
    
    Returns:
    the default basic_quorum value for this bucket, or null.
  - getNotFoundOK
```
Boolean getNotFoundOK()
```
    True if a vnode returning notfound for a key increments the r tally. False is higher consistency, true is higher availability.
    
    Returns:
    the default notfound_ok value for the bucket, or null.
  - getChashKeyFunction
```
NamedErlangFunction getChashKeyFunction()
```
    The chash_keyfun for this bucket.
    
    Returns:
    the key hashing function for the bucket, or null.
  - getLinkWalkFunction
```
NamedErlangFunction getLinkWalkFunction()
```
    The linkwalk_fun for this bucket.
    
    Returns:
    the link walking function for the bucket, or null.
  - getSearch
```
Boolean getSearch()
```
    The search property
    
    Returns:
    true/false/null
  - isSearchEnabled
```
boolean isSearchEnabled()
```
    Is search enabled on this bucket
    
    Returns:
    true/false

Interface BucketProperties

Method Summary

Method Detail

getAllowSiblings

getLastWriteWins

getNVal

getBackend

getSmallVClock

getBigVClock

getYoungVClock

getOldVClock

getPrecommitHooks

getPostcommitHooks

getR

getW

getRW

getDW

getPR

getPW

getBasicQuorum

getNotFoundOK

getChashKeyFunction

getLinkWalkFunction

getSearch

isSearchEnabled