Package com.oracle.bmc.distributeddatabase.model

Class DistributedDatabase

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20250101")
public final class DistributedDatabase
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Globally distributed database.
    Note: Objects should always be created or deserialized using the DistributedDatabase.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the DistributedDatabase.Builder, which maintain a set of all explicitly set fields called DistributedDatabase.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getId

        public String getId()
        The OCID of the Globally distributed database.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the Globally distributed database compartment.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        The display name of the Globally distributed database.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The time the Globally distributed database was created.

        An RFC3339 formatted datetime string

        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The time the Globally distributed database was last updated.

        An RFC3339 formatted datetime string

        Returns:
        the value

      • getDatabaseVersion

        public String getDatabaseVersion()
        Oracle Database version for the shards and catalog used in Globally distributed database.
        Returns:
        the value

      • getLifecycleDetails

        public String getLifecycleDetails()
        The lifecycleDetails for the Globally distributed database.
        Returns:
        the value

      • getPrefix

        public String getPrefix()
        Unique name prefix for the Globally distributed databases.

        Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.

        Returns:
        the value

      • getPrivateEndpointIds

        public List<String> getPrivateEndpointIds()
        The collection of OCID of the private endpoint associated with Globally distributed autonomous database.
        Returns:
        the value

      • getCharacterSet

        public String getCharacterSet()
        The character set for the database.
        Returns:
        the value

      • getNcharacterSet

        public String getNcharacterSet()
        The national character set for the database.
        Returns:
        the value

      • getChunks

        public Integer getChunks()
        The default number of unique chunks in a shardspace.

        The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace.

        Returns:
        the value

      • getListenerPort

        public Integer getListenerPort()
        The Global service manager listener port number for the Globally distributed database.
        Returns:
        the value

      • getListenerPortTls

        public Integer getListenerPortTls()
        The TLS listener port number for Globally distributed database.
        Returns:
        the value

      • getOnsPortLocal

        public Integer getOnsPortLocal()
        Ons local port number.
        Returns:
        the value

      • getOnsPortRemote

        public Integer getOnsPortRemote()
        Ons remote port number.
        Returns:
        the value

      • getReplicationMethod

        public DistributedDatabase.ReplicationMethod getReplicationMethod()
        The Replication method for Globally distributed database.

        Use RAFT for Raft replication, and DG for DataGuard. If replicationMethod is not provided, it defaults to DG.

        Returns:
        the value

      • getReplicationFactor

        public Integer getReplicationFactor()
        The Replication factor for RAFT replication based Globally distributed database.

        Currently supported values are 3, 5 and 7.

        Returns:
        the value

      • getReplicationUnit

        public Integer getReplicationUnit()
        For RAFT replication based Globally distributed database, the value should be atleast twice the number of shards.
        Returns:
        the value

      • getShardDetails

        public List<DistributedDatabaseShard> getShardDetails()
        Collection of shards associated with the Globally distributed database.
        Returns:
        the value

      • getCatalogDetails

        public List<DistributedDatabaseCatalog> getCatalogDetails()
        Collection of catalogs associated with the Globally distributed database.
        Returns:
        the value

      • getGsmDetails

        public List<DistributedDatabaseGsm> getGsmDetails()
        Collection of catalogs associated with the Globally distributed database.
        Returns:
        the value

      • getGsmSshPublicKey

        public String getGsmSshPublicKey()
        The SSH public key for Global service manager instances.
        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        Simple key-value pair that is applied without any predefined name, type or scope.

        Exists for cross-compatibility only. Example: {“bar-key”: “value”}

        Returns:
        the value

      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

        Returns:
        the value

      • getSystemTags

        public Map<String,​Map<String,​Object>> getSystemTags()
        Usage of system tag keys.

        These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel