ShardedDatabase¶

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

Bases: object

Sharded Database resource.

Attributes

`DB_DEPLOYMENT_TYPE_DEDICATED`	A constant which can be used with the db_deployment_type property of a ShardedDatabase.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a ShardedDatabase.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a ShardedDatabase.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a ShardedDatabase.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a ShardedDatabase.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a ShardedDatabase.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a ShardedDatabase.
`LIFECYCLE_STATE_NEEDS_ATTENTION`	A constant which can be used with the lifecycle_state property of a ShardedDatabase.
`LIFECYCLE_STATE_UNAVAILABLE`	A constant which can be used with the lifecycle_state property of a ShardedDatabase.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a ShardedDatabase.
`compartment_id`	[Required] Gets the compartment_id of this ShardedDatabase.
`db_deployment_type`	[Required] Gets the db_deployment_type of this ShardedDatabase.
`defined_tags`	Gets the defined_tags of this ShardedDatabase.
`display_name`	[Required] Gets the display_name of this ShardedDatabase.
`freeform_tags`	Gets the freeform_tags of this ShardedDatabase.
`id`	[Required] Gets the id of this ShardedDatabase.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ShardedDatabase.
`lifecycle_state_details`	[Required] Gets the lifecycle_state_details of this ShardedDatabase.
`system_tags`	Gets the system_tags of this ShardedDatabase.
`time_created`	[Required] Gets the time_created of this ShardedDatabase.
`time_updated`	[Required] Gets the time_updated of this ShardedDatabase.

Methods

`__init__`(**kwargs)	Initializes a new ShardedDatabase 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'¶: A constant which can be used with the db_deployment_type property of a ShardedDatabase. This constant has a value of “DEDICATED”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a ShardedDatabase. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a ShardedDatabase. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a ShardedDatabase. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a ShardedDatabase. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a ShardedDatabase. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a ShardedDatabase. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶: A constant which can be used with the lifecycle_state property of a ShardedDatabase. This constant has a value of “NEEDS_ATTENTION”

LIFECYCLE_STATE_UNAVAILABLE = 'UNAVAILABLE'¶: A constant which can be used with the lifecycle_state property of a ShardedDatabase. This constant has a value of “UNAVAILABLE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a ShardedDatabase. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new ShardedDatabase object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

DedicatedShardedDatabase

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 ShardedDatabase.
compartment_id (str) – The value to assign to the compartment_id property of this ShardedDatabase.
db_deployment_type (str) – The value to assign to the db_deployment_type property of this ShardedDatabase. 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 ShardedDatabase.
time_created (datetime) – The value to assign to the time_created property of this ShardedDatabase.
time_updated (datetime) – The value to assign to the time_updated property of this ShardedDatabase.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ShardedDatabase. Allowed values for this property are: “ACTIVE”, “FAILED”, “NEEDS_ATTENTION”, “INACTIVE”, “DELETING”, “DELETED”, “UPDATING”, “CREATING”, “UNAVAILABLE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_state_details (str) – The value to assign to the lifecycle_state_details property of this ShardedDatabase.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ShardedDatabase.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ShardedDatabase.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ShardedDatabase.

compartment_id¶

[Required] Gets the compartment_id of this ShardedDatabase. Identifier of the compartment in which sharded database exists.

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

db_deployment_type¶

[Required] Gets the db_deployment_type of this ShardedDatabase. 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 ShardedDatabase.
Return type:	str

defined_tags¶

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

display_name¶

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

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

freeform_tags¶

Gets the freeform_tags of this ShardedDatabase. 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 ShardedDatabase.
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 ShardedDatabase. Sharded Database identifier

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this ShardedDatabase. Lifecycle states for sharded databases.

Allowed values for this property are: “ACTIVE”, “FAILED”, “NEEDS_ATTENTION”, “INACTIVE”, “DELETING”, “DELETED”, “UPDATING”, “CREATING”, “UNAVAILABLE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

lifecycle_state_details¶

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

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

system_tags¶

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

time_created¶

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

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

time_updated¶

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

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