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:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class PutDocumentOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The putDocument options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutDocumentOptions.Batch	Query parameter to specify whether to store in batch mode.
static class	PutDocumentOptions.Builder	Builder.

Method Summary

Modifier and Type	Method	Description
String	batch()	Gets the batch.
InputStream	body()	Gets the body.
String	contentType()	Gets the contentType.
String	db()	Gets the db.
String	docId()	Gets the docId.
Document	document()	Gets the document.
String	ifMatch()	Gets the ifMatch.
PutDocumentOptions.Builder	newBuilder()	New builder.
Boolean	newEdits()	Gets the newEdits.
String	rev()	Gets the rev.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

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 to specify the document revision. Alternative to rev query parameter.

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.

Returns:

the newEdits

rev

public String rev()

Gets the rev. Query parameter to specify a document revision.

Returns:

the rev