Package com.ibm.cloud.cloudant.v1.model

Class ViewQuery

java.lang.Object
com.ibm.cloud.sdk.core.service.model.GenericModel
com.ibm.cloud.cloudant.v1.model.ViewQuery
All Implemented Interfaces:
ObjectModel
public class ViewQuery extends GenericModel
Schema for a query view operation.

  • Method Details

    • newBuilder

      public ViewQuery.Builder newBuilder()
      New builder.
      Returns:
      a ViewQuery builder

    • attEncodingInfo

      public Boolean attEncodingInfo()
      Gets the attEncodingInfo. Parameter to specify whether to include the encoding information in attachment stubs if the particular attachment is compressed.
      Returns:
      the attEncodingInfo

    • attachments

      public Boolean attachments()
      Gets the attachments. Parameter to specify whether to include attachments bodies in a response.
      Returns:
      the attachments

    • conflicts

      public Boolean conflicts()
      Gets the conflicts. Parameter to specify whether to include a list of conflicted revisions in each returned document. Active only when `include_docs` is `true`.
      Returns:
      the conflicts

    • descending

      public Boolean descending()
      Gets the descending. Parameter to specify whether to return the documents in descending by key order.
      Returns:
      the descending

    • includeDocs

      public Boolean includeDocs()
      Gets the includeDocs. Parameter to specify whether to include the full content of the documents in the response.
      Returns:
      the includeDocs

    • inclusiveEnd

      public Boolean inclusiveEnd()
      Gets the inclusiveEnd. Parameter to specify whether the specified end key should be included in the result.
      Returns:
      the inclusiveEnd

    • limit

      public Long limit()
      Gets the limit. Parameter to specify the number of returned documents to limit the result to.
      Returns:
      the limit

    • skip

      public Long skip()
      Gets the skip. Parameter to specify the number of records before starting to return the results.
      Returns:
      the skip

    • updateSeq

      public Boolean updateSeq()
      Gets the updateSeq. Parameter to specify whether to include in the response an update_seq value indicating the sequence id of the database the view reflects.
      Returns:
      the updateSeq

    • endKey

      public Object endKey()
      Gets the endKey. Schema for any JSON type.
      Returns:
      the endKey

    • endKeyDocId

      public String endKeyDocId()
      Gets the endKeyDocId. Schema for a document ID.
      Returns:
      the endKeyDocId

    • group

      public Boolean group()
      Gets the group. Parameter to specify whether to group reduced results by key. Valid only if a reduce function defined in the view. If the view emits key in JSON array format, then it is possible to reduce groups further based on the number of array elements with the `group_level` parameter.
      Returns:
      the group

    • groupLevel

      public Long groupLevel()
      Gets the groupLevel. Parameter to specify a group level to be used. Only applicable if the view uses keys that are JSON arrays. Implies group is `true`. Group level groups the reduced results by the specified number of array elements. If unset, results are grouped by the entire array key, returning a reduced value for each complete key.
      Returns:
      the groupLevel

    • key

      public Object key()
      Gets the key. Schema for any JSON type.
      Returns:
      the key

    • keys

      public List<Object> keys()
      Gets the keys. Parameter to specify returning only documents that match any of the specified keys. A JSON array of keys that match the key type emitted by the view function.
      Returns:
      the keys

    • reduce

      public Boolean reduce()
      Gets the reduce. Parameter to specify whether to use the reduce function in a map-reduce view. Default is true when a reduce function is defined. A default `reduce` view type can be disabled to behave like a `map` by setting `reduce=false` explicitly. Be aware that `include_docs=true` can only be used with `map` views.
      Returns:
      the reduce

    • stable

      public Boolean stable()
      Gets the stable. Query parameter to specify whether use the same replica of the index on each request. The default value `false` contacts all replicas and returns the result from the first, fastest, responder. Setting it to `true` when used in conjunction with `update=false` may improve consistency at the expense of increased latency and decreased throughput if the selected replica is not the fastest of the available replicas. **Note:** In general setting `true` is discouraged and is strictly not recommended when using `update=true`.
      Returns:
      the stable

    • startKey

      public Object startKey()
      Gets the startKey. Schema for any JSON type.
      Returns:
      the startKey

    • startKeyDocId

      public String startKeyDocId()
      Gets the startKeyDocId. Schema for a document ID.
      Returns:
      the startKeyDocId

    • update

      public String update()
      Gets the update. Parameter to specify whether or not the view in question should be updated prior to responding to the user. * `true` - Return results after the view is updated. * `false` - Return results without updating the view. * `lazy` - Return the view results without waiting for an update, but update them immediately after the request.
      Returns:
      the update