com.cloudant.client.api.views

Interface SettableViewParameters.Reduceable<K,RB extends RequestBuilder>

Type Parameters:

K - the type of the key emitted by the view

RB - the type of the request builder returned after each set operation

All Known Subinterfaces:

PaginatedRequestBuilder<K,V>, UnpaginatedRequestBuilder<K,V>

Enclosing interface:

SettableViewParameters

public static interface SettableViewParameters.Reduceable<K,RB extends RequestBuilder>

Setters for parameters applicable to views that have reduce

Method Summary

Modifier and Type	Method and Description
RB	group(boolean group) Group the results to a group or single row when using a reduce function.
RB	groupLevel(int group_level) Group reduce results for the specified number of array fields.
RB	reduce(boolean reduce) Use the reduce function of the view.

Method Detail

reduce

RB reduce(boolean reduce)

Use the reduce function of the view.

Note that although the default is true if a view does not have a reduce function this parameter will have no effect.

Parameters:

reduce - false to not use reduce, default true

Returns:

the builder to compose additional parameters or build the request

Since:

2.0.0

group

RB group(boolean group)

Group the results to a group or single row when using a reduce function.

Parameters:

group - true to group, default false,

Returns:

the builder to compose additional parameters or build the request

Since:

2.0.0

groupLevel

RB groupLevel(int group_level)

Group reduce results for the specified number of array fields. Only applicable when using a complex (JSON array) key.

Parameters:

group_level - number of array fields to group

Returns:

the builder to compose additional parameters or build the request

Since:

2.0.0