PutLocalDocumentOptions (IBM Cloudant Java SDK 0.0.31 API)

java.lang.Object
- com.ibm.cloud.sdk.core.service.model.GenericModel
- - com.ibm.cloud.cloudant.v1.model.PutLocalDocumentOptions

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel
```
public class PutLocalDocumentOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel
```
The putLocalDocument options.

Nested Class Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
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.
`PutLocalDocumentOptions.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 PutLocalDocumentOptions.Builder newBuilder()
```
    New builder.
    
    Returns:
    
    a PutLocalDocumentOptions 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
  - 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