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

Class DatabaseInformation

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

  • Method Details

    • getCluster

      public DatabaseInformationCluster getCluster()
      Gets the cluster. Schema for database cluster information.
      Returns:
      the cluster

    • getCommittedUpdateSeq

      public String getCommittedUpdateSeq()
      Gets the committedUpdateSeq. An opaque string that describes the committed state of the database.
      Returns:
      the committedUpdateSeq

    • isCompactRunning

      public Boolean isCompactRunning()
      Gets the compactRunning. True if the database compaction routine is operating on this database.
      Returns:
      the compactRunning

    • getCompactedSeq

      public String getCompactedSeq()
      Gets the compactedSeq. An opaque string that describes the compaction state of the database.
      Returns:
      the compactedSeq

    • getDbName

      public String getDbName()
      Gets the dbName. The name of the database.
      Returns:
      the dbName

    • getDiskFormatVersion

      public Long getDiskFormatVersion()
      Gets the diskFormatVersion. The version of the physical format used for the data when it is stored on disk.
      Returns:
      the diskFormatVersion

    • getDocCount

      public Long getDocCount()
      Gets the docCount. A count of the documents in the specified database.
      Returns:
      the docCount

    • getDocDelCount

      public Long getDocDelCount()
      Gets the docDelCount. Number of deleted documents.
      Returns:
      the docDelCount

    • getEngine

      public String getEngine()
      Gets the engine. The engine used for the database.
      Returns:
      the engine

    • getInstanceStartTime

      public String getInstanceStartTime()
      Gets the instanceStartTime. An opaque string to detect whether a database has been recreated. The field name is for compatibility with old replicator versions. Do not use the value to infer timing infromation. Typically only used by replicators.
      Returns:
      the instanceStartTime

    • getProps

      public DatabaseInformationProps getProps()
      Gets the props. Schema for database properties.
      Returns:
      the props

    • getSizes

      public ContentInformationSizes getSizes()
      Gets the sizes. Schema for size information of content.
      Returns:
      the sizes

    • getUpdateSeq

      public String getUpdateSeq()
      Gets the updateSeq. An opaque string that describes the state of the database. Do not rely on this string for counting the number of updates.
      Returns:
      the updateSeq

    • getUuid

      public String getUuid()
      Gets the uuid. The UUID of the database.
      Returns:
      the uuid

    • getPartitionedIndexes

      public PartitionedIndexesInformation getPartitionedIndexes()
      Gets the partitionedIndexes. Information about database's partitioned indexes.
      Returns:
      the partitionedIndexes