SettableViewParameters.Common (cloudant-client 2.14.0 API)

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:

AllDocsRequestBuilder, MultipleRequestBuilder<K,V>, PaginatedRequestBuilder<K,V>, SettableViewParameters.Paginated<K,RB>, SettableViewParameters.Unpaginated<K,RB>, UnpaginatedRequestBuilder<K,V>

Enclosing interface:

SettableViewParameters
```
public static interface SettableViewParameters.Common<K,RB extends RequestBuilder>
```
Setters for parameters that are common to all view requests.

Since:

2.0.0

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`RB`	`descending(boolean descending)` Return the documents in ‘descending by key’ order.
`RB`	`endKey(K endkey)` Stop returning records when the specified key is reached.
`RB`	`endKeyDocId(java.lang.String endkey_docid)` Stop returning records when the specified document ID is reached.
`RB`	`includeDocs(boolean include_docs)` Include the full content of the documents in the response.
`RB`	`inclusiveEnd(boolean inclusive_end)` Include rows with the specified endkey.
`RB`	`keys(K... keys)` Return only documents that match the specified key or keys.
`RB`	`stable(boolean stable)` Determine whether the view should be returned from a "stable" set of shards.
`RB`	`stale(java.lang.String stale)` Deprecated. use `stable(boolean)` and `update(String)` instead
`RB`	`startKey(K startkey)` Return records starting with the specified key.
`RB`	`startKeyDocId(java.lang.String startkey_docid)` Return records starting with the specified document ID.
`RB`	`update(java.lang.String update)` Determine whether the view in question should be updated prior to or after responding to the user.

- Method Detail
  - descending
```
RB descending(boolean descending)
```
    Return the documents in ‘descending by key’ order.
    
    Parameters:
    
    descending - true to return the documents in "descending by key" order, default false
    
    Returns:
    
    the builder to compose additional parameters or build the request
    
    Since:
    
    2.0.0
  - endKey
```
RB endKey(K endkey)
```
    Stop returning records when the specified key is reached.
    
    Parameters:
    
    endkey - of the type emitted by the view
    
    Returns:
    
    the builder to compose additional parameters or build the request
    
    Since:
    
    2.0.0
  - endKeyDocId
```
RB endKeyDocId(java.lang.String endkey_docid)
```
    Stop returning records when the specified document ID is reached.
    Used to distinguish between records with the same endkey.
    
    Parameters:
    
    endkey_docid - endkey document ID
    
    Returns:
    
    the builder to compose additional parameters or build the request
    
    Since:
    
    2.0.0
  - includeDocs
```
RB includeDocs(boolean include_docs)
```
    Include the full content of the documents in the response.
    Note that using include_docs=true might have performance implications.
    
    Parameters:
    
    include_docs - true to return the full content, default false
    
    Returns:
    
    the builder to compose additional parameters or build the request
    
    Since:
    
    2.0.0
  - inclusiveEnd
```
RB inclusiveEnd(boolean inclusive_end)
```
    Include rows with the specified endkey.
    
    Parameters:
    
    inclusive_end - false to exclude, default true
    
    Returns:
    
    the builder to compose additional parameters or build the request
    
    Since:
    
    2.0.0
  - keys
```
RB keys(K... keys)
```
    Return only documents that match the specified key or keys.
    
    Parameters:
    
    keys - one or more keys of the type emitted by the view
    
    Returns:
    
    the builder to compose additional parameters or build the request
    
    Since:
    
    2.0.0
  - stable
```
RB stable(boolean stable)
```
    Determine whether the view should be returned from a "stable" set of shards.
    
    Parameters:
    
    stable - string indicating stable view behaviour
    
    Returns:
    
    the builder to compose additional parameters or build the request
    
    Since:
    
    2.13.0
  - stale
```
RB stale(java.lang.String stale)
```
    Deprecated. use stable(boolean) and update(String) instead
    Allow the results from a stale view to be used. This makes the request return immediately, even if the view has not been completely built yet.
    If this parameter is not given, a response is returned only after the view has been built.
    
    See:
    - SettableViewParameters.STALE_OK
    - SettableViewParameters.STALE_UPDATE_AFTER
    Parameters:
    
    stale - string indicating stale view behaviour
    
    Returns:
    
    the builder to compose additional parameters or build the request
    
    Since:
    
    2.0.0
  - startKey
```
RB startKey(K startkey)
```
    Return records starting with the specified key.
    
    Parameters:
    
    startkey - of the type emitted by the view
    
    Returns:
    
    the builder to compose additional parameters or build the request
    
    Since:
    
    2.0.0
  - startKeyDocId
```
RB startKeyDocId(java.lang.String startkey_docid)
```
    Return records starting with the specified document ID.
    Used to distinguish between records with the same endkey.
    
    Parameters:
    
    startkey_docid - startkey document ID
    
    Returns:
    
    the builder to compose additional parameters or build the request
    
    Since:
    
    2.0.0
  - update
```
RB update(java.lang.String update)
```
    Determine whether the view in question should be updated prior to or after responding to the user.
    
    See:
    Parameters:
    
    update - string indicating update view behaviour
    
    Returns:
    
    the builder to compose additional parameters or build the request
    
    Since:
    
    2.13.0

Interface SettableViewParameters.Common<K,RB extends RequestBuilder>

Method Summary

Method Detail

descending

endKey

endKeyDocId

includeDocs

inclusiveEnd

keys

stable

stale

startKey

startKeyDocId

update