com.basho.riak.client.http

Class RiakBucketInfo

java.lang.Object

com.basho.riak.client.http.RiakBucketInfo

public class RiakBucketInfo
extends Object

Represents the metadata stored in a bucket including its schema and the list of keys contained in the bucket.

Constructor Summary

Constructors

Constructor and Description
RiakBucketInfo() Construct a bucket info to populate for a writeSchema request.
RiakBucketInfo(org.json.JSONObject schema, Collection<String> keys) Construct a bucket info using the JSON data from a listBucket() response.

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	getAllowMult()
String	getCHashFun() The chash_keyfun property as <module>:<function>
Collection<String>	getKeys() The object keys in this bucket.
String	getLinkFun() The linkfun property as <module>:<function>
Integer	getNVal()
org.json.JSONObject	getSchema() Returns the bucket's properties.
void	setAllowMult(boolean allowMult) Allow siblings to be returned for an object.
void	setCHashFun(String mod, String fun) Erlang module and name of the function to use to hash object keys.
void	setLinkFun(String mod, String fun) Erlang module and name of the function to use to walk object links.
void	setNVal(int n) Number of replicas per object in this bucket.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RiakBucketInfo

public RiakBucketInfo()

Construct a bucket info to populate for a writeSchema request.

RiakBucketInfo

public RiakBucketInfo(org.json.JSONObject schema,
              Collection<String> keys)

Construct a bucket info using the JSON data from a listBucket() response.

Parameters:

schema - The JSON object containing the bucket's schema

keys - The keys in the bucket

Method Detail

getSchema

public org.json.JSONObject getSchema()

Returns the bucket's properties.

getKeys

public Collection<String> getKeys()

The object keys in this bucket.

setAllowMult

public void setAllowMult(boolean allowMult)

Allow siblings to be returned for an object. If false, last write wins.

getAllowMult

public Boolean getAllowMult()

setNVal

public void setNVal(int n)

Number of replicas per object in this bucket.

getNVal

public Integer getNVal()

setCHashFun

public void setCHashFun(String mod,
               String fun)

Erlang module and name of the function to use to hash object keys. See Riak's documentation.

getCHashFun

public String getCHashFun()

The chash_keyfun property as <module>:<function>

setLinkFun

public void setLinkFun(String mod,
              String fun)

Erlang module and name of the function to use to walk object links. See Riak's documentation.

getLinkFun

public String getLinkFun()

The linkfun property as <module>:<function>