Package com.oracle.bmc.distributeddatabasev26.model

Class DistributedDatabase

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20260101")
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

      • getReplicationMethod

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

        Use RAFT for Raft based replication. With RAFT replication, shards cannot have peers details set on them. In case shards need to have peers, please do not set RAFT replicationMethod. For all non RAFT replication cases (with or without peers), please set replicationMethod as DG or do not set any value for replicationMethod.

        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

      • getNotificationTopicIds

        public List<String> getNotificationTopicIds()
        The collection of OCID for the notification topics associated with the globally distributed 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

      • 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

      • getScanListenerPort

        public Integer getScanListenerPort()
        The TCP SCAN listener port for database clusters with source type XS_NEW_VAULT_AND_CLUSTER or XS_NEW_CLUSTER.
        Returns:
        the value

      • getSystemChunkCount

        public Integer getSystemChunkCount()
        Count of chunks associated with system raft clusters or system data guard databases.
        Returns:
        the value

      • getSystemRaftReplicationUnitCount

        public Integer getSystemRaftReplicationUnitCount()
        Number of replication units associated with system raft clusters.
        Returns:
        the value

      • getCompositeRaftShardSpaces

        public List<CompositeRaftShardSpace> getCompositeRaftShardSpaces()
        Collection of composite raft shards.
        Returns:
        the value

      • getCompositeDataGuardShardSpaces

        public List<CompositeDataGuardShardSpace> getCompositeDataGuardShardSpaces()
        Collection of composite data guard shard spaces.
        Returns:
        the value

      • getSystemRaftClusters

        public List<SystemRaftCluster> getSystemRaftClusters()
        Collection of system raft clusters.
        Returns:
        the value

      • getUserShardSpaces

        public List<UserShardSpace> getUserShardSpaces()
        Collection of user defined shard spaces.
        Returns:
        the value

      • getCatalogDetails

        public List<DistributedDatabaseCatalog> getCatalogDetails()
        Catalog details associated with the distributed database.
        Returns:
        the value

      • getGsmDetails

        public List<DistributedDatabaseGsm> getGsmDetails()
        Global Service Manager (GSM) instances associated with the distributed database.
        Returns:
        the value

      • getGdsControlNodeDetails

        public List<DistributedDatabaseGdsControlNode> getGdsControlNodeDetails()
        Global Database Services Control(GDS CTL) instances associated with the distributed database.
        Returns:
        the value

      • getGsmSshPublicKey

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

      • getVcnNsgIds

        public List<VcnNsgIdsDetails> getVcnNsgIds()
        The list of network security group (NSG) details associated with the distributed database.
        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