com.cloudant.client.api

Class Replication

java.lang.Object

com.cloudant.client.api.Replication

public class Replication
extends java.lang.Object

This class provides access to the database replication API; a replication request is sent via HTTP POST to _replicate URI.

Usage Example:

 ReplicationResult replication = db.replication()
        .source("source-db")
        .target("target-db")
        .createTarget(true)
        .filter("example/filter1")
        .trigger();

 
 List<ReplicationHistory> histories = replication.getHistories();
 
 

Since:

0.0.1

See Also:

CloudantClient.replication(), ReplicationResult, ReplicationResult.ReplicationHistory, Replicator

Method Summary

Modifier and Type	Method and Description
Replication	cancel(java.lang.Boolean cancel)
Replication	continuous(java.lang.Boolean continuous)
Replication	createTarget(java.lang.Boolean createTarget)
Replication	docIds(java.lang.String... docIds) Limit the replication to the specified document IDs.
Replication	filter(java.lang.String filter)
Replication	proxy(java.lang.String proxy)
Replication	queryParams(java.util.Map<java.lang.String,java.lang.Object> queryParams)
Replication	queryParams(java.lang.String queryParams)
Replication	sinceSeq(java.lang.Integer sinceSeq) Starts a replication since an update sequence.
Replication	source(java.lang.String source)
Replication	target(java.lang.String target)
Replication	targetOauth(java.lang.String consumerSecret, java.lang.String consumerKey, java.lang.String tokenSecret, java.lang.String token) Set OAuth 1 authentication credentials for the replication target
ReplicationResult	trigger() Triggers a replication request, blocks while the replication is in progress.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

trigger

public ReplicationResult trigger()

Triggers a replication request, blocks while the replication is in progress.

Returns:

ReplicationResult encapsulating the result

source

public Replication source(java.lang.String source)

target

public Replication target(java.lang.String target)

continuous

public Replication continuous(java.lang.Boolean continuous)

filter

public Replication filter(java.lang.String filter)

queryParams

public Replication queryParams(java.lang.String queryParams)

queryParams

public Replication queryParams(java.util.Map<java.lang.String,java.lang.Object> queryParams)

docIds

public Replication docIds(java.lang.String... docIds)

Limit the replication to the specified document IDs.

Parameters:

docIds - one or more document IDs to include in the replication

Returns:

this to set more options or trigger the replication

proxy

public Replication proxy(java.lang.String proxy)

cancel

public Replication cancel(java.lang.Boolean cancel)

createTarget

public Replication createTarget(java.lang.Boolean createTarget)

sinceSeq

public Replication sinceSeq(java.lang.Integer sinceSeq)

Starts a replication since an update sequence.

Parameters:

sinceSeq - sequence number

Returns:

this to set more options or trigger the replication

targetOauth

public Replication targetOauth(java.lang.String consumerSecret,
                               java.lang.String consumerKey,
                               java.lang.String tokenSecret,
                               java.lang.String token)

Set OAuth 1 authentication credentials for the replication target

Parameters:

consumerSecret - client secret

consumerKey - client identifier

tokenSecret - OAuth server token secret

token - OAuth server issued token

Returns:

this to set more options or trigger the replication