com.cloudant.client.api.views

Interface SettableViewParameters.Paginated<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 Superinterfaces:

SettableViewParameters.Common<K,RB>

All Known Subinterfaces:

PaginatedRequestBuilder<K,V>

Enclosing interface:

SettableViewParameters

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

Setters for parameters only available to paginated requests.

Since:

2.0.0

Method Summary

Modifier and Type	Method and Description
RB	rowsPerPage(int rowsPerPage) Limits the number of returned rows to the specified number on each page.

Methods inherited from interface com.cloudant.client.api.views.SettableViewParameters.Common

descending, endKey, endKeyDocId, includeDocs, inclusiveEnd, keys, stale, startKey, startKeyDocId

Method Detail

rowsPerPage

RB rowsPerPage(int rowsPerPage)

Limits the number of returned rows to the specified number on each page.

Parameters:

rowsPerPage - the number of rows on each page; between 1 and Integer.MAX_VALUE-1

Returns:

the builder to compose additional parameters or build the request

Since:

2.0.0