DedicatedShardedDatabaseSummary¶

class oci.globally_distributed_database.models.DedicatedShardedDatabaseSummary(**kwargs)¶

Bases: oci.globally_distributed_database.models.sharded_database_summary.ShardedDatabaseSummary

Summary of ATP-D based sharded database.

Attributes

`DB_DEPLOYMENT_TYPE_DEDICATED`	str(object=’’) -> str
`DB_WORKLOAD_DW`	A constant which can be used with the db_workload property of a DedicatedShardedDatabaseSummary.
`DB_WORKLOAD_OLTP`	A constant which can be used with the db_workload property of a DedicatedShardedDatabaseSummary.
`SHARDING_METHOD_SYSTEM`	A constant which can be used with the sharding_method property of a DedicatedShardedDatabaseSummary.
`SHARDING_METHOD_USER`	A constant which can be used with the sharding_method property of a DedicatedShardedDatabaseSummary.
`character_set`	[Required] Gets the character_set of this DedicatedShardedDatabaseSummary.
`chunks`	Gets the chunks of this DedicatedShardedDatabaseSummary.
`cluster_certificate_common_name`	Gets the cluster_certificate_common_name of this DedicatedShardedDatabaseSummary.
`compartment_id`	[Required] Gets the compartment_id of this ShardedDatabaseSummary.
`db_deployment_type`	[Required] Gets the db_deployment_type of this ShardedDatabaseSummary.
`db_version`	Gets the db_version of this DedicatedShardedDatabaseSummary.
`db_workload`	[Required] Gets the db_workload of this DedicatedShardedDatabaseSummary.
`defined_tags`	Gets the defined_tags of this ShardedDatabaseSummary.
`display_name`	[Required] Gets the display_name of this ShardedDatabaseSummary.
`freeform_tags`	Gets the freeform_tags of this ShardedDatabaseSummary.
`id`	[Required] Gets the id of this ShardedDatabaseSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ShardedDatabaseSummary.
`lifecycle_state_details`	[Required] Gets the lifecycle_state_details of this ShardedDatabaseSummary.
`listener_port`	Gets the listener_port of this DedicatedShardedDatabaseSummary.
`listener_port_tls`	Gets the listener_port_tls of this DedicatedShardedDatabaseSummary.
`ncharacter_set`	[Required] Gets the ncharacter_set of this DedicatedShardedDatabaseSummary.
`ons_port_local`	Gets the ons_port_local of this DedicatedShardedDatabaseSummary.
`ons_port_remote`	Gets the ons_port_remote of this DedicatedShardedDatabaseSummary.
`prefix`	Gets the prefix of this DedicatedShardedDatabaseSummary.
`replication_factor`	Gets the replication_factor of this DedicatedShardedDatabaseSummary.
`replication_method`	Gets the replication_method of this DedicatedShardedDatabaseSummary.
`replication_unit`	Gets the replication_unit of this DedicatedShardedDatabaseSummary.
`sharding_method`	[Required] Gets the sharding_method of this DedicatedShardedDatabaseSummary.
`system_tags`	Gets the system_tags of this ShardedDatabaseSummary.
`time_created`	[Required] Gets the time_created of this ShardedDatabaseSummary.
`time_updated`	[Required] Gets the time_updated of this ShardedDatabaseSummary.
`total_cpu_count`	Gets the total_cpu_count of this DedicatedShardedDatabaseSummary.
`total_data_storage_size_in_gbs`	Gets the total_data_storage_size_in_gbs of this DedicatedShardedDatabaseSummary.

Methods

`__init__`(**kwargs)	Initializes a new DedicatedShardedDatabaseSummary object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

DB_DEPLOYMENT_TYPE_DEDICATED = 'DEDICATED'¶

DB_WORKLOAD_DW = 'DW'¶: A constant which can be used with the db_workload property of a DedicatedShardedDatabaseSummary. This constant has a value of “DW”

DB_WORKLOAD_OLTP = 'OLTP'¶: A constant which can be used with the db_workload property of a DedicatedShardedDatabaseSummary. This constant has a value of “OLTP”

SHARDING_METHOD_SYSTEM = 'SYSTEM'¶: A constant which can be used with the sharding_method property of a DedicatedShardedDatabaseSummary. This constant has a value of “SYSTEM”

SHARDING_METHOD_USER = 'USER'¶: A constant which can be used with the sharding_method property of a DedicatedShardedDatabaseSummary. This constant has a value of “USER”

__init__(**kwargs)¶

Initializes a new DedicatedShardedDatabaseSummary object with values from keyword arguments. The default value of the db_deployment_type attribute of this class is DEDICATED and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this DedicatedShardedDatabaseSummary.
compartment_id (str) – The value to assign to the compartment_id property of this DedicatedShardedDatabaseSummary.
db_deployment_type (str) – The value to assign to the db_deployment_type property of this DedicatedShardedDatabaseSummary. Allowed values for this property are: “DEDICATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
display_name (str) – The value to assign to the display_name property of this DedicatedShardedDatabaseSummary.
time_created (datetime) – The value to assign to the time_created property of this DedicatedShardedDatabaseSummary.
time_updated (datetime) – The value to assign to the time_updated property of this DedicatedShardedDatabaseSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DedicatedShardedDatabaseSummary.
lifecycle_state_details (str) – The value to assign to the lifecycle_state_details property of this DedicatedShardedDatabaseSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DedicatedShardedDatabaseSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DedicatedShardedDatabaseSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DedicatedShardedDatabaseSummary.
replication_method (str) – The value to assign to the replication_method property of this DedicatedShardedDatabaseSummary.
replication_factor (int) – The value to assign to the replication_factor property of this DedicatedShardedDatabaseSummary.
replication_unit (int) – The value to assign to the replication_unit property of this DedicatedShardedDatabaseSummary.
cluster_certificate_common_name (str) – The value to assign to the cluster_certificate_common_name property of this DedicatedShardedDatabaseSummary.
db_workload (str) – The value to assign to the db_workload property of this DedicatedShardedDatabaseSummary. Allowed values for this property are: “OLTP”, “DW”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
sharding_method (str) – The value to assign to the sharding_method property of this DedicatedShardedDatabaseSummary. Allowed values for this property are: “USER”, “SYSTEM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
character_set (str) – The value to assign to the character_set property of this DedicatedShardedDatabaseSummary.
ncharacter_set (str) – The value to assign to the ncharacter_set property of this DedicatedShardedDatabaseSummary.
chunks (int) – The value to assign to the chunks property of this DedicatedShardedDatabaseSummary.
db_version (str) – The value to assign to the db_version property of this DedicatedShardedDatabaseSummary.
listener_port (int) – The value to assign to the listener_port property of this DedicatedShardedDatabaseSummary.
listener_port_tls (int) – The value to assign to the listener_port_tls property of this DedicatedShardedDatabaseSummary.
ons_port_local (int) – The value to assign to the ons_port_local property of this DedicatedShardedDatabaseSummary.
ons_port_remote (int) – The value to assign to the ons_port_remote property of this DedicatedShardedDatabaseSummary.
prefix (str) – The value to assign to the prefix property of this DedicatedShardedDatabaseSummary.
total_cpu_count (int) – The value to assign to the total_cpu_count property of this DedicatedShardedDatabaseSummary.
total_data_storage_size_in_gbs (float) – The value to assign to the total_data_storage_size_in_gbs property of this DedicatedShardedDatabaseSummary.

character_set¶

[Required] Gets the character_set of this DedicatedShardedDatabaseSummary. The character set for the sharded database.

Returns:	The character_set of this DedicatedShardedDatabaseSummary.
Return type:	str

chunks¶

Gets the chunks of this DedicatedShardedDatabaseSummary. 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 chunks of this DedicatedShardedDatabaseSummary.
Return type:	int

cluster_certificate_common_name¶

Gets the cluster_certificate_common_name of this DedicatedShardedDatabaseSummary. 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 cluster_certificate_common_name of this DedicatedShardedDatabaseSummary.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this ShardedDatabaseSummary. Identifier of the compartment where sharded database exists.

Returns:	The compartment_id of this ShardedDatabaseSummary.
Return type:	str

db_deployment_type¶

[Required] Gets the db_deployment_type of this ShardedDatabaseSummary. The database deployment type.

Allowed values for this property are: “DEDICATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The db_deployment_type of this ShardedDatabaseSummary.
Return type:	str

db_version¶

Gets the db_version of this DedicatedShardedDatabaseSummary. Oracle Database version of the Autonomous Container Database.

Returns:	The db_version of this DedicatedShardedDatabaseSummary.
Return type:	str

db_workload¶

[Required] Gets the db_workload of this DedicatedShardedDatabaseSummary. Possible workload types.

Allowed values for this property are: “OLTP”, “DW”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The db_workload of this DedicatedShardedDatabaseSummary.
Return type:	str

defined_tags¶

Gets the defined_tags of this ShardedDatabaseSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this ShardedDatabaseSummary.
Return type:	dict(str, dict(str, object))

display_name¶

[Required] Gets the display_name of this ShardedDatabaseSummary. Oracle sharded database display name.

Returns:	The display_name of this ShardedDatabaseSummary.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this ShardedDatabaseSummary. 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 freeform_tags of this ShardedDatabaseSummary.
Return type:	dict(str, str)

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

id¶

[Required] Gets the id of this ShardedDatabaseSummary. Sharded Database identifier

Returns:	The id of this ShardedDatabaseSummary.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this ShardedDatabaseSummary. Lifecycle state of sharded database.

Returns:	The lifecycle_state of this ShardedDatabaseSummary.
Return type:	str

lifecycle_state_details¶

[Required] Gets the lifecycle_state_details of this ShardedDatabaseSummary. Detailed message for the lifecycle state.

Returns:	The lifecycle_state_details of this ShardedDatabaseSummary.
Return type:	str

listener_port¶

Gets the listener_port of this DedicatedShardedDatabaseSummary. The listener port number for the sharded database.

Returns:	The listener_port of this DedicatedShardedDatabaseSummary.
Return type:	int

listener_port_tls¶

Gets the listener_port_tls of this DedicatedShardedDatabaseSummary. The TLS listener port number for sharded database.

Returns:	The listener_port_tls of this DedicatedShardedDatabaseSummary.
Return type:	int

ncharacter_set¶

[Required] Gets the ncharacter_set of this DedicatedShardedDatabaseSummary. The national character set for the sharded database.

Returns:	The ncharacter_set of this DedicatedShardedDatabaseSummary.
Return type:	str

ons_port_local¶

Gets the ons_port_local of this DedicatedShardedDatabaseSummary. Ons local port number.

Returns:	The ons_port_local of this DedicatedShardedDatabaseSummary.
Return type:	int

ons_port_remote¶

Gets the ons_port_remote of this DedicatedShardedDatabaseSummary. Ons remote port number.

Returns:	The ons_port_remote of this DedicatedShardedDatabaseSummary.
Return type:	int

prefix¶

Gets the prefix of this DedicatedShardedDatabaseSummary. Name prefix for the sharded databases.

Returns:	The prefix of this DedicatedShardedDatabaseSummary.
Return type:	str

replication_factor¶

Gets the replication_factor of this DedicatedShardedDatabaseSummary. The Replication factor for RAFT replication based sharded database. Currently supported values are 3, 5 and 7.

Returns:	The replication_factor of this DedicatedShardedDatabaseSummary.
Return type:	int

replication_method¶

Gets the replication_method of this DedicatedShardedDatabaseSummary. The Replication method for sharded database.

Returns:	The replication_method of this DedicatedShardedDatabaseSummary.
Return type:	str

replication_unit¶

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

Returns:	The replication_unit of this DedicatedShardedDatabaseSummary.
Return type:	int

sharding_method¶

[Required] Gets the sharding_method of this DedicatedShardedDatabaseSummary. Sharding Method.

Allowed values for this property are: “USER”, “SYSTEM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The sharding_method of this DedicatedShardedDatabaseSummary.
Return type:	str

system_tags¶

Gets the system_tags of this ShardedDatabaseSummary. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this ShardedDatabaseSummary.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this ShardedDatabaseSummary. The time the the Sharded Database was created. An RFC3339 formatted datetime string

Returns:	The time_created of this ShardedDatabaseSummary.
Return type:	datetime

time_updated¶

[Required] Gets the time_updated of this ShardedDatabaseSummary. The time the Sharded Database was last updated. An RFC3339 formatted datetime string

Returns:	The time_updated of this ShardedDatabaseSummary.
Return type:	datetime

total_cpu_count¶

Gets the total_cpu_count of this DedicatedShardedDatabaseSummary. Total cpu count usage for shards and catalogs of the sharded database.

Returns:	The total_cpu_count of this DedicatedShardedDatabaseSummary.
Return type:	int

total_data_storage_size_in_gbs¶

Gets the total_data_storage_size_in_gbs of this DedicatedShardedDatabaseSummary. The aggregarted value of dataStorageSizeInGbs for all shards and catalogs.

Returns:	The total_data_storage_size_in_gbs of this DedicatedShardedDatabaseSummary.
Return type:	float