BucketProperties.Builder (Riak Client for Java 2.0.4 API)

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

Enclosing class:: BucketProperties

public static class BucketProperties.Builder
extends Object

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BucketProperties`	`build()`
`BucketProperties.Builder`	`withAllowMulti(boolean allow)` Set the allow_multi value.
`BucketProperties.Builder`	`withBackend(String backend)` Set the backend used by this bucket.
`BucketProperties.Builder`	`withBasicQuorum(boolean use)` Set the basic_quorum value.
`BucketProperties.Builder`	`withBigVClock(long bigVClock)` Set the big_vclock value.
`BucketProperties.Builder`	`withChashkeyFunction(Function func)` Set the chash_keyfun value.
`BucketProperties.Builder`	`withDw(int dw)` Set the dw value.
`BucketProperties.Builder`	`withLastWriteWins(boolean wins)` Set the last_write_wins value.
`BucketProperties.Builder`	`withLegacyRiakSearchEnabled(boolean enable)` Enable Legacy Riak Search.
`BucketProperties.Builder`	`withLinkwalkFunction(Function func)` Set the linkfun value.
`BucketProperties.Builder`	`withNotFoundOk(boolean ok)` Set the not_found_ok value.
`BucketProperties.Builder`	`withNVal(int nVal)` Set the nVal.
`BucketProperties.Builder`	`withOldVClock(long oldVClock)` Set the old_vclock value.
`BucketProperties.Builder`	`withPostcommitHook(Function hook)` Add a post-commit hook.
`BucketProperties.Builder`	`withPr(int pr)` Set the pr value.
`BucketProperties.Builder`	`withPr(Quorum pr)` Set the pr value.
`BucketProperties.Builder`	`withPrecommitHook(Function hook)` Add a pre-commit hook.
`BucketProperties.Builder`	`withPw(int pw)` Set the pw value.
`BucketProperties.Builder`	`withPw(Quorum pw)` Set the pw value.
`BucketProperties.Builder`	`withR(int r)` Set the r value.
`BucketProperties.Builder`	`withR(Quorum r)` Set the r value.
`BucketProperties.Builder`	`withRw(int rw)` Set the rw value.
`BucketProperties.Builder`	`withRw(Quorum rw)` Set the rw value.
`BucketProperties.Builder`	`withSearchIndex(String indexName)` Associate a Search Index.
`BucketProperties.Builder`	`withSmallVClock(long smallVClock)` Set the small_vclock value.
`BucketProperties.Builder`	`withW(int w)` Set the w value.
`BucketProperties.Builder`	`withW(Quorum w)` Set the w value.
`BucketProperties.Builder`	`withYoungVClock(long youngVClock)` Set the young_vclock value.

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

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - withAllowMulti
```
public BucketProperties.Builder withAllowMulti(boolean allow)
```
    Set the allow_multi value.
    
    Parameters:
    
    allow - whether to allow sibling objects to be created.
    
    Returns:
    
    a reference to this object.
  - withBackend
```
public BucketProperties.Builder withBackend(String backend)
```
    Set the backend used by this bucket. Only applies when using riak_kv_multi_backend in Riak.
    
    Parameters:
    
    backend - the name of the backend to use.
    
    Returns:
    
    a reference to this object.
  - withBasicQuorum
```
public BucketProperties.Builder withBasicQuorum(boolean use)
```
    Set the basic_quorum value. The parameter controls whether a read request should return early in some fail cases. E.g. If a quorum of nodes has already returned notfound/error, don't wait around for the rest.
    
    Parameters:
    
    use - the basic_quorum value.
    
    Returns:
    
    a reference to this object.
  - withBigVClock
```
public BucketProperties.Builder withBigVClock(long bigVClock)
```
    Set the big_vclock value.
    
    Parameters:
    
    bigVClock - a long representing a epoch time value.
    
    Returns:
    
    a reference to this object.
    
    See Also:
    
    Vector Clock Pruning
  - withChashkeyFunction
```
public BucketProperties.Builder withChashkeyFunction(Function func)
```
    Set the chash_keyfun value.
    
    Parameters:
    
    func - a Function representing the Erlang func to use.
    
    Returns:
    
    a reference to this object.
  - withLastWriteWins
```
public BucketProperties.Builder withLastWriteWins(boolean wins)
```
    Set the last_write_wins value. Unless you really know what you're doing, you probably do not want to set this to true.
    
    Parameters:
    
    wins - whether to ignore vector clocks when writing.
    
    Returns:
    
    a reference to this object.
  - withLinkwalkFunction
```
public BucketProperties.Builder withLinkwalkFunction(Function func)
```
    Set the linkfun value.
    
    Parameters:
    
    func - a Function representing the Erlang func to use.
    
    Returns:
    
    a reference to this object.
  - withRw
```
public BucketProperties.Builder withRw(int rw)
```
    Set the rw value. Individual requests (or buckets in a bucket type) can override this.
    
    Parameters:
    
    rw - the rw value as an integer.
    
    Returns:
    
    a reference to this object.
  - withRw
```
public BucketProperties.Builder withRw(Quorum rw)
```
    Set the rw value. Individual requests (or buckets in a bucket type) can override this.
    
    Parameters:
    
    rw - the rw value as a Quorum.
    
    Returns:
    
    a reference to this object.
  - withDw
```
public BucketProperties.Builder withDw(int dw)
```
    Set the dw value. Individual requests (or buckets in a bucket type) can override this.
    
    Parameters:
    
    dw - the dw value as an integer.
    
    Returns:
    
    a reference to this object.
  - withW
```
public BucketProperties.Builder withW(int w)
```
    Set the w value. Individual requests (or buckets in a bucket type) can override this.
    
    Parameters:
    
    w - the w value as an integer.
    
    Returns:
    
    a reference to this object.
  - withW
```
public BucketProperties.Builder withW(Quorum w)
```
    Set the w value. Individual requests (or buckets in a bucket type) can override this.
    
    Parameters:
    
    w - the w value as a Quorum.
    
    Returns:
    
    a reference to this object.
  - withR
```
public BucketProperties.Builder withR(int r)
```
    Set the r value. Individual requests (or buckets in a bucket type) can override this.
    
    Parameters:
    
    r - the r value as an integer.
    
    Returns:
    
    a reference to this object.
  - withR
```
public BucketProperties.Builder withR(Quorum r)
```
    Set the r value. Individual requests (or buckets in a bucket type) can override this.
    
    Parameters:
    
    r - the r value as a Quorum.
    
    Returns:
    
    a reference to this object.
  - withPr
```
public BucketProperties.Builder withPr(int pr)
```
    Set the pr value. Individual requests (or buckets in a bucket type) can override this.
    
    Parameters:
    
    pr - the pr value as an integer.
    
    Returns:
    
    a reference to this object.
  - withPr
```
public BucketProperties.Builder withPr(Quorum pr)
```
    Set the pr value. Individual requests (or buckets in a bucket type) can override this.
    
    Parameters:
    
    pr - the pr value as a Quorum.
    
    Returns:
    
    a reference to this object.
  - withPw
```
public BucketProperties.Builder withPw(int pw)
```
    Set the pw value. Individual requests (or buckets in a bucket type) can override this.
    
    Parameters:
    
    pw - the pw value as an integer.
    
    Returns:
    
    a reference to this object.
  - withPw
```
public BucketProperties.Builder withPw(Quorum pw)
```
    Set the pw value. Individual requests (or buckets in a bucket type) can override this.
    
    Parameters:
    
    pw - the pw value as a Quorum.
    
    Returns:
    
    a reference to this object.
  - withNotFoundOk
```
public BucketProperties.Builder withNotFoundOk(boolean ok)
```
    Set the not_found_ok value. If true a vnode returning notfound for a key increments the r tally. False is higher consistency, true is higher availability.
    
    Parameters:
    
    ok - the not_found_ok value.
    
    Returns:
    
    a reference to this object.
  - withPrecommitHook
```
public BucketProperties.Builder withPrecommitHook(Function hook)
```
    Add a pre-commit hook. The supplied Function must be an Erlang or Named JS function.
    
    Parameters:
    
    hook - the Function to add.
    
    Returns:
    
    a reference to this object.
    
    See Also:
    
    Using Commit Hooks
  - withPostcommitHook
```
public BucketProperties.Builder withPostcommitHook(Function hook)
```
    Add a post-commit hook. The supplied Function must be an Erlang or Named JS function.
    
    Parameters:
    
    hook - the Function to add.
    
    Returns:
    
    a reference to this object.
    
    See Also:
    
    Using Commit Hooks
  - withOldVClock
```
public BucketProperties.Builder withOldVClock(long oldVClock)
```
    Set the old_vclock value.
    
    Parameters:
    
    oldVClock - an long representing a epoch time value.
    
    Returns:
    
    a reference to this object.
    
    See Also:
    
    Vector Clock Pruning
  - withYoungVClock
```
public BucketProperties.Builder withYoungVClock(long youngVClock)
```
    Set the young_vclock value.
    
    Parameters:
    
    youngVClock - a long representing a epoch time value.
    
    Returns:
    
    a reference to this object.
    
    See Also:
    
    Vector Clock Pruning
  - withSmallVClock
```
public BucketProperties.Builder withSmallVClock(long smallVClock)
```
    Set the small_vclock value.
    
    Parameters:
    
    smallVClock - a long representing a epoch time value.
    
    Returns:
    
    a reference to this object.
    
    See Also:
    
    Vector Clock Pruning
  - withNVal
```
public BucketProperties.Builder withNVal(int nVal)
```
    Set the nVal.
    
    Parameters:
    
    nVal - the number of replicas.
    
    Returns:
    
    a reference to this object.
  - withLegacyRiakSearchEnabled
```
public BucketProperties.Builder withLegacyRiakSearchEnabled(boolean enable)
```
    Enable Legacy Riak Search. Setting this to true causes the search pre-commit hook to be added. Note this is only for legacy Riak (< v2.0) Search support.
    
    Parameters:
    
    enable - add/remove (true/false) the pre-commit hook for Riak Search.
    
    Returns:
    
    a reference to this object.
  - withSearchIndex
```
public BucketProperties.Builder withSearchIndex(String indexName)
```
    Associate a Search Index. This only applies if Yokozuna is enabled in Riak.
    
    Parameters:
    
    indexName - The name of the Yokozuna Index to use.
    
    Returns:
    
    a reference to this object.
  - build
```
public BucketProperties build()
```

Class BucketProperties.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

withAllowMulti

withBackend

withBasicQuorum

withBigVClock

withChashkeyFunction

withLastWriteWins

withLinkwalkFunction

withRw

withRw

withDw

withW

withW

withR

withR

withPr

withPr

withPw

withPw

withNotFoundOk

withPrecommitHook

withPostcommitHook

withOldVClock

withYoungVClock

withSmallVClock

withNVal

withLegacyRiakSearchEnabled

withSearchIndex

build