DistributedAutonomousDatabaseSummary¶

class oci.distributed_database_v26.models.DistributedAutonomousDatabaseSummary(**kwargs)¶

Bases: object

Globally distributed autonomous database.

Attributes

`DB_DEPLOYMENT_TYPE_ADB_D`	A constant which can be used with the db_deployment_type property of a DistributedAutonomousDatabaseSummary.
`REPLICATION_METHOD_DG`	A constant which can be used with the replication_method property of a DistributedAutonomousDatabaseSummary.
`REPLICATION_METHOD_RAFT`	A constant which can be used with the replication_method property of a DistributedAutonomousDatabaseSummary.
`SHARDING_METHOD_COMPOSITE`	A constant which can be used with the sharding_method property of a DistributedAutonomousDatabaseSummary.
`SHARDING_METHOD_SYSTEM`	A constant which can be used with the sharding_method property of a DistributedAutonomousDatabaseSummary.
`SHARDING_METHOD_USER`	A constant which can be used with the sharding_method property of a DistributedAutonomousDatabaseSummary.
`auto_resource_management_config`	Gets the auto_resource_management_config of this DistributedAutonomousDatabaseSummary.
`character_set`	[Required] Gets the character_set of this DistributedAutonomousDatabaseSummary.
`compartment_id`	[Required] Gets the compartment_id of this DistributedAutonomousDatabaseSummary.
`database_version`	[Required] Gets the database_version of this DistributedAutonomousDatabaseSummary.
`db_deployment_type`	[Required] Gets the db_deployment_type of this DistributedAutonomousDatabaseSummary.
`db_workload_type`	[Required] Gets the db_workload_type of this DistributedAutonomousDatabaseSummary.
`defined_tags`	Gets the defined_tags of this DistributedAutonomousDatabaseSummary.
`display_name`	[Required] Gets the display_name of this DistributedAutonomousDatabaseSummary.
`freeform_tags`	Gets the freeform_tags of this DistributedAutonomousDatabaseSummary.
`id`	[Required] Gets the id of this DistributedAutonomousDatabaseSummary.
`lifecycle_details`	[Required] Gets the lifecycle_details of this DistributedAutonomousDatabaseSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this DistributedAutonomousDatabaseSummary.
`listener_port`	[Required] Gets the listener_port of this DistributedAutonomousDatabaseSummary.
`listener_port_tls`	Gets the listener_port_tls of this DistributedAutonomousDatabaseSummary.
`metadata`	Gets the metadata of this DistributedAutonomousDatabaseSummary.
`ncharacter_set`	[Required] Gets the ncharacter_set of this DistributedAutonomousDatabaseSummary.
`notification_topic_ids`	Gets the notification_topic_ids of this DistributedAutonomousDatabaseSummary.
`ons_port_local`	[Required] Gets the ons_port_local of this DistributedAutonomousDatabaseSummary.
`ons_port_remote`	[Required] Gets the ons_port_remote of this DistributedAutonomousDatabaseSummary.
`prefix`	[Required] Gets the prefix of this DistributedAutonomousDatabaseSummary.
`private_endpoint_ids`	[Required] Gets the private_endpoint_ids of this DistributedAutonomousDatabaseSummary.
`replication_method`	Gets the replication_method of this DistributedAutonomousDatabaseSummary.
`sharding_method`	[Required] Gets the sharding_method of this DistributedAutonomousDatabaseSummary.
`system_chunk_count`	Gets the system_chunk_count of this DistributedAutonomousDatabaseSummary.
`system_raft_replication_unit_count`	Gets the system_raft_replication_unit_count of this DistributedAutonomousDatabaseSummary.
`system_tags`	Gets the system_tags of this DistributedAutonomousDatabaseSummary.
`time_created`	[Required] Gets the time_created of this DistributedAutonomousDatabaseSummary.
`time_updated`	[Required] Gets the time_updated of this DistributedAutonomousDatabaseSummary.

Methods

__init__(**kwargs) Initializes a new DistributedAutonomousDatabaseSummary object with values from keyword arguments.

DB_DEPLOYMENT_TYPE_ADB_D = 'ADB_D'¶: A constant which can be used with the db_deployment_type property of a DistributedAutonomousDatabaseSummary. This constant has a value of “ADB_D”

REPLICATION_METHOD_DG = 'DG'¶: A constant which can be used with the replication_method property of a DistributedAutonomousDatabaseSummary. This constant has a value of “DG”

REPLICATION_METHOD_RAFT = 'RAFT'¶: A constant which can be used with the replication_method property of a DistributedAutonomousDatabaseSummary. This constant has a value of “RAFT”

SHARDING_METHOD_COMPOSITE = 'COMPOSITE'¶: A constant which can be used with the sharding_method property of a DistributedAutonomousDatabaseSummary. This constant has a value of “COMPOSITE”

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

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

__init__(**kwargs)¶

Initializes a new DistributedAutonomousDatabaseSummary object with values from keyword arguments. 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 DistributedAutonomousDatabaseSummary.
compartment_id (str) – The value to assign to the compartment_id property of this DistributedAutonomousDatabaseSummary.
display_name (str) – The value to assign to the display_name property of this DistributedAutonomousDatabaseSummary.
time_created (datetime) – The value to assign to the time_created property of this DistributedAutonomousDatabaseSummary.
time_updated (datetime) – The value to assign to the time_updated property of this DistributedAutonomousDatabaseSummary.
database_version (str) – The value to assign to the database_version property of this DistributedAutonomousDatabaseSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DistributedAutonomousDatabaseSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this DistributedAutonomousDatabaseSummary.
prefix (str) – The value to assign to the prefix property of this DistributedAutonomousDatabaseSummary.
private_endpoint_ids (list[str]) – The value to assign to the private_endpoint_ids property of this DistributedAutonomousDatabaseSummary.
notification_topic_ids (list[str]) – The value to assign to the notification_topic_ids property of this DistributedAutonomousDatabaseSummary.
db_workload_type (str) – The value to assign to the db_workload_type property of this DistributedAutonomousDatabaseSummary.
character_set (str) – The value to assign to the character_set property of this DistributedAutonomousDatabaseSummary.
ncharacter_set (str) – The value to assign to the ncharacter_set property of this DistributedAutonomousDatabaseSummary.
listener_port (int) – The value to assign to the listener_port property of this DistributedAutonomousDatabaseSummary.
listener_port_tls (int) – The value to assign to the listener_port_tls property of this DistributedAutonomousDatabaseSummary.
ons_port_local (int) – The value to assign to the ons_port_local property of this DistributedAutonomousDatabaseSummary.
ons_port_remote (int) – The value to assign to the ons_port_remote property of this DistributedAutonomousDatabaseSummary.
system_chunk_count (int) – The value to assign to the system_chunk_count property of this DistributedAutonomousDatabaseSummary.
auto_resource_management_config (oci.distributed_database_v26.models.AutoResourceManagementConfigurationDetails) – The value to assign to the auto_resource_management_config property of this DistributedAutonomousDatabaseSummary.
system_raft_replication_unit_count (int) – The value to assign to the system_raft_replication_unit_count property of this DistributedAutonomousDatabaseSummary.
metadata (oci.distributed_database_v26.models.DistributedAutonomousDbMetadata) – The value to assign to the metadata property of this DistributedAutonomousDatabaseSummary.
sharding_method (str) – The value to assign to the sharding_method property of this DistributedAutonomousDatabaseSummary. Allowed values for this property are: “USER”, “SYSTEM”, “COMPOSITE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
replication_method (str) – The value to assign to the replication_method property of this DistributedAutonomousDatabaseSummary. Allowed values for this property are: “RAFT”, “DG”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
db_deployment_type (str) – The value to assign to the db_deployment_type property of this DistributedAutonomousDatabaseSummary. Allowed values for this property are: “ADB_D”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DistributedAutonomousDatabaseSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DistributedAutonomousDatabaseSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DistributedAutonomousDatabaseSummary.

auto_resource_management_config¶

Gets the auto_resource_management_config of this DistributedAutonomousDatabaseSummary.

Returns:	The auto_resource_management_config of this DistributedAutonomousDatabaseSummary.
Return type:	oci.distributed_database_v26.models.AutoResourceManagementConfigurationDetails

character_set¶

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

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

compartment_id¶

[Required] Gets the compartment_id of this DistributedAutonomousDatabaseSummary. The OCID of the Globally distributed autonomous database compartment.

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

database_version¶

[Required] Gets the database_version of this DistributedAutonomousDatabaseSummary. Oracle Database version for the shards and catalog used in Globally distributed autonomous database.

Returns:	The database_version of this DistributedAutonomousDatabaseSummary.
Return type:	str

db_deployment_type¶

[Required] Gets the db_deployment_type of this DistributedAutonomousDatabaseSummary. The distributed autonomous database deployment type.

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

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

db_workload_type¶

[Required] Gets the db_workload_type of this DistributedAutonomousDatabaseSummary. The workload type for the database.

Returns:	The db_workload_type of this DistributedAutonomousDatabaseSummary.
Return type:	str

defined_tags¶

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

display_name¶

[Required] Gets the display_name of this DistributedAutonomousDatabaseSummary. The display name of the Globally distributed autonomous database.

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

freeform_tags¶

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

id¶

[Required] Gets the id of this DistributedAutonomousDatabaseSummary. The OCID of the Globally distributed autonomous database.

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

lifecycle_details¶

[Required] Gets the lifecycle_details of this DistributedAutonomousDatabaseSummary. The lifecycleDetails for the Globally distributed autonomous database.

Returns:	The lifecycle_details of this DistributedAutonomousDatabaseSummary.
Return type:	str

lifecycle_state¶

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

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

listener_port¶

[Required] Gets the listener_port of this DistributedAutonomousDatabaseSummary. The listener port number for the Globally distributed autonomous database.

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

listener_port_tls¶

Gets the listener_port_tls of this DistributedAutonomousDatabaseSummary. The TLS listener port number for the Globally distributed autonomous database.

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

metadata¶

Gets the metadata of this DistributedAutonomousDatabaseSummary.

Returns:	The metadata of this DistributedAutonomousDatabaseSummary.
Return type:	oci.distributed_database_v26.models.DistributedAutonomousDbMetadata

ncharacter_set¶

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

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

notification_topic_ids¶

Gets the notification_topic_ids of this DistributedAutonomousDatabaseSummary. The collection of OCID for the notification topics associated with the globally distributed autonomous database.

Returns:	The notification_topic_ids of this DistributedAutonomousDatabaseSummary.
Return type:	list[str]

ons_port_local¶

[Required] Gets the ons_port_local of this DistributedAutonomousDatabaseSummary. Ons local port number for the Globally distributed autonomous database.

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

ons_port_remote¶

[Required] Gets the ons_port_remote of this DistributedAutonomousDatabaseSummary. Ons remote port number for the Globally distributed autonomous database.

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

prefix¶

[Required] Gets the prefix of this DistributedAutonomousDatabaseSummary. Unique name prefix for the Globally distributed autonomous databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number.

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

private_endpoint_ids¶

[Required] Gets the private_endpoint_ids of this DistributedAutonomousDatabaseSummary. The collection of OCID of the private endpoint associated with Globally distributed autonomous database.

Returns:	The private_endpoint_ids of this DistributedAutonomousDatabaseSummary.
Return type:	list[str]

replication_method¶

Gets the replication_method of this DistributedAutonomousDatabaseSummary. The Replication method for Globally distributed Autonomous 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.

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

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

sharding_method¶

[Required] Gets the sharding_method of this DistributedAutonomousDatabaseSummary. Sharding methods for the Globally distributed autonomous database.

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

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

system_chunk_count¶

Gets the system_chunk_count of this DistributedAutonomousDatabaseSummary. Count of chunks associated with system raft clusters or system data guard databases.

Returns:	The system_chunk_count of this DistributedAutonomousDatabaseSummary.
Return type:	int

system_raft_replication_unit_count¶

Gets the system_raft_replication_unit_count of this DistributedAutonomousDatabaseSummary. Number of replication units associated with system raft clusters.

Returns:	The system_raft_replication_unit_count of this DistributedAutonomousDatabaseSummary.
Return type:	int

system_tags¶

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

time_created¶

[Required] Gets the time_created of this DistributedAutonomousDatabaseSummary. The time the Globally distributed autonomous database was created. An RFC3339 formatted datetime string

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

time_updated¶

[Required] Gets the time_updated of this DistributedAutonomousDatabaseSummary. The time the Globally distributed autonomous database was last updated. An RFC3339 formatted datetime string

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