PutReplicationDocumentOptions (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.PutReplicationDocumentOptions

All Implemented Interfaces:

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

Nested Class Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`batch()`	Gets the batch.
`String`	`docId()`	Gets the docId.
`String`	`ifMatch()`	Gets the ifMatch.
`PutReplicationDocumentOptions.Builder`	`newBuilder()`	New builder.
`Boolean`	`newEdits()`	Gets the newEdits.
`ReplicationDocument`	`replicationDocument()`	Gets the replicationDocument.
`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 PutReplicationDocumentOptions.Builder newBuilder()
```
    New builder.
    
    Returns:
    
    a PutReplicationDocumentOptions builder
  - docId
```
public String docId()
```
    Gets the docId. Path parameter to specify the document ID.
    
    Returns:
    
    the docId
  - replicationDocument
```
public ReplicationDocument replicationDocument()
```
    Gets the replicationDocument. HTTP request body for replication operations.
    
    Returns:
    
    the replicationDocument
  - 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