com.oracle.bmc.globallydistributeddatabase.model

Class CreateDedicatedShardedDatabase

java.lang.Object

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

com.oracle.bmc.globallydistributeddatabase.model.CreateShardedDatabaseDetails

com.oracle.bmc.globallydistributeddatabase.model.CreateDedicatedShardedDatabase

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

Request details for creation of ATP-Dedicated based sharded database.
Note: Objects should always be created or deserialized using the CreateDedicatedShardedDatabase.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 CreateDedicatedShardedDatabase.Builder, which maintain a set of all explicitly set fields called CreateDedicatedShardedDatabase.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 and Description
static class	CreateDedicatedShardedDatabase.Builder
static class	CreateDedicatedShardedDatabase.DbWorkload Possible workload types.
static class	CreateDedicatedShardedDatabase.ShardingMethod Sharding Method.

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

CreateShardedDatabaseDetails.DbDeploymentType

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 and Description

CreateDedicatedShardedDatabase(String compartmentId, String displayName, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, DedicatedShardedDatabase.ReplicationMethod replicationMethod, Integer replicationFactor, Integer replicationUnit, String clusterCertificateCommonName, Integer chunks, CreateDedicatedShardedDatabase.DbWorkload dbWorkload, CreateDedicatedShardedDatabase.ShardingMethod shardingMethod, String dbVersion, String characterSet, String ncharacterSet, Integer listenerPort, Integer listenerPortTls, Integer onsPortLocal, Integer onsPortRemote, String prefix, List<CreateDedicatedShardDetail> shardDetails, List<CreateDedicatedCatalogDetail> catalogDetails) Deprecated.

Method Summary

Modifier and Type	Method and Description
static CreateDedicatedShardedDatabase.Builder	builder() Create a new builder.
boolean	equals(Object o)
List<CreateDedicatedCatalogDetail>	getCatalogDetails() Collection of ATP-Dedicated catalogs that needs to be created.
String	getCharacterSet() The character set for the new shard database being created.
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.
String	getDbVersion() Oracle Database version of the Autonomous Container Database.
CreateDedicatedShardedDatabase.DbWorkload	getDbWorkload() Possible workload types.
Integer	getListenerPort() The listener port number for sharded database.
Integer	getListenerPortTls() The TLS listener port number for sharded database.
String	getNcharacterSet() The national character set for the new shard database being created.
Integer	getOnsPortLocal() Ons port local for sharded database.
Integer	getOnsPortRemote() Ons remote port for sharded database.
String	getPrefix() Unique name prefix for the sharded databases.
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<CreateDedicatedShardDetail>	getShardDetails() Collection of ATP-Dedicated shards that needs to be created.
CreateDedicatedShardedDatabase.ShardingMethod	getShardingMethod() Sharding Method.
int	hashCode()
CreateDedicatedShardedDatabase.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

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

getCompartmentId, getDefinedTags, getDisplayName, getFreeformTags

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

CreateDedicatedShardedDatabase

@Deprecated
public CreateDedicatedShardedDatabase(String compartmentId,
                                                  String displayName,
                                                  Map<String,String> freeformTags,
                                                  Map<String,Map<String,Object>> definedTags,
                                                  DedicatedShardedDatabase.ReplicationMethod replicationMethod,
                                                  Integer replicationFactor,
                                                  Integer replicationUnit,
                                                  String clusterCertificateCommonName,
                                                  Integer chunks,
                                                  CreateDedicatedShardedDatabase.DbWorkload dbWorkload,
                                                  CreateDedicatedShardedDatabase.ShardingMethod shardingMethod,
                                                  String dbVersion,
                                                  String characterSet,
                                                  String ncharacterSet,
                                                  Integer listenerPort,
                                                  Integer listenerPortTls,
                                                  Integer onsPortLocal,
                                                  Integer onsPortRemote,
                                                  String prefix,
                                                  List<CreateDedicatedShardDetail> shardDetails,
                                                  List<CreateDedicatedCatalogDetail> catalogDetails)

Deprecated.

Method Detail

builder

public static CreateDedicatedShardedDatabase.Builder builder()

Create a new builder.

toBuilder

public CreateDedicatedShardedDatabase.Builder toBuilder()

getReplicationMethod

public DedicatedShardedDatabase.ReplicationMethod getReplicationMethod()

The Replication method for sharded database.

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

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 CreateDedicatedShardedDatabase.DbWorkload getDbWorkload()

Possible workload types.

Returns:

the value

getShardingMethod

public CreateDedicatedShardedDatabase.ShardingMethod getShardingMethod()

Sharding Method.

Returns:

the value

getDbVersion

public String getDbVersion()

Oracle Database version of the Autonomous Container Database.

Returns:

the value

getCharacterSet

public String getCharacterSet()

The character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets

Returns:

the value

getNcharacterSet

public String getNcharacterSet()

The national character set for the new shard database being created. Use database api ListAutonomousDatabaseCharacterSets to get the list of allowed national character set for autonomous dedicated database. See documentation: https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ListAutonomousDatabaseCharacterSets

Returns:

the value

getListenerPort

public Integer getListenerPort()

The listener port number for sharded database.

Returns:

the value

getListenerPortTls

public Integer getListenerPortTls()

The TLS listener port number for sharded database.

Returns:

the value

getOnsPortLocal

public Integer getOnsPortLocal()

Ons port local for sharded database.

Returns:

the value

getOnsPortRemote

public Integer getOnsPortRemote()

Ons remote port for sharded database.

Returns:

the value

getPrefix

public String getPrefix()

Unique name prefix for the sharded 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

getShardDetails

public List<CreateDedicatedShardDetail> getShardDetails()

Collection of ATP-Dedicated shards that needs to be created.

Returns:

the value

getCatalogDetails

public List<CreateDedicatedCatalogDetail> getCatalogDetails()

Collection of ATP-Dedicated catalogs that needs to be created.

Returns:

the value

toString

public String toString()

Overrides:

toString in class CreateShardedDatabaseDetails

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class CreateShardedDatabaseDetails

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class CreateShardedDatabaseDetails

hashCode

public int hashCode()

Overrides:

hashCode in class CreateShardedDatabaseDetails