Package com.oracle.bmc.globallydistributeddatabase.model

Class DedicatedShardedDatabase

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.globallydistributeddatabase.model.ShardedDatabase

com.oracle.bmc.globallydistributeddatabase.model.DedicatedShardedDatabase

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20230301")
public final class DedicatedShardedDatabase
extends ShardedDatabase

Details of ATP-D based sharded database.
Note: Objects should always be created or deserialized using the DedicatedShardedDatabase.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 DedicatedShardedDatabase.Builder, which maintain a set of all explicitly set fields called DedicatedShardedDatabase.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).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DedicatedShardedDatabase.Builder
static class	DedicatedShardedDatabase.DbWorkload	Possible workload types.
static class	DedicatedShardedDatabase.ReplicationMethod	The Replication method for sharded database.
static class	DedicatedShardedDatabase.ShardingMethod	Sharding Method.

Nested classes/interfaces inherited from class com.oracle.bmc.globallydistributeddatabase.model.ShardedDatabase

ShardedDatabase.DbDeploymentType, ShardedDatabase.LifecycleState

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor

Description

DedicatedShardedDatabase(String id, String compartmentId, String displayName, Date timeCreated, Date timeUpdated, ShardedDatabase.LifecycleState lifecycleState, String lifecycleStateDetails, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags, DedicatedShardedDatabase.ReplicationMethod replicationMethod, Integer replicationFactor, Integer replicationUnit, String clusterCertificateCommonName, String characterSet, String ncharacterSet, Integer chunks, DedicatedShardedDatabase.DbWorkload dbWorkload, DedicatedShardedDatabase.ShardingMethod shardingMethod, String dbVersion, Integer listenerPort, Integer listenerPortTls, Integer onsPortLocal, Integer onsPortRemote, String prefix, String privateEndpoint, ConnectionString connectionStrings, String timeZone, List<GsmDetails> gsms, List<DedicatedShardDetails> shardDetails, List<DedicatedCatalogDetails> catalogDetails)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static DedicatedShardedDatabase.Builder	builder()	Create a new builder.
boolean	equals(Object o)
List<DedicatedCatalogDetails>	getCatalogDetails()	Details of ATP-D based catalogs.
String	getCharacterSet()	The character set for the database.
Integer	getChunks()	The default number of unique chunks in a shardspace.
String	getClusterCertificateCommonName()	The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology.
ConnectionString	getConnectionStrings()
String	getDbVersion()	Oracle Database version number.
DedicatedShardedDatabase.DbWorkload	getDbWorkload()	Possible workload types.
List<GsmDetails>	getGsms()	Details of GSM instances for the sharded database.
Integer	getListenerPort()	The GSM listener port number.
Integer	getListenerPortTls()	The TLS listener port number for sharded database.
String	getNcharacterSet()	The national character set for the database.
Integer	getOnsPortLocal()	Ons local port number.
Integer	getOnsPortRemote()	Ons remote port number.
String	getPrefix()	Unique prefix for the sharded database.
String	getPrivateEndpoint()	The OCID of private endpoint being used by the sharded database.
Integer	getReplicationFactor()	The Replication factor for RAFT replication based sharded database.
DedicatedShardedDatabase.ReplicationMethod	getReplicationMethod()	The Replication method for sharded database.
Integer	getReplicationUnit()	For RAFT replication based sharded database, the value should be atleast twice the number of shards.
List<DedicatedShardDetails>	getShardDetails()	Details of ATP-D based shards.
DedicatedShardedDatabase.ShardingMethod	getShardingMethod()	Sharding Method.
String	getTimeZone()	Timezone associated with the sharded database.
int	hashCode()
DedicatedShardedDatabase.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.globallydistributeddatabase.model.ShardedDatabase

getCompartmentId, getDefinedTags, getDisplayName, getFreeformTags, getId, getLifecycleState, getLifecycleStateDetails, getSystemTags, getTimeCreated, getTimeUpdated

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DedicatedShardedDatabase

@Deprecated
public DedicatedShardedDatabase(String id,
                                String compartmentId,
                                String displayName,
                                Date timeCreated,
                                Date timeUpdated,
                                ShardedDatabase.LifecycleState lifecycleState,
                                String lifecycleStateDetails,
                                Map<String,String> freeformTags,
                                Map<String,Map<String,Object>> definedTags,
                                Map<String,Map<String,Object>> systemTags,
                                DedicatedShardedDatabase.ReplicationMethod replicationMethod,
                                Integer replicationFactor,
                                Integer replicationUnit,
                                String clusterCertificateCommonName,
                                String characterSet,
                                String ncharacterSet,
                                Integer chunks,
                                DedicatedShardedDatabase.DbWorkload dbWorkload,
                                DedicatedShardedDatabase.ShardingMethod shardingMethod,
                                String dbVersion,
                                Integer listenerPort,
                                Integer listenerPortTls,
                                Integer onsPortLocal,
                                Integer onsPortRemote,
                                String prefix,
                                String privateEndpoint,
                                ConnectionString connectionStrings,
                                String timeZone,
                                List<GsmDetails> gsms,
                                List<DedicatedShardDetails> shardDetails,
                                List<DedicatedCatalogDetails> catalogDetails)

Deprecated.

Method Detail

builder

public static DedicatedShardedDatabase.Builder builder()

Create a new builder.

toBuilder

public DedicatedShardedDatabase.Builder toBuilder()

getReplicationMethod

public DedicatedShardedDatabase.ReplicationMethod getReplicationMethod()

The Replication method for sharded 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 sharded database.

Currently supported values are 3, 5 and 7.

Returns:

the value

getReplicationUnit

public Integer getReplicationUnit()

For RAFT replication based sharded database, the value should be atleast twice the number of shards.

Returns:

the value

getClusterCertificateCommonName

public String getClusterCertificateCommonName()

The certificate common name used in all cloudAutonomousVmClusters for the sharded database topology.

Eg. Production. All the clusters used in one sharded database topology shall have same CABundle setup. Valid characterset for clusterCertificateCommonName include uppercase or lowercase letters, numbers, hyphens, underscores, and period.

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

getDbWorkload

public DedicatedShardedDatabase.DbWorkload getDbWorkload()

Possible workload types.

Returns:

the value

getShardingMethod

public DedicatedShardedDatabase.ShardingMethod getShardingMethod()

Sharding Method.

Returns:

the value

getDbVersion

public String getDbVersion()

Oracle Database version number.

Returns:

the value

getListenerPort

public Integer getListenerPort()

The GSM listener port number.

Returns:

the value

getListenerPortTls

public Integer getListenerPortTls()

The TLS listener port number for sharded 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

getPrefix

public String getPrefix()

Unique prefix for the sharded database.

Returns:

the value

getPrivateEndpoint

public String getPrivateEndpoint()

The OCID of private endpoint being used by the sharded database.

Returns:

the value

getConnectionStrings

public ConnectionString getConnectionStrings()

getTimeZone

public String getTimeZone()

Timezone associated with the sharded database.

Returns:

the value

getGsms

public List<GsmDetails> getGsms()

Details of GSM instances for the sharded database.

Returns:

the value

getShardDetails

public List<DedicatedShardDetails> getShardDetails()

Details of ATP-D based shards.

Returns:

the value

getCatalogDetails

public List<DedicatedCatalogDetails> getCatalogDetails()

Details of ATP-D based catalogs.

Returns:

the value

toString

public String toString()

Overrides:

toString in class ShardedDatabase

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class ShardedDatabase

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class ShardedDatabase

hashCode

public int hashCode()

Overrides:

hashCode in class ShardedDatabase