org.ektorp

Class ReplicationCommand.Builder

java.lang.Object

org.ektorp.ReplicationCommand.Builder

Enclosing class:

ReplicationCommand

public static class ReplicationCommand.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ReplicationCommand	build()
ReplicationCommand.Builder	cancel(boolean b) true cancels a continuous replication task
ReplicationCommand.Builder	continuous(boolean b) true makes replication continuous
ReplicationCommand.Builder	createTarget(boolean b) To create the target database (remote or local) prior to replication.
ReplicationCommand.Builder	docIds(Collection<String> docIds) Restricts replication to the specified document ids.
ReplicationCommand.Builder	filter(String s) Specify a filter function.
ReplicationCommand.Builder	id(String s) Id of replication.
ReplicationCommand.Builder	proxy(String s) Pass a "proxy" argument in the replication data to have replication go through an HTTP proxy
ReplicationCommand.Builder	queryParams(Object o) Pass parameters to the filter function if specified.
ReplicationCommand.Builder	sinceSeq(String sinceSeq) The sequence from which the replication should start See http://docs.couchdb.org/en/latest/json-structure.html#replication-settings for details CouchDB expects a Long value for the sequence Cloudant expects a String value for the sequence
ReplicationCommand.Builder	source(String s) Source and target can both point at local databases, remote databases and any combination of these.
ReplicationCommand.Builder	target(String s) Source and target can both point at local databases, remote databases and any combination of these If your local CouchDB instance is secured by an admin account, you need to use the full URL format.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

id

public ReplicationCommand.Builder id(String s)

Id of replication.

Parameters:

s -

Returns:

source

public ReplicationCommand.Builder source(String s)

Source and target can both point at local databases, remote databases and any combination of these. If your local CouchDB instance is secured by an admin account, you need to use the full URL format

Parameters:

s -

Returns:

target

public ReplicationCommand.Builder target(String s)

Source and target can both point at local databases, remote databases and any combination of these If your local CouchDB instance is secured by an admin account, you need to use the full URL format.

Parameters:

s -

Returns:

proxy

public ReplicationCommand.Builder proxy(String s)

Pass a "proxy" argument in the replication data to have replication go through an HTTP proxy

Parameters:

s -

Returns:

filter

public ReplicationCommand.Builder filter(String s)

Specify a filter function.

Parameters:

s -

Returns:

docIds

public ReplicationCommand.Builder docIds(Collection<String> docIds)

Restricts replication to the specified document ids.

Parameters:

docIds -

Returns:

continuous

public ReplicationCommand.Builder continuous(boolean b)

true makes replication continuous

Parameters:

b -

Returns:

cancel

public ReplicationCommand.Builder cancel(boolean b)

true cancels a continuous replication task

Parameters:

b -

Returns:

queryParams

public ReplicationCommand.Builder queryParams(Object o)

Pass parameters to the filter function if specified.

Parameters:

o -

Returns:

createTarget

public ReplicationCommand.Builder createTarget(boolean b)

To create the target database (remote or local) prior to replication. The names of the source and target databases do not have to be the same.

Parameters:

b -

Returns:

sinceSeq

public ReplicationCommand.Builder sinceSeq(String sinceSeq)

The sequence from which the replication should start See http://docs.couchdb.org/en/latest/json-structure.html#replication-settings for details CouchDB expects a Long value for the sequence Cloudant expects a String value for the sequence

Parameters:

sinceSeq - as String

Returns:

build

public ReplicationCommand build()