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) Specify a filter function to limit the documents that are replicated from the source database.
Replication	proxy(java.lang.String proxy)
Replication	queryParams(java.util.Map<java.lang.String,java.lang.Object> queryParams) Specify additional query parameters to be passed to the filter function.
Replication	queryParams(java.lang.String queryParams) Specify additional query parameters to be passed to the filter function.
Replication	sinceSeq(java.lang.Integer sinceSeq) Starts a replication since an update sequence.
Replication	source(java.lang.String source) Specify the name or URL of the database source of the replication.
Replication	sourceIamApiKey(java.lang.String iamApiKey) Sets the IAM API key for the replication source.
Replication	target(java.lang.String target) Specify the name or URL of the database target of the replication.
Replication	targetIamApiKey(java.lang.String iamApiKey) Sets the IAM API key for the replication 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

clone, equals, finalize, 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)

Specify the name or URL of the database source of the replication. A URL is required if the database is on a different server or account than the CloudantClient is connected to. If the database requires credentials they should be URL encoded in the user info of the URL.

Parameters:

source - name or URL of the source database

Returns:

this Replication instance to set more options or trigger the replication

target

public Replication target(java.lang.String target)

Specify the name or URL of the database target of the replication. A URL is required if the database is on a different server or account than the CloudantClient is connected to. If the database requires credentials they should be URL encoded in the user info of the URL.

Parameters:

target - name or URL of the target database

Returns:

this Replication instance to set more options or trigger the replication

continuous

public Replication continuous(java.lang.Boolean continuous)

Parameters:

continuous - true if the Replication should be continuous

Returns:

this Replication instance to set more options or trigger the replication

filter

public Replication filter(java.lang.String filter)

Specify a filter function to limit the documents that are replicated from the source database.

Parameters:

filter - name of the filter function in the form of designDoc/filter

Returns:

this Replication instance to set more options or trigger the replication

queryParams

public Replication queryParams(java.lang.String queryParams)

Specify additional query parameters to be passed to the filter function. Takes a string form of a JSON object of the key value parameters. For example: "{\"key1\": \"value1\", \"key2\": \"value2\"}"

Parameters:

queryParams - string form of JSON object of query parameters

Returns:

this Replication instance to set more options or trigger the replication

queryParams

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

Specify additional query parameters to be passed to the filter function.

Parameters:

queryParams - map of key-value parameters

Returns:

this Replication instance to set more options or trigger the replication

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 Replication instance to set more options or trigger the replication

proxy

public Replication proxy(java.lang.String proxy)

Parameters:

proxy - address of a proxy server through which the replication should occur

Returns:

this Replication instance to set more options or trigger the replication

cancel

public Replication cancel(java.lang.Boolean cancel)

Parameters:

cancel - true to cancel the replication

Returns:

this Replication instance to set more options or trigger the replication

createTarget

public Replication createTarget(java.lang.Boolean createTarget)

Parameters:

createTarget - true if the target database should be created

Returns:

this Replication instance to set more options or trigger the replication

sinceSeq

public Replication sinceSeq(java.lang.Integer sinceSeq)

Starts a replication since an update sequence.

Parameters:

sinceSeq - sequence number

Returns:

this Replication instance to set more options or trigger the replication

sourceIamApiKey

public Replication sourceIamApiKey(java.lang.String iamApiKey)

Sets the IAM API key for the replication source.

Parameters:

iamApiKey - IAM API Key

Returns:

this Replication instance to set more options or trigger the replication

targetIamApiKey

public Replication targetIamApiKey(java.lang.String iamApiKey)

Sets the IAM API key for the replication target.

Parameters:

iamApiKey - IAM API Key

Returns:

this Replication instance 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 Replication instance to set more options or trigger the replication