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:
ObjectModel
public class SchedulerDocument extends GenericModel
Schema for a replication scheduler document.

  • Method Details

    • 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

      @Deprecated public String getSourceProxy()
      Deprecated.
      this method is deprecated and may be removed in a future release
      Gets the sourceProxy. Forbidden in IBM Cloudant mediated replications. 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

      @Deprecated public String getTargetProxy()
      Deprecated.
      this method is deprecated and may be removed in a future release
      Gets the targetProxy. Forbidden in IBM Cloudant mediated replications. Address of the (http or socks5 protocol) proxy server through which replication with the target database occurs.
      Returns:
      the targetProxy