Class CreateDistributedDatabaseDetails

Details required for creation of the Globally distributed database.

Inheritance

object

CreateDistributedDatabaseDetails

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DistributeddatabaseService.Models

Assembly: OCI.DotNetSDK.Distributeddatabase.dll

Syntax

public class CreateDistributedDatabaseDetails

Properties

CatalogDetails

Declaration

[Required(ErrorMessage = "CatalogDetails is required.")]
[JsonProperty(PropertyName = "catalogDetails")]
public List<CreateDistributedDatabaseCatalogDetails> CatalogDetails { get; set; }

Property Value

Type	Description
List<CreateDistributedDatabaseCatalogDetails>	Collection of catalog for the Globally distributed database.

Remarks

Required

CharacterSet

Declaration

[Required(ErrorMessage = "CharacterSet is required.")]
[JsonProperty(PropertyName = "characterSet")]
public string CharacterSet { get; set; }

Property Value

Type	Description
string	The character set for the database.

Remarks

Required

Chunks

Declaration

[JsonProperty(PropertyName = "chunks")]
public int? Chunks { get; set; }

Property Value

Type	Description
int?	Number of chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace. Chunks is required to be provided for distributed databases being created with SYSTEM shardingMethod. For USER shardingMethod, chunks should not be set in create payload.

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the Globally distributed database compartment.

Remarks

Required

DatabaseVersion

Declaration

[Required(ErrorMessage = "DatabaseVersion is required.")]
[JsonProperty(PropertyName = "databaseVersion")]
public string DatabaseVersion { get; set; }

Property Value

Type	Description
string	Oracle Database version for the shards and catalog used in Globally distributed database.

Remarks

Required

DbBackupConfig

Declaration

[JsonProperty(PropertyName = "dbBackupConfig")]
public DistributedDbBackupConfig DbBackupConfig { get; set; }

Property Value

Type	Description
DistributedDbBackupConfig

DbDeploymentType

Declaration

[Required(ErrorMessage = "DbDeploymentType is required.")]
[JsonProperty(PropertyName = "dbDeploymentType")]
[JsonConverter(typeof(StringEnumConverter))]
public CreateDistributedDatabaseDetails.DbDeploymentTypeEnum? DbDeploymentType { get; set; }

Property Value

Type	Description
CreateDistributedDatabaseDetails.DbDeploymentTypeEnum?	The distributed database deployment type.

Remarks

Required

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}

DisplayName

Declaration

[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	The display name of the Globally distributed database.

Remarks

Required

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

GsmSshPublicKey

Declaration

[JsonProperty(PropertyName = "gsmSshPublicKey")]
public string GsmSshPublicKey { get; set; }

Property Value

Type	Description
string	The SSH public key for Global service manager instances.

ListenerPort

Declaration

[Required(ErrorMessage = "ListenerPort is required.")]
[JsonProperty(PropertyName = "listenerPort")]
public int? ListenerPort { get; set; }

Property Value

Type	Description
int?	The listener port number for the Globally distributed database. The listener port number has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.

Remarks

Required

ListenerPortTls

Declaration

[JsonProperty(PropertyName = "listenerPortTls")]
public int? ListenerPortTls { get; set; }

Property Value

Type	Description
int?	The TLS listener port number for the Globally distributed database. The TLS listener port number has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database. For BASE_DB and EXADB_XS based distributed databases, tls is not supported hence the listenerPortTls is not needed to be provided in create payload.

NcharacterSet

Declaration

[Required(ErrorMessage = "NcharacterSet is required.")]
[JsonProperty(PropertyName = "ncharacterSet")]
public string NcharacterSet { get; set; }

Property Value

Type	Description
string	The national character set for the database.

Remarks

Required

OnsPortLocal

Declaration

[Required(ErrorMessage = "OnsPortLocal is required.")]
[JsonProperty(PropertyName = "onsPortLocal")]
public int? OnsPortLocal { get; set; }

Property Value

Type	Description
int?	The ons local port number for the Globally distributed database. The onsPortLocal has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.

Remarks

Required

OnsPortRemote

Declaration

[Required(ErrorMessage = "OnsPortRemote is required.")]
[JsonProperty(PropertyName = "onsPortRemote")]
public int? OnsPortRemote { get; set; }

Property Value

Type	Description
int?	The ons remote port number for the Globally distributed database. The onsPortRemote has to be unique for a customer tenancy across all distributed databases. Same port number should not be re-used for any other distributed database.

Remarks

Required

Prefix

Declaration

[Required(ErrorMessage = "Prefix is required.")]
[JsonProperty(PropertyName = "prefix")]
public string Prefix { get; set; }

Property Value

Type	Description
string	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.

Remarks

Required

PrivateEndpointIds

Declaration

[Required(ErrorMessage = "PrivateEndpointIds is required.")]
[JsonProperty(PropertyName = "privateEndpointIds")]
public List<string> PrivateEndpointIds { get; set; }

Property Value

Type	Description
List<string>	The collection of OCID of the private endpoint associated with Globally distributed autonomous database.

Remarks

Required

ReplicationFactor

Declaration

[JsonProperty(PropertyName = "replicationFactor")]
public int? ReplicationFactor { get; set; }

Property Value

Type	Description
int?	The Replication factor for RAFT replication based Globally distributed database. Currently supported values are 3, 5 and 7.

ReplicationMethod

Declaration

[JsonProperty(PropertyName = "replicationMethod")]
[JsonConverter(typeof(StringEnumConverter))]
public CreateDistributedDatabaseDetails.ReplicationMethodEnum? ReplicationMethod { get; set; }

Property Value

Type	Description
CreateDistributedDatabaseDetails.ReplicationMethodEnum?	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.

ReplicationUnit

Declaration

[JsonProperty(PropertyName = "replicationUnit")]
public int? ReplicationUnit { get; set; }

Property Value

Type	Description
int?	The replication unit count for RAFT based distributed database. For RAFT replication based Globally distributed database, the value should be at least twice the number of shards.

ShardDetails

Declaration

[Required(ErrorMessage = "ShardDetails is required.")]
[JsonProperty(PropertyName = "shardDetails")]
public List<CreateDistributedDatabaseShardDetails> ShardDetails { get; set; }

Property Value

Type	Description
List<CreateDistributedDatabaseShardDetails>	Collection of shards for the Globally distributed database.

Remarks

Required

ShardingMethod

Declaration

[Required(ErrorMessage = "ShardingMethod is required.")]
[JsonProperty(PropertyName = "shardingMethod")]
[JsonConverter(typeof(StringEnumConverter))]
public CreateDistributedDatabaseDetails.ShardingMethodEnum? ShardingMethod { get; set; }

Property Value

Type	Description
CreateDistributedDatabaseDetails.ShardingMethodEnum?	Sharding Methods for the Globally distributed database.

Remarks

Required