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

Class PostDocumentOptions

java.lang.Object

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

com.ibm.cloud.cloudant.v1.model.PostDocumentOptions

All Implemented Interfaces:

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

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

The postDocument options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PostDocumentOptions.Batch	Query parameter to specify whether to store in batch mode.
static class	PostDocumentOptions.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.
Document	document()	Gets the document.
PostDocumentOptions.Builder	newBuilder()	New builder.

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 PostDocumentOptions.Builder newBuilder()

New builder.

Returns:

a PostDocumentOptions builder

db

public String db()

Gets the db. Path parameter to specify the database name.

Returns:

the db

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

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