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

Class ActiveTask

java.lang.Object
com.ibm.cloud.sdk.core.service.model.GenericModel
com.ibm.cloud.cloudant.v1.model.ActiveTask
All Implemented Interfaces:
com.ibm.cloud.sdk.core.service.model.ObjectModel
public class ActiveTask extends com.ibm.cloud.sdk.core.service.model.GenericModel
Schema for information about a running task.

  • Method Details

    • getBulkGetAttempts

      public Long getBulkGetAttempts()
      Gets the bulkGetAttempts. The total count of attempted doc revisions fetched with `_bulk_get`. Available for `replication` type tasks.
      Returns:
      the bulkGetAttempts

    • getBulkGetDocs

      public Long getBulkGetDocs()
      Gets the bulkGetDocs. The total count of successful docs fetched with `_bulk_get`. Available for `replication` type tasks.
      Returns:
      the bulkGetDocs

    • getChangesDone

      public Long getChangesDone()
      Gets the changesDone. Processed changes. Available for `database_compaction`, `indexer`, `search_indexer`, `view_compaction` type tasks.
      Returns:
      the changesDone

    • getChangesPending

      public Long getChangesPending()
      Gets the changesPending. The count of changes not yet replicated. Available for `replication` type tasks.
      Returns:
      the changesPending

    • getCheckpointInterval

      public Long getCheckpointInterval()
      Gets the checkpointInterval. Specifies the checkpoint interval in ms. Available for `replication` type tasks.
      Returns:
      the checkpointInterval

    • getCheckpointedSourceSeq

      public String getCheckpointedSourceSeq()
      Gets the checkpointedSourceSeq. The source sequence id which was last successfully replicated. Available for `replication` type tasks.
      Returns:
      the checkpointedSourceSeq

    • isContinuous

      public Boolean isContinuous()
      Gets the continuous. The replication configured to be continuous. Available for `replication` type tasks.
      Returns:
      the continuous

    • getDatabase

      public String getDatabase()
      Gets the database. Source database.
      Returns:
      the database

    • getDesignDocument

      public String getDesignDocument()
      Gets the designDocument. The design document that belongs to this task. Available for `indexer`, `search_indexer`, `view_compaction` type tasks.
      Returns:
      the designDocument

    • getDocId

      public String getDocId()
      Gets the docId. Replication document ID. Available for `replication` type tasks.
      Returns:
      the docId

    • getDocWriteFailures

      public Long getDocWriteFailures()
      Gets the docWriteFailures. Number of document write failures. Available for `replication` type tasks.
      Returns:
      the docWriteFailures

    • getDocsRead

      public Long getDocsRead()
      Gets the docsRead. Number of documents read. Available for `replication` type tasks.
      Returns:
      the docsRead

    • getDocsWritten

      public Long getDocsWritten()
      Gets the docsWritten. Number of documents written to target. Available for `replication` type tasks.
      Returns:
      the docsWritten

    • getIndex

      public String getIndex()
      Gets the index. The search index that belongs to this task. Available for `search_indexer` type tasks.
      Returns:
      the index

    • getIndexerPid

      public String getIndexerPid()
      Gets the indexerPid. Indexer process ID. Available for `indexer` type tasks.
      Returns:
      the indexerPid

    • getMissingRevisionsFound

      public Long getMissingRevisionsFound()
      Gets the missingRevisionsFound. The count of docs which have been read from the source. Available for `replication` type tasks.
      Returns:
      the missingRevisionsFound

    • getNode

      public String getNode()
      Gets the node. Cluster node where the task is running.
      Returns:
      the node

    • getPhase

      public String getPhase()
      Gets the phase. The phase the active task is in. `docid_sort`, `docid_copy`, `document_copy` phases are available for `database_compaction`, while `ids` and `view` phases are available for `view_compaction` type tasks.
      Returns:
      the phase

    • getPid

      public String getPid()
      Gets the pid. Process ID.
      Returns:
      the pid

    • getProcessStatus

      public String getProcessStatus()
      Gets the processStatus. Process status.
      Returns:
      the processStatus

    • getProgress

      public Long getProgress()
      Gets the progress. Current percentage progress. Available for `database_compaction`, `indexer`, `search_indexer`, `view_compaction` type tasks.
      Returns:
      the progress

    • getReplicationId

      public String getReplicationId()
      Gets the replicationId. Replication ID. Available for `replication` type tasks.
      Returns:
      the replicationId

    • isRetry

      public Boolean isRetry()
      Gets the retry. Indicates whether a compaction retry is currently running on the database. Available for `database_compaction` type tasks.
      Returns:
      the retry

    • getRevisionsChecked

      public Long getRevisionsChecked()
      Gets the revisionsChecked. The count of revisions which have been checked since this replication began. Available for `replication` type tasks.
      Returns:
      the revisionsChecked

    • getSource

      public String getSource()
      Gets the source. Replication source. Available for `replication` type tasks.
      Returns:
      the source

    • getSourceSeq

      public String getSourceSeq()
      Gets the sourceSeq. The last sequence number obtained from the source database changes feed. Available for `replication` type tasks.
      Returns:
      the sourceSeq

    • getStartedOn

      public Long getStartedOn()
      Gets the startedOn. Schema for a Unix epoch timestamp.
      Returns:
      the startedOn

    • getTarget

      public String getTarget()
      Gets the target. Replication target. Available for `replication` type tasks.
      Returns:
      the target

    • getThroughSeq

      public String getThroughSeq()
      Gets the throughSeq. The last sequence number processed by the replicator. Available for `replication` type tasks.
      Returns:
      the throughSeq

    • getTotalChanges

      public Long getTotalChanges()
      Gets the totalChanges. Total changes to process. Available for `database_compaction`, `indexer`, `search_indexer`, `view_compaction` type tasks.
      Returns:
      the totalChanges

    • getType

      public String getType()
      Gets the type. Operation type.
      Returns:
      the type

    • getUpdatedOn

      public Long getUpdatedOn()
      Gets the updatedOn. Schema for a Unix epoch timestamp.
      Returns:
      the updatedOn

    • getUser

      public String getUser()
      Gets the user. Name of user running replication or owning the indexer. Available for `indexer`, `replication` type tasks.
      Returns:
      the user

    • getView

      public Long getView()
      Gets the view. Number of view indexes. Available for `view_compaction` type tasks.
      Returns:
      the view