Click or drag to resize
RiakBucketProperties Class
Represents the collection of properties for a Riak bucket.
Inheritance Hierarchy
SystemObject
  RiakClient.ModelsRiakOptionsRiakBucketProperties
    RiakClient.ModelsRiakBucketProperties

Namespace:  RiakClient.Models
Assembly:  RiakClient (in RiakClient.dll) Version: f9bb17a3f8ff6940b88010a52f202e3d55fe25c5
Syntax
public class RiakBucketProperties : RiakOptions<RiakBucketProperties>

The RiakBucketProperties type exposes the following members.

Constructors
  NameDescription
Public methodRiakBucketProperties
Initializes a new instance of the RiakBucketProperties class.
Top
Properties
  NameDescription
Public propertyAllowMultiple
The option to allow sibling objects to be created (concurrent updates) when updating an object.
Public propertyBackend
The named backend being used for this bucket when using riak_kv_multi_backend. Can be the named backend to use when creating bucket properties for new buckets, or the named backend in use for existing buckets & bucket properties.
Public propertyBasicQuorum
When set to true, Riak will return early in some failure cases. (eg. when r=1 and you get 2 errors and a success basic_quorum=true would return an error). Can be used in conjunction when NotFoundOk=false to speed up the case an object does not exist, thereby only reading a "quorum" of not-founds instead of "N" not-founds.
Public propertyBigVclock
If the length of the vector clock is larger than BigVclock, vector clocks will be pruned.
Public propertyConsistent
Indicates whether strong consistency is enabled on this bucket.
Public propertyDataType
The DataType (if any) associated with this bucket.
Public propertyDw
Durable writes - the number of replicas that must commit to durable storage before returning a successful response.
(Inherited from RiakOptionsT.)
Public propertyHasPostcommit
Indicates whether the bucket properties have any post-commit hooks.
Public propertyHasPrecommit
Indicates whether the bucket properties have any pre-commit hooks.
Public propertyHllPrecision
The number of bits to use for HyperLogLog precision.
Public propertyLastWriteWins
The option to ignore object history (vector clock) when updating an object.
Public propertyLegacySearch
Indicates whether Legacy (Riak 1.0) Search is enabled for this bucket.
Public propertyLegacySearchEnabled
An indicator of whether legacy search indexing is enabled on the bucket.
Public propertyNotFoundOk
When set to true, an object not being found on a Riak node will count towards the R count.
Public propertyNVal
The number of replicas to create when storing data.
Public propertyPostCommitHooks
Public propertyPr
Primary Read Quorum - the number of replicas that need to be available when retrieving the object.
(Inherited from RiakOptionsT.)
Public propertyPreCommitHooks
Public propertyPw
Primary Write Quorum - the number of replicas need to be available when the write is attempted.
(Inherited from RiakOptionsT.)
Public propertyR
The number of replicas that must return before a delete is considered a succes.
(Inherited from RiakOptionsT.)
Public propertyReplicationMode
Indicates which Riak Enterprise Edition replication modes are active for this bucket.
Public propertyRw
The number of replicas that need to agree when retrieving the object.
(Inherited from RiakOptionsT.)
Public propertySearch Obsolete.
Indicates whether Legacy (Riak 1.0) Search is enabled for this bucket.
Public propertySearchEnabled Obsolete.
An indicator of whether legacy search indexing is enabled on the bucket. Please use LegacySearchEnabled instead.
Public propertySearchIndex
Indicates whether Riak Search (2.0+) is enabled for this bucket, and which Search Index is assigned to it.
Public propertySmallVclock
If the length of the vector clock is smaller than SmallVclock, vector clocks will not be pruned.
Public propertyTimeout
The Timeout period for an operation.
(Inherited from RiakOptionsT.)
Public propertyW
The number of replicas that must respond before a write is considered a success.
(Inherited from RiakOptionsT.)
Top
Methods
  NameDescription
Public methodAddPostCommitHook
Add a post-commit hook to the bucket properties.
Public methodAddPreCommitHook
Add a pre-commit hook to the bucket properties.
Public methodClearPostCommitHooks
Clear any post-commit hooks from the bucket properties.
Public methodClearPreCommitHooks
Clear any pre-commit hooks from the bucket properties.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRemovePostCommitHook
Remove a post-commit hook from the bucket properties.
Public methodRemovePreCommitHook
Remove a pre-commit hook from the bucket properties.
Public methodSetAllowMultiple
Fluent setter for the AllowMultiple property. Enable or disable allow_mult on a bucket.
Public methodSetBackend
Fluent setter for the Backend property. Sets the named backend being used for this bucket when using riak_kv_multi_backend.
Public methodSetBasicQuorum
Fluent setter for the BasicQuorum property. When set to true, Riak will return early in some failure cases. (eg. when r=1 and you get 2 errors and a success basic_quorum=true would return an error). Can be used in conjunction when NotFoundOk=false to speed up the case an object does not exist, thereby only reading a "quorum" of not-founds instead of "N" not-founds.
Public methodSetBigVclock
Fluent setter for the BigVclock property. If the length of the vector clock is larger than BigVclock, vector clocks will be pruned.
Public methodSetDw(Int32)
A fluent setter for the Dw property.
(Inherited from RiakOptionsT.)
Public methodSetDw(Quorum)
A fluent setter for the Dw property.
(Inherited from RiakOptionsT.)
Public methodSetHllPrecision
Fluent setter for the HllPrecision property. Sets the number of bits to use for HyperLogLog precision. Valid values are [4 - 16] inclusive, default is 14 on new buckets. NOTE: When changing precision, it may only be reduced from it's current value, and never increased.
Public methodSetLastWriteWins
Fluent setter for the LastWriteWins property. Enable or disable last_write_wins on a bucket.
Public methodSetLegacySearch
Fluent setter for the LegacySearch property. Enable or disable legacy search on a bucket.
Public methodSetNotFoundOk
Fluent setter for the NotFoundOk property. Enable or disable notfound_ok on a bucket. When set to true, an object not being found on a Riak node will count towards the R count.
Public methodSetNVal
Fluent setter for the NVal property. The number of replicas to create when storing data.
Public methodSetPr(Int32)
A fluent setter for the Pr property.
(Inherited from RiakOptionsT.)
Public methodSetPr(Quorum)
A fluent setter for the Pr property.
(Inherited from RiakOptionsT.)
Public methodSetPw(Int32)
A fluent setter for the Pw property.
(Inherited from RiakOptionsT.)
Public methodSetPw(Quorum)
A fluent setter for the Pw property.
(Inherited from RiakOptionsT.)
Public methodSetR(Int32)
A fluent setter for the R property.
(Inherited from RiakOptionsT.)
Public methodSetR(Quorum)
A fluent setter for the R property.
(Inherited from RiakOptionsT.)
Public methodSetRw(Int32)
A fluent setter for the Rw property.
(Inherited from RiakOptionsT.)
Public methodSetRw(Quorum)
A fluent setter for the Rw property.
(Inherited from RiakOptionsT.)
Public methodSetSearch Obsolete.
Fluent setter for the LegacySearch property. Enable or disable legacy search on a bucket.
Public methodSetSearchIndex
Fluent setter for the SearchIndex property. Sets the Search Index to use when indexing data for search.
Public methodSetSmallVclock
Fluent setter for the SmallVclock property. If the length of the vector clock is smaller than SmallVclock, vector clocks will not be pruned.
Public methodSetTimeout
A fluent setter for the Timeout property.
(Inherited from RiakOptionsT.)
Public methodSetW(Int32)
A fluent setter for the W property.
(Inherited from RiakOptionsT.)
Public methodSetW(Quorum)
A fluent setter for the W property.
(Inherited from RiakOptionsT.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks
When creating new objects, any properties not set will default to the server default values upon saving.
See Also