Package com.ibm.cloud.cloudant.v1.model

Class SchedulerDocument

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.cloud.cloudant.v1.model.SchedulerDocument

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class SchedulerDocument
extends com.ibm.cloud.sdk.core.service.model.GenericModel

Schema for a replication scheduler document.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SchedulerDocument.State	Schema for replication state.

Constructor Summary

Constructors

Constructor	Description
SchedulerDocument()

Method Summary

Modifier and Type	Method	Description
String	getDatabase()	Gets the database.
String	getDocId()	Gets the docId.
Long	getErrorCount()	Gets the errorCount.
String	getId()	Gets the id.
SchedulerInfo	getInfo()	Gets the info.
Date	getLastUpdated()	Gets the lastUpdated.
String	getNode()	Gets the node.
String	getSource()	Gets the source.
String	getSourceProxy()	Gets the sourceProxy.
Date	getStartTime()	Gets the startTime.
String	getState()	Gets the state.
String	getTarget()	Gets the target.
String	getTargetProxy()	Gets the targetProxy.

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

Constructor Detail

SchedulerDocument

public SchedulerDocument()

Method Detail

getDatabase

public String getDatabase()

Gets the database. Database where replication document came from.

Returns:

the database

getDocId

public String getDocId()

Gets the docId. Replication document ID.

Returns:

the docId

getErrorCount

public Long getErrorCount()

Gets the errorCount. Consecutive errors count. Indicates how many times in a row this replication has crashed. Replication will be retried with an exponential backoff based on this number. As soon as the replication succeeds this count is reset to 0. To can be used to get an idea why a particular replication is not making progress.

Returns:

the errorCount

getId

public String getId()

Gets the id. Replication ID, or null if state is completed or failed.

Returns:

the id

getInfo

public SchedulerInfo getInfo()

Gets the info. Schema for scheduler document information. A JSON object that may contain additional information about the state. For error states this will contain an error field and string value.

Returns:

the info

getLastUpdated

public Date getLastUpdated()

Gets the lastUpdated. Timestamp of last state update.

Returns:

the lastUpdated

getNode

public String getNode()

Gets the node. Cluster node where the job is running.

Returns:

the node

getSource

public String getSource()

Gets the source. Replication source.

Returns:

the source

getSourceProxy

public String getSourceProxy()

Gets the sourceProxy. Address of the (http or socks5 protocol) proxy server through which replication with the source database occurs.

Returns:

the sourceProxy

getStartTime

public Date getStartTime()

Gets the startTime. Timestamp of when the replication was started.

Returns:

the startTime

getState

public String getState()

Gets the state. Schema for replication state.

Returns:

the state

getTarget

public String getTarget()

Gets the target. Replication target.

Returns:

the target

getTargetProxy

public String getTargetProxy()

Gets the targetProxy. Address of the (http or socks5 protocol) proxy server through which replication with the target database occurs.

Returns:

the targetProxy