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

Class GetDocumentOptions

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

  • Method Details

    • newBuilder

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

    • db

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

    • docId

      public String docId()
      Gets the docId. Path parameter to specify the document ID.
      Returns:
      the docId

    • ifNoneMatch

      public String ifNoneMatch()
      Gets the ifNoneMatch. Header parameter for a conditional HTTP request not matching an ETag.
      Returns:
      the ifNoneMatch

    • attachments

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

    • attEncodingInfo

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

    • conflicts

      public Boolean conflicts()
      Gets the conflicts. Query 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

    • deletedConflicts

      public Boolean deletedConflicts()
      Gets the deletedConflicts. Query parameter to specify whether to include a list of deleted conflicted revisions in the `_deleted_conflicts` property of the returned document.
      Returns:
      the deletedConflicts

    • latest

      public Boolean latest()
      Gets the latest. Query parameter to specify whether to force retrieving latest leaf revision, no matter what rev was requested.
      Returns:
      the latest

    • localSeq

      public Boolean localSeq()
      Gets the localSeq. Query parameter to specify whether to include the last update sequence for the document.
      Returns:
      the localSeq

    • meta

      public Boolean meta()
      Gets the meta. Query parameter to specify whether to include document meta information. Acts the same as specifying all of the conflicts, deleted_conflicts and open_revs query parameters.
      Returns:
      the meta

    • rev

      public String rev()
      Gets the rev. Query parameter to specify a document revision.
      Returns:
      the rev

    • revs

      public Boolean revs()
      Gets the revs. Query parameter to specify whether to include a list of all known document revisions.
      Returns:
      the revs

    • revsInfo

      public Boolean revsInfo()
      Gets the revsInfo. Query parameter to specify whether to includes detailed information for all known document revisions.
      Returns:
      the revsInfo