Class PostPartitionAllDocsOptions

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

  • Method Details

    • newBuilder

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

    • db

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

    • partitionKey

      public String partitionKey()
      Gets the partitionKey. Path parameter to specify the database partition key.
      Returns:
      the partitionKey

    • attEncodingInfo

      public Boolean attEncodingInfo()
      Gets the attEncodingInfo. Parameter to specify whether to include the encoding information for compressed attachments. This only applies when requesting documents in the response.
      Returns:
      the attEncodingInfo

    • attachments

      public Boolean attachments()
      Gets the attachments. Parameter to specify whether to include attachment content in included document content or only the attachment metadata. This only applies when requesting documents in the 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. This only applies when requesting documents in the response.
      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 to include the specified end key 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 String endKey()
      Gets the endKey. Schema for a document ID.
      Returns:
      the endKey

    • key

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

    • keys

      public List<String> keys()
      Gets the keys. Schema for a list of document IDs.
      Returns:
      the keys

    • startKey

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