com.cloudant.client.api.views

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

AllDocsRequestBuilder, MultipleRequestBuilder<K,V>, UnpaginatedRequestBuilder<K,V>

Enclosing interface:

SettableViewParameters

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

Setters for parameters only available to unpaginated requests.

Since:

2.0.0

Method Summary

Modifier and Type	Method and Description
RB	limit(int limit) Limits the number of returned rows to the specified count.
RB	skip(long skip) Skips the specified number of rows from the start.

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

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

Method Detail

limit

RB limit(int limit)

Limits the number of returned rows to the specified count.

Do not use skip/limit for pagination, instead use ViewRequestBuilder.newPaginatedRequest(Key.Type, Class) .

Parameters:

limit - the number of results to limit to

Returns:

the builder to compose additional parameters or build the request

Since:

2.0.0

skip

RB skip(long skip)

Skips the specified number of rows from the start.

Do not use skip/limit for pagination, instead use ViewRequestBuilder.newPaginatedRequest(Key.Type, Class) .

Parameters:

skip - the number of results to skip

Returns:

the builder to compose additional parameters or build the request

Since:

2.0.0