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

Class PutDocumentOptions

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

  • Method Details

    • newBuilder

      public PutDocumentOptions.Builder newBuilder()
      New builder.
      Returns:
      a PutDocumentOptions 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

    • document

      public Document document()
      Gets the document. HTTP request body for Document operations.
      Returns:
      the document

    • body

      public InputStream body()
      Gets the body. HTTP request body for Document operations.
      Returns:
      the body

    • contentType

      public String contentType()
      Gets the contentType. The type of the input.
      Returns:
      the contentType

    • ifMatch

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

    • batch

      public String batch()
      Gets the batch. Query parameter to specify whether to store in batch mode. The server will respond with a HTTP 202 Accepted response code immediately.
      Returns:
      the batch

    • newEdits

      public Boolean newEdits()
      Gets the newEdits. Query parameter to specify whether to prevent insertion of conflicting document revisions. If false, a well-formed _rev must be included in the document. False is used by the replicator to insert documents into the target database even if that leads to the creation of conflicts. Avoid using this parameter, since this option applies document revisions without checking for conflicts, so it is very easy to accidentally end up with a large number of conflicts.
      Returns:
      the newEdits

    • rev

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