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

Class PostViewOptions

java.lang.Object
com.ibm.cloud.sdk.core.service.model.GenericModel
com.ibm.cloud.cloudant.v1.model.PostViewOptions
All Implemented Interfaces:
com.ibm.cloud.sdk.core.service.model.ObjectModel
public class PostViewOptions extends com.ibm.cloud.sdk.core.service.model.GenericModel
The postView options.

  • Method Details

    • newBuilder

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

    • db

      public String db()
      Gets the db. Path parameter to specify the database name.
      Returns:
      the db

    • ddoc

      public String ddoc()
      Gets the ddoc. Path parameter to specify the design document name. The design document name is the design document ID excluding the `_design/` prefix.
      Returns:
      the ddoc

    • view

      public String view()
      Gets the view. Path parameter to specify the map reduce view function name.
      Returns:
      the view

    • 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 the `_conflicts` property of the returned document. Ignored if `include_docs` isn't `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 the results using the reduce function to a group rather than a single row. Implies reduce is true and the maximum group_level.
      Returns:
      the group

    • groupLevel

      public Long groupLevel()
      Gets the groupLevel. Parameter to specify the group level to be used. Implies group is true.
      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 to return only documents that match the specified keys. String representation of a JSON array containing elements 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.
      Returns:
      the reduce

    • stable

      public Boolean stable()
      Gets the stable. Parameter to specify whether view results should be returned from a stable set of shards.
      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.
      Returns:
      the update