StoreBucketPropsOperation.Builder (Riak Client for Java 2.0.0 API)

java.lang.Object
- com.basho.riak.client.core.operations.StoreBucketPropsOperation.Builder

Enclosing class:: StoreBucketPropsOperation

public static class StoreBucketPropsOperation.Builder
extends Object

Field Summary

Fields
Modifier and Type Field and Description

protected com.basho.riak.protobuf.RiakPB.RpbBucketProps.Builder propsBuilder

Fields
Modifier and Type	Field and Description
`protected com.basho.riak.protobuf.RiakPB.RpbBucketProps.Builder`	`propsBuilder`

Constructor Summary

Constructors
Constructor and Description

StoreBucketPropsOperation.Builder(Namespace namespace)
Constructs a builder for a StoreBucketPropsOperation.

Constructors
Constructor and Description
`StoreBucketPropsOperation.Builder(Namespace namespace)` Constructs a builder for a StoreBucketPropsOperation.

Method Summary

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

- Field Detail
  - propsBuilder
```
protected final com.basho.riak.protobuf.RiakPB.RpbBucketProps.Builder propsBuilder
```
- Constructor Detail
  - StoreBucketPropsOperation.Builder
```
public StoreBucketPropsOperation.Builder(Namespace namespace)
```
    Constructs a builder for a StoreBucketPropsOperation.
    
    Parameters:
    namespace - The namespace in Riak.
- Method Detail
  - self
```
protected StoreBucketPropsOperation.Builder self()
```
  - build
```
public StoreBucketPropsOperation build()
```
  - withAllowMulti
```
public T 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 T 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 T 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 T 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 T 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 T 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 T 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 T 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.
  - withDw
```
public T 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 T 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.
  - withR
```
public T 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.
  - withPr
```
public T 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.
  - withPw
```
public T 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.
  - withNotFoundOk
```
public T 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 T 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 T 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 T 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 T 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 T 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 T withNVal(int nVal)
```
    Set the nVal.
    
    Parameters:
    nVal - the number of replicas.
    
    Returns:
    a reference to this object.
  - withLegacyRiakSearchEnabled
```
public T 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 Legacy Riak Search.
    
    Returns:
    a reference to this object.
  - withSearchIndex
```
public T withSearchIndex(String indexName)
```
    Associate a Search Index. This only applies if Yokozuna is enabled in Riak v2.0.
    
    Parameters:
    indexName - The name of the search index to use.
    
    Returns:
    a reference to this object.

Class StoreBucketPropsOperation.Builder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

propsBuilder

Constructor Detail

StoreBucketPropsOperation.Builder

Method Detail

self

build

withAllowMulti

withBackend

withBasicQuorum

withBigVClock

withChashkeyFunction

withLastWriteWins

withLinkwalkFunction

withRw

withDw

withW

withR

withPr

withPw

withNotFoundOk

withPrecommitHook

withPostcommitHook

withOldVClock

withYoungVClock

withSmallVClock

withNVal

withLegacyRiakSearchEnabled

withSearchIndex