BucketProperties (Riak Client for Java 2.0.5 API)

java.lang.Object
- com.basho.riak.client.core.query.BucketProperties

```
public class BucketProperties
extends Object
```
Bucket properties used for buckets and bucket types. Note that when instantiating a new instance there are no default values. Calling a getter for a specific property will return null if it has not been explicitly set. Unset properties are ignored when writing to a bucket or bucket type in Riak.

Since:

2.0

Author:

Brian Roach

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BucketProperties.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`BucketProperties.Builder`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Boolean`	`getAllowMulti()` Get the allow_multi value.
`String`	`getBackend()` Get the backend.
`Boolean`	`getBasicQuorum()` Get the basic_quorum value.
`Long`	`getBigVClock()` Get the big_vclock value.
`Function`	`getChashKeyFunction()` Get the chash_keyfun value.
`Quorum`	`getDw()` Get the dw value.
`Boolean`	`getLastWriteWins()` Get the last_write_wins value.
`Boolean`	`getLegacyRiakSearchEnabled()` Determine if legacy Riak Search is enabled.
`Function`	`getLinkwalkFunction()` Get the linkfun value.
`Boolean`	`getNotFoundOk()` Get the not_found_ok value.
`Integer`	`getNVal()` Get the nVal.
`Long`	`getOldVClock()` Get the old_vclock value.
`List<Function>`	`getPostcommitHooks()` Get the list of post-commit hooks.
`Quorum`	`getPr()` Get the pr value.
`List<Function>`	`getPrecommitHooks()` Get the list of pre-commit hooks.
`Quorum`	`getPw()` Set the pw value.
`Quorum`	`getR()` Get the r value.
`Quorum`	`getRw()` Get the rw value.
`String`	`getSearchIndex()` Get the associated Yokozuna Index.
`Long`	`getSmallVClock()` Get the small_vclock value.
`Quorum`	`getW()` Get the w value.
`Long`	`getYoungVClock()` Get the young_vclock value.
`boolean`	`hasAllowMulti()` Determine if an allow_multi value has been set.
`boolean`	`hasBackend()` Determine if an backend value has been set.
`boolean`	`hasBasicQuorum()` Determine if a basic_quorum value has been set.
`boolean`	`hasBigVClock()` Determine if an big_vclock value has been set.
`boolean`	`hasChashKeyFunction()` Determine if a chash_keyfun value has been set.
`boolean`	`hasDw()` Determine if a dw value has been set.
`int`	`hashCode()`
`boolean`	`hasLastWriteWins()` Determine if a last_write_wins value has been set.
`boolean`	`hasLegacyRiakSearchEnabled()` Determine if legacy Riak Search has been enabled.
`boolean`	`hasLinkwalkFunction()` Determine if a linkfun value has been set.
`boolean`	`hasNotFoundOk()` Determine if a not_found_ok value has been set.
`boolean`	`hasNVal()` Determine if an nVal value has been set.
`boolean`	`hasOldVClock()` Determine if an old_vclock value has been set.
`boolean`	`hasPostcommitHooks()` Determine if any post-commit hooks have been added.
`boolean`	`hasPr()` Determine if a pr value has been set.
`boolean`	`hasPrecommitHooks()` Determine if any pre-commit hooks have been added.
`boolean`	`hasPw()` Determine if a pw value has been set.
`boolean`	`hasR()` Determine if an r value has been set.
`boolean`	`hasRw()` Determine if an rw value has been set.
`boolean`	`hasSearchIndex()` Determine if a Yokozuna Index has been set.
`boolean`	`hasSmallVClock()` Determine if an small_vclock value has been set.
`boolean`	`hasW()` Determine if a w value has been set.
`boolean`	`hasYoungVClock()` Determine if an young_vclock value has been set.
`String`	`toString()`

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

- Method Detail
  - hasLinkwalkFunction
```
public boolean hasLinkwalkFunction()
```
    Determine if a linkfun value has been set.
    
    Returns:
    true if set, false otherwise.
  - getLinkwalkFunction
```
public Function getLinkwalkFunction()
```
    Get the linkfun value.
    
    Returns:
    the link walking function for the bucket, or null.
  - hasChashKeyFunction
```
public boolean hasChashKeyFunction()
```
    Determine if a chash_keyfun value has been set.
    
    Returns:
    true if set, false otherwise.
  - getChashKeyFunction
```
public Function getChashKeyFunction()
```
    Get the chash_keyfun value.
    
    Returns:
    the key hashing function for the bucket, or null.
  - hasRw
```
public boolean hasRw()
```
    Determine if an rw value has been set.
    
    Returns:
    true if set, false otherwise.
  - getRw
```
public Quorum getRw()
```
    Get the rw value.
    
    Returns:
    the rw value as a Quorum, or null if not set.
  - hasDw
```
public boolean hasDw()
```
    Determine if a dw value has been set.
    
    Returns:
    true if set, false otherwise.
  - getDw
```
public Quorum getDw()
```
    Get the dw value.
    
    Returns:
    the dw value as a Quorum, or null if not set.
  - hasW
```
public boolean hasW()
```
    Determine if a w value has been set.
    
    Returns:
    true if set, false otherwise.
  - getW
```
public Quorum getW()
```
    Get the w value.
    
    Returns:
    the w value as a Quorum, or null if not set.
  - hasR
```
public boolean hasR()
```
    Determine if an r value has been set.
    
    Returns:
    true if set, false otherwise.
  - getR
```
public Quorum getR()
```
    Get the r value.
    
    Returns:
    the r value as a Quorum, or null if not set.
  - hasPr
```
public boolean hasPr()
```
    Determine if a pr value has been set.
    
    Returns:
    true if set, false otherwise.
  - getPr
```
public Quorum getPr()
```
    Get the pr value.
    
    Returns:
    the pr value as a Quorum, or null.
  - hasPw
```
public boolean hasPw()
```
    Determine if a pw value has been set.
    
    Returns:
    true if set, false otherwise.
  - getPw
```
public Quorum getPw()
```
    Set the pw value.
    
    Returns:
    the pw value as a Quorum, or null.
  - hasNotFoundOk
```
public boolean hasNotFoundOk()
```
    Determine if a not_found_ok value has been set.
    
    Returns:
    true if set, false otherwise.
  - getNotFoundOk
```
public Boolean getNotFoundOk()
```
    Get the not_found_ok value.
    
    Returns:
    the not_found_ok value or null if not set.
    See Also:
    BucketProperties.Builder.withNotFoundOk(boolean)
  - hasBasicQuorum
```
public boolean hasBasicQuorum()
```
    Determine if a basic_quorum value has been set.
    
    Returns:
    true if set, false otherwise.
  - getBasicQuorum
```
public Boolean getBasicQuorum()
```
    Get the basic_quorum value.
    
    Returns:
    the basic_quorum value, or null if not set.
    See Also:
    BucketProperties.Builder.withBasicQuorum(boolean)
  - hasPrecommitHooks
```
public boolean hasPrecommitHooks()
```
    Determine if any pre-commit hooks have been added.
    
    Returns:
    true if set, false otherwise.
  - getPrecommitHooks
```
public List<Function> getPrecommitHooks()
```
    Get the list of pre-commit hooks.
    
    Returns:
    a List containing the pre-commit hooks.
    See Also:
    BucketProperties.Builder.withPrecommitHook(com.basho.riak.client.core.query.functions.Function)
  - hasPostcommitHooks
```
public boolean hasPostcommitHooks()
```
    Determine if any post-commit hooks have been added.
    
    Returns:
    true if set, false otherwise.
  - getPostcommitHooks
```
public List<Function> getPostcommitHooks()
```
    Get the list of post-commit hooks.
    
    Returns:
    a List containing the post-commit hooks
    See Also:
    BucketProperties.Builder.withPostcommitHook(com.basho.riak.client.core.query.functions.Function)
  - hasOldVClock
```
public boolean hasOldVClock()
```
    Determine if an old_vclock value has been set.
    
    Returns:
    true if set, false otherwise.
  - getOldVClock
```
public Long getOldVClock()
```
    Get the old_vclock value.
    
    Returns:
    the old_vclock value as a long or null if not set.
    See Also:
    BucketProperties.Builder.withOldVClock(long)
  - hasYoungVClock
```
public boolean hasYoungVClock()
```
    Determine if an young_vclock value has been set.
    
    Returns:
    true if set, false otherwise.
  - getYoungVClock
```
public Long getYoungVClock()
```
    Get the young_vclock value.
    
    Returns:
    the young_vclock value as an long or null if not set.
    See Also:
    BucketProperties.Builder.withYoungVClock(long)
  - hasBigVClock
```
public boolean hasBigVClock()
```
    Determine if an big_vclock value has been set.
    
    Returns:
    true if set, false otherwise.
  - getBigVClock
```
public Long getBigVClock()
```
    Get the big_vclock value.
    
    Returns:
    the big_vclock value as a long or null if not set.
    See Also:
    BucketProperties.Builder.withBigVClock(long)
  - hasSmallVClock
```
public boolean hasSmallVClock()
```
    Determine if an small_vclock value has been set.
    
    Returns:
    true if set, false otherwise.
  - getSmallVClock
```
public Long getSmallVClock()
```
    Get the small_vclock value.
    
    Returns:
    the small_vclock value as a long or null if not set.
    See Also:
    BucketProperties.Builder.withSmallVClock(long)
  - hasBackend
```
public boolean hasBackend()
```
    Determine if an backend value has been set.
    
    Returns:
    true if set, false otherwise.
  - getBackend
```
public String getBackend()
```
    Get the backend. Only applies when using riak_kv_multi_backend in Riak.
    
    Returns:
    the name of the backend or null if not set.
  - hasNVal
```
public boolean hasNVal()
```
    Determine if an nVal value has been set.
    
    Returns:
    true if set, false otherwise.
  - getNVal
```
public Integer getNVal()
```
    Get the nVal.
    
    Returns:
    the nVal value or null if not set.
  - hasLastWriteWins
```
public boolean hasLastWriteWins()
```
    Determine if a last_write_wins value has been set.
    
    Returns:
    true if set, false otherwise.
  - getLastWriteWins
```
public Boolean getLastWriteWins()
```
    Get the last_write_wins value.
    
    Returns:
    the last_write_wins value or null if not set.
  - hasAllowMulti
```
public boolean hasAllowMulti()
```
    Determine if an allow_multi value has been set.
    
    Returns:
    true if set, false otherwise.
  - getAllowMulti
```
public Boolean getAllowMulti()
```
    Get the allow_multi value.
    
    Returns:
    the allow_multi value or null if not set.
  - hasLegacyRiakSearchEnabled
```
public boolean hasLegacyRiakSearchEnabled()
```
    Determine if legacy Riak Search has been enabled.
    
    Returns:
    true if set, false otherwise.
  - getLegacyRiakSearchEnabled
```
public Boolean getLegacyRiakSearchEnabled()
```
    Determine if legacy Riak Search is enabled.
    
    Returns:
    true if Riak Search is enabled, false otherwise.
  - hasSearchIndex
```
public boolean hasSearchIndex()
```
    Determine if a Yokozuna Index has been set.
    
    Returns:
    true if set, false otherwise.
  - getSearchIndex
```
public String getSearchIndex()
```
    Get the associated Yokozuna Index.
    
    Returns:
    the Yokozuna index name or null if not set.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class BucketProperties

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

hasLinkwalkFunction

getLinkwalkFunction

hasChashKeyFunction

getChashKeyFunction

hasRw

getRw

hasDw

getDw

hasW

getW

hasR

getR

hasPr

getPr

hasPw

getPw

hasNotFoundOk

getNotFoundOk

hasBasicQuorum

getBasicQuorum

hasPrecommitHooks

getPrecommitHooks

hasPostcommitHooks

getPostcommitHooks

hasOldVClock

getOldVClock

hasYoungVClock

getYoungVClock

hasBigVClock

getBigVClock

hasSmallVClock

getSmallVClock

hasBackend

getBackend

hasNVal

getNVal

hasLastWriteWins

getLastWriteWins

hasAllowMulti

getAllowMulti

hasLegacyRiakSearchEnabled

getLegacyRiakSearchEnabled

hasSearchIndex

getSearchIndex

toString

hashCode

equals