PluggableDatabaseSummary¶
-
class
oci.database.models.
PluggableDatabaseSummary
(**kwargs)¶ Bases:
object
A pluggable database (PDB) is portable collection of schemas, schema objects, and non-schema objects that appears to an Oracle client as a non-container database. To use a PDB, it needs to be plugged into a CDB. To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to a tenancy administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
Attributes
LIFECYCLE_STATE_AVAILABLE
A constant which can be used with the lifecycle_state property of a PluggableDatabaseSummary. LIFECYCLE_STATE_BACKUP_IN_PROGRESS
A constant which can be used with the lifecycle_state property of a PluggableDatabaseSummary. LIFECYCLE_STATE_DISABLED
A constant which can be used with the lifecycle_state property of a PluggableDatabaseSummary. LIFECYCLE_STATE_FAILED
A constant which can be used with the lifecycle_state property of a PluggableDatabaseSummary. LIFECYCLE_STATE_PROVISIONING
A constant which can be used with the lifecycle_state property of a PluggableDatabaseSummary. LIFECYCLE_STATE_REFRESHING
A constant which can be used with the lifecycle_state property of a PluggableDatabaseSummary. LIFECYCLE_STATE_RELOCATED
A constant which can be used with the lifecycle_state property of a PluggableDatabaseSummary. LIFECYCLE_STATE_RELOCATING
A constant which can be used with the lifecycle_state property of a PluggableDatabaseSummary. LIFECYCLE_STATE_RESTORE_FAILED
A constant which can be used with the lifecycle_state property of a PluggableDatabaseSummary. LIFECYCLE_STATE_RESTORE_IN_PROGRESS
A constant which can be used with the lifecycle_state property of a PluggableDatabaseSummary. LIFECYCLE_STATE_TERMINATED
A constant which can be used with the lifecycle_state property of a PluggableDatabaseSummary. LIFECYCLE_STATE_TERMINATING
A constant which can be used with the lifecycle_state property of a PluggableDatabaseSummary. LIFECYCLE_STATE_UPDATING
A constant which can be used with the lifecycle_state property of a PluggableDatabaseSummary. OPEN_MODE_MIGRATE
A constant which can be used with the open_mode property of a PluggableDatabaseSummary. OPEN_MODE_MOUNTED
A constant which can be used with the open_mode property of a PluggableDatabaseSummary. OPEN_MODE_READ_ONLY
A constant which can be used with the open_mode property of a PluggableDatabaseSummary. OPEN_MODE_READ_WRITE
A constant which can be used with the open_mode property of a PluggableDatabaseSummary. compartment_id
[Required] Gets the compartment_id of this PluggableDatabaseSummary. connection_strings
Gets the connection_strings of this PluggableDatabaseSummary. container_database_id
[Required] Gets the container_database_id of this PluggableDatabaseSummary. defined_tags
Gets the defined_tags of this PluggableDatabaseSummary. freeform_tags
Gets the freeform_tags of this PluggableDatabaseSummary. id
[Required] Gets the id of this PluggableDatabaseSummary. is_restricted
Gets the is_restricted of this PluggableDatabaseSummary. lifecycle_details
Gets the lifecycle_details of this PluggableDatabaseSummary. lifecycle_state
[Required] Gets the lifecycle_state of this PluggableDatabaseSummary. open_mode
[Required] Gets the open_mode of this PluggableDatabaseSummary. pdb_name
[Required] Gets the pdb_name of this PluggableDatabaseSummary. pdb_node_level_details
Gets the pdb_node_level_details of this PluggableDatabaseSummary. pluggable_database_management_config
Gets the pluggable_database_management_config of this PluggableDatabaseSummary. refreshable_clone_config
Gets the refreshable_clone_config of this PluggableDatabaseSummary. time_created
[Required] Gets the time_created of this PluggableDatabaseSummary. Methods
__init__
(**kwargs)Initializes a new PluggableDatabaseSummary object with values from keyword arguments. -
LIFECYCLE_STATE_AVAILABLE
= 'AVAILABLE'¶ A constant which can be used with the lifecycle_state property of a PluggableDatabaseSummary. This constant has a value of “AVAILABLE”
-
LIFECYCLE_STATE_BACKUP_IN_PROGRESS
= 'BACKUP_IN_PROGRESS'¶ A constant which can be used with the lifecycle_state property of a PluggableDatabaseSummary. This constant has a value of “BACKUP_IN_PROGRESS”
-
LIFECYCLE_STATE_DISABLED
= 'DISABLED'¶ A constant which can be used with the lifecycle_state property of a PluggableDatabaseSummary. This constant has a value of “DISABLED”
-
LIFECYCLE_STATE_FAILED
= 'FAILED'¶ A constant which can be used with the lifecycle_state property of a PluggableDatabaseSummary. This constant has a value of “FAILED”
-
LIFECYCLE_STATE_PROVISIONING
= 'PROVISIONING'¶ A constant which can be used with the lifecycle_state property of a PluggableDatabaseSummary. This constant has a value of “PROVISIONING”
-
LIFECYCLE_STATE_REFRESHING
= 'REFRESHING'¶ A constant which can be used with the lifecycle_state property of a PluggableDatabaseSummary. This constant has a value of “REFRESHING”
-
LIFECYCLE_STATE_RELOCATED
= 'RELOCATED'¶ A constant which can be used with the lifecycle_state property of a PluggableDatabaseSummary. This constant has a value of “RELOCATED”
-
LIFECYCLE_STATE_RELOCATING
= 'RELOCATING'¶ A constant which can be used with the lifecycle_state property of a PluggableDatabaseSummary. This constant has a value of “RELOCATING”
-
LIFECYCLE_STATE_RESTORE_FAILED
= 'RESTORE_FAILED'¶ A constant which can be used with the lifecycle_state property of a PluggableDatabaseSummary. This constant has a value of “RESTORE_FAILED”
-
LIFECYCLE_STATE_RESTORE_IN_PROGRESS
= 'RESTORE_IN_PROGRESS'¶ A constant which can be used with the lifecycle_state property of a PluggableDatabaseSummary. This constant has a value of “RESTORE_IN_PROGRESS”
-
LIFECYCLE_STATE_TERMINATED
= 'TERMINATED'¶ A constant which can be used with the lifecycle_state property of a PluggableDatabaseSummary. This constant has a value of “TERMINATED”
-
LIFECYCLE_STATE_TERMINATING
= 'TERMINATING'¶ A constant which can be used with the lifecycle_state property of a PluggableDatabaseSummary. This constant has a value of “TERMINATING”
-
LIFECYCLE_STATE_UPDATING
= 'UPDATING'¶ A constant which can be used with the lifecycle_state property of a PluggableDatabaseSummary. This constant has a value of “UPDATING”
-
OPEN_MODE_MIGRATE
= 'MIGRATE'¶ A constant which can be used with the open_mode property of a PluggableDatabaseSummary. This constant has a value of “MIGRATE”
-
OPEN_MODE_MOUNTED
= 'MOUNTED'¶ A constant which can be used with the open_mode property of a PluggableDatabaseSummary. This constant has a value of “MOUNTED”
-
OPEN_MODE_READ_ONLY
= 'READ_ONLY'¶ A constant which can be used with the open_mode property of a PluggableDatabaseSummary. This constant has a value of “READ_ONLY”
-
OPEN_MODE_READ_WRITE
= 'READ_WRITE'¶ A constant which can be used with the open_mode property of a PluggableDatabaseSummary. This constant has a value of “READ_WRITE”
-
__init__
(**kwargs)¶ Initializes a new PluggableDatabaseSummary 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 PluggableDatabaseSummary.
- container_database_id (str) – The value to assign to the container_database_id property of this PluggableDatabaseSummary.
- pdb_name (str) – The value to assign to the pdb_name property of this PluggableDatabaseSummary.
- lifecycle_state (str) – The value to assign to the lifecycle_state property of this PluggableDatabaseSummary. Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”, “UPDATING”, “FAILED”, “RELOCATING”, “RELOCATED”, “REFRESHING”, “RESTORE_IN_PROGRESS”, “RESTORE_FAILED”, “BACKUP_IN_PROGRESS”, “DISABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- lifecycle_details (str) – The value to assign to the lifecycle_details property of this PluggableDatabaseSummary.
- time_created (datetime) – The value to assign to the time_created property of this PluggableDatabaseSummary.
- connection_strings (oci.database.models.PluggableDatabaseConnectionStrings) – The value to assign to the connection_strings property of this PluggableDatabaseSummary.
- open_mode (str) – The value to assign to the open_mode property of this PluggableDatabaseSummary. Allowed values for this property are: “READ_ONLY”, “READ_WRITE”, “MOUNTED”, “MIGRATE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- is_restricted (bool) – The value to assign to the is_restricted property of this PluggableDatabaseSummary.
- compartment_id (str) – The value to assign to the compartment_id property of this PluggableDatabaseSummary.
- freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this PluggableDatabaseSummary.
- defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this PluggableDatabaseSummary.
- pluggable_database_management_config (oci.database.models.PluggableDatabaseManagementConfig) – The value to assign to the pluggable_database_management_config property of this PluggableDatabaseSummary.
- refreshable_clone_config (oci.database.models.PluggableDatabaseRefreshableCloneConfig) – The value to assign to the refreshable_clone_config property of this PluggableDatabaseSummary.
- pdb_node_level_details (list[oci.database.models.PluggableDatabaseNodeLevelDetails]) – The value to assign to the pdb_node_level_details property of this PluggableDatabaseSummary.
-
compartment_id
¶ [Required] Gets the compartment_id of this PluggableDatabaseSummary. The OCID of the compartment.
Returns: The compartment_id of this PluggableDatabaseSummary. Return type: str
-
connection_strings
¶ Gets the connection_strings of this PluggableDatabaseSummary.
Returns: The connection_strings of this PluggableDatabaseSummary. Return type: oci.database.models.PluggableDatabaseConnectionStrings
-
container_database_id
¶ [Required] Gets the container_database_id of this PluggableDatabaseSummary. The OCID of the CDB.
Returns: The container_database_id of this PluggableDatabaseSummary. Return type: str
Gets the defined_tags of this PluggableDatabaseSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Returns: The defined_tags of this PluggableDatabaseSummary. Return type: dict(str, dict(str, object))
Gets the freeform_tags of this PluggableDatabaseSummary. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: {“Department”: “Finance”}
Returns: The freeform_tags of this PluggableDatabaseSummary. Return type: dict(str, str)
-
id
¶ [Required] Gets the id of this PluggableDatabaseSummary. The OCID of the pluggable database.
Returns: The id of this PluggableDatabaseSummary. Return type: str
-
is_restricted
¶ Gets the is_restricted of this PluggableDatabaseSummary. The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it.
Returns: The is_restricted of this PluggableDatabaseSummary. Return type: bool
-
lifecycle_details
¶ Gets the lifecycle_details of this PluggableDatabaseSummary. Detailed message for the lifecycle state.
Returns: The lifecycle_details of this PluggableDatabaseSummary. Return type: str
-
lifecycle_state
¶ [Required] Gets the lifecycle_state of this PluggableDatabaseSummary. The current state of the pluggable database.
Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”, “UPDATING”, “FAILED”, “RELOCATING”, “RELOCATED”, “REFRESHING”, “RESTORE_IN_PROGRESS”, “RESTORE_FAILED”, “BACKUP_IN_PROGRESS”, “DISABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
Returns: The lifecycle_state of this PluggableDatabaseSummary. Return type: str
-
open_mode
¶ [Required] Gets the open_mode of this PluggableDatabaseSummary. Deprecated. Use
pluggable_database_node_level_details()
for OpenMode details. The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software).Allowed values for this property are: “READ_ONLY”, “READ_WRITE”, “MOUNTED”, “MIGRATE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
Returns: The open_mode of this PluggableDatabaseSummary. Return type: str
-
pdb_name
¶ [Required] Gets the pdb_name of this PluggableDatabaseSummary. The name for the pluggable database (PDB). The name is unique in the context of a
Database
. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name.Returns: The pdb_name of this PluggableDatabaseSummary. Return type: str
-
pdb_node_level_details
¶ Gets the pdb_node_level_details of this PluggableDatabaseSummary. Pluggable Database Node Level Details. Example: [{“nodeName” : “node1”, “openMode” : “READ_WRITE”}, {“nodeName” : “node2”, “openMode” : “READ_ONLY”}]
Returns: The pdb_node_level_details of this PluggableDatabaseSummary. Return type: list[oci.database.models.PluggableDatabaseNodeLevelDetails]
-
pluggable_database_management_config
¶ Gets the pluggable_database_management_config of this PluggableDatabaseSummary.
Returns: The pluggable_database_management_config of this PluggableDatabaseSummary. Return type: oci.database.models.PluggableDatabaseManagementConfig
-
refreshable_clone_config
¶ Gets the refreshable_clone_config of this PluggableDatabaseSummary.
Returns: The refreshable_clone_config of this PluggableDatabaseSummary. Return type: oci.database.models.PluggableDatabaseRefreshableCloneConfig
-
time_created
¶ [Required] Gets the time_created of this PluggableDatabaseSummary. The date and time the pluggable database was created.
Returns: The time_created of this PluggableDatabaseSummary. Return type: datetime
-