| RiakIndexGetOptions Class |
Represents a collection of optional properties when executing secondary index queries.
Each property changes the semantics of the operation slightly.
Inheritance HierarchyNamespace: RiakClient.Models
Assembly: RiakClient (in RiakClient.dll) Version: f9bb17a3f8ff6940b88010a52f202e3d55fe25c5
SyntaxThe RiakIndexGetOptions type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | RiakIndexGetOptions |
Initializes a new instance of the RiakIndexGetOptions class.
|
Properties| Name | Description | |
|---|---|---|
 | Continuation |
The continuation string for this query.
Used to page results when combined with MaxResults.
|
| Dw |
Durable writes - the number of replicas that must commit to durable storage before returning a successful response.
(Inherited from RiakOptionsT.) |
| MaxResults |
The maximum number of results returned by the query.
|
| PaginationSort |
The option to sort, or not sort, the results of a non-paginated secondary index query.
If MaxResults is set, this property is ignored.
By default results are sorted first by index value, then by key value.
|
| Pr |
Primary Read Quorum - the number of replicas that need to be available when retrieving the object.
(Inherited from RiakOptionsT.) |
| Pw |
Primary Write Quorum - the number of replicas need to be available when the write is attempted.
(Inherited from RiakOptionsT.) |
| R |
The number of replicas that must return before a delete is considered a succes.
(Inherited from RiakOptionsT.) |
| ReturnTerms |
The option to return the index keys with the Riak object keys.
|
| Rw |
The number of replicas that need to agree when retrieving the object.
(Inherited from RiakOptionsT.) |
| Stream |
The option to stream results back as they are available, instead of letting Riak
aggregate the entire result set before returning them.
|
| TermRegex |
The option to filter result terms with a Regex.
|
| Timeout |
The Timeout period for an operation.
(Inherited from RiakOptionsT.) |
| W |
The number of replicas that must respond before a write is considered a success.
(Inherited from RiakOptionsT.) |
Methods| Name | Description | |
|---|---|---|
| Equals | (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| SetContinuation(BigInteger) |
Fluent setter for the Continuation property.
The continuation string for this query.
Used to page results when combined with MaxResults.
|
| SetContinuation(String) |
Fluent setter for the Continuation property.
The continuation string for this query.
Used to page results when combined with MaxResults.
|
| SetDw(Int32) |
A fluent setter for the Dw property.
(Inherited from RiakOptionsT.) |
| SetDw(Quorum) |
A fluent setter for the Dw property.
(Inherited from RiakOptionsT.) |
| SetMaxResults |
Fluent setter for the MaxResults property.
The maximum number of results returned by the query.
|
| SetPaginationSort |
Fluent setter for the PaginationSort property.
The option to sort, or not sort, the results of a non-paginated secondary index query.
If MaxResults is set, this property is ignored.
By default results are sorted first by index value, then by key value.
|
| SetPr(Int32) |
A fluent setter for the Pr property.
(Inherited from RiakOptionsT.) |
| SetPr(Quorum) |
A fluent setter for the Pr property.
(Inherited from RiakOptionsT.) |
| SetPw(Int32) |
A fluent setter for the Pw property.
(Inherited from RiakOptionsT.) |
| SetPw(Quorum) |
A fluent setter for the Pw property.
(Inherited from RiakOptionsT.) |
| SetR(Int32) |
A fluent setter for the R property.
(Inherited from RiakOptionsT.) |
| SetR(Quorum) |
A fluent setter for the R property.
(Inherited from RiakOptionsT.) |
| SetReturnTerms |
Fluent setter for the ReturnTerms property.
The option to return the index keys with the Riak object keys.
|
| SetRw(Int32) |
A fluent setter for the Rw property.
(Inherited from RiakOptionsT.) |
| SetRw(Quorum) |
A fluent setter for the Rw property.
(Inherited from RiakOptionsT.) |
| SetStream |
Fluent setter for the Stream property.
The option to stream results back as they are available, instead of letting Riak
aggregate the entire result set before returning them.
|
| SetTermRegex |
Fluent setter for the TermRegex property.
The option to filter result terms with a Regex.
|
| SetTimeout |
A fluent setter for the Timeout property.
(Inherited from RiakOptionsT.) |
| SetW(Int32) |
A fluent setter for the W property.
(Inherited from RiakOptionsT.) |
| SetW(Quorum) |
A fluent setter for the W property.
(Inherited from RiakOptionsT.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also