File: //lib/mysqlsh/lib/python3.8/site-packages/oci/recovery/models/create_protected_database_details.py
# coding: utf-8
# Copyright (c) 2016, 2025, Oracle and/or its affiliates. All rights reserved.
# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20210216
from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401
from oci.decorators import init_model_state_from_kwargs
@init_model_state_from_kwargs
class CreateProtectedDatabaseDetails(object):
"""
Describes the parameters required to create a protected database.
"""
#: A constant which can be used with the database_size property of a CreateProtectedDatabaseDetails.
#: This constant has a value of "XS"
DATABASE_SIZE_XS = "XS"
#: A constant which can be used with the database_size property of a CreateProtectedDatabaseDetails.
#: This constant has a value of "S"
DATABASE_SIZE_S = "S"
#: A constant which can be used with the database_size property of a CreateProtectedDatabaseDetails.
#: This constant has a value of "M"
DATABASE_SIZE_M = "M"
#: A constant which can be used with the database_size property of a CreateProtectedDatabaseDetails.
#: This constant has a value of "L"
DATABASE_SIZE_L = "L"
#: A constant which can be used with the database_size property of a CreateProtectedDatabaseDetails.
#: This constant has a value of "XL"
DATABASE_SIZE_XL = "XL"
#: A constant which can be used with the database_size property of a CreateProtectedDatabaseDetails.
#: This constant has a value of "XXL"
DATABASE_SIZE_XXL = "XXL"
#: A constant which can be used with the database_size property of a CreateProtectedDatabaseDetails.
#: This constant has a value of "AUTO"
DATABASE_SIZE_AUTO = "AUTO"
def __init__(self, **kwargs):
"""
Initializes a new CreateProtectedDatabaseDetails object with values from keyword arguments.
The following keyword arguments are supported (corresponding to the getters/setters of this class):
:param display_name:
The value to assign to the display_name property of this CreateProtectedDatabaseDetails.
:type display_name: str
:param db_unique_name:
The value to assign to the db_unique_name property of this CreateProtectedDatabaseDetails.
:type db_unique_name: str
:param database_size:
The value to assign to the database_size property of this CreateProtectedDatabaseDetails.
Allowed values for this property are: "XS", "S", "M", "L", "XL", "XXL", "AUTO"
:type database_size: str
:param password:
The value to assign to the password property of this CreateProtectedDatabaseDetails.
:type password: str
:param protection_policy_id:
The value to assign to the protection_policy_id property of this CreateProtectedDatabaseDetails.
:type protection_policy_id: str
:param recovery_service_subnets:
The value to assign to the recovery_service_subnets property of this CreateProtectedDatabaseDetails.
:type recovery_service_subnets: list[oci.recovery.models.RecoveryServiceSubnetInput]
:param database_id:
The value to assign to the database_id property of this CreateProtectedDatabaseDetails.
:type database_id: str
:param compartment_id:
The value to assign to the compartment_id property of this CreateProtectedDatabaseDetails.
:type compartment_id: str
:param database_size_in_gbs:
The value to assign to the database_size_in_gbs property of this CreateProtectedDatabaseDetails.
:type database_size_in_gbs: int
:param change_rate:
The value to assign to the change_rate property of this CreateProtectedDatabaseDetails.
:type change_rate: float
:param compression_ratio:
The value to assign to the compression_ratio property of this CreateProtectedDatabaseDetails.
:type compression_ratio: float
:param is_redo_logs_shipped:
The value to assign to the is_redo_logs_shipped property of this CreateProtectedDatabaseDetails.
:type is_redo_logs_shipped: bool
:param subscription_id:
The value to assign to the subscription_id property of this CreateProtectedDatabaseDetails.
:type subscription_id: str
:param freeform_tags:
The value to assign to the freeform_tags property of this CreateProtectedDatabaseDetails.
:type freeform_tags: dict(str, str)
:param defined_tags:
The value to assign to the defined_tags property of this CreateProtectedDatabaseDetails.
:type defined_tags: dict(str, dict(str, object))
"""
self.swagger_types = {
'display_name': 'str',
'db_unique_name': 'str',
'database_size': 'str',
'password': 'str',
'protection_policy_id': 'str',
'recovery_service_subnets': 'list[RecoveryServiceSubnetInput]',
'database_id': 'str',
'compartment_id': 'str',
'database_size_in_gbs': 'int',
'change_rate': 'float',
'compression_ratio': 'float',
'is_redo_logs_shipped': 'bool',
'subscription_id': 'str',
'freeform_tags': 'dict(str, str)',
'defined_tags': 'dict(str, dict(str, object))'
}
self.attribute_map = {
'display_name': 'displayName',
'db_unique_name': 'dbUniqueName',
'database_size': 'databaseSize',
'password': 'password',
'protection_policy_id': 'protectionPolicyId',
'recovery_service_subnets': 'recoveryServiceSubnets',
'database_id': 'databaseId',
'compartment_id': 'compartmentId',
'database_size_in_gbs': 'databaseSizeInGBs',
'change_rate': 'changeRate',
'compression_ratio': 'compressionRatio',
'is_redo_logs_shipped': 'isRedoLogsShipped',
'subscription_id': 'subscriptionId',
'freeform_tags': 'freeformTags',
'defined_tags': 'definedTags'
}
self._display_name = None
self._db_unique_name = None
self._database_size = None
self._password = None
self._protection_policy_id = None
self._recovery_service_subnets = None
self._database_id = None
self._compartment_id = None
self._database_size_in_gbs = None
self._change_rate = None
self._compression_ratio = None
self._is_redo_logs_shipped = None
self._subscription_id = None
self._freeform_tags = None
self._defined_tags = None
@property
def display_name(self):
"""
**[Required]** Gets the display_name of this CreateProtectedDatabaseDetails.
The protected database name. You can change the displayName. Avoid entering confidential information.
:return: The display_name of this CreateProtectedDatabaseDetails.
:rtype: str
"""
return self._display_name
@display_name.setter
def display_name(self, display_name):
"""
Sets the display_name of this CreateProtectedDatabaseDetails.
The protected database name. You can change the displayName. Avoid entering confidential information.
:param display_name: The display_name of this CreateProtectedDatabaseDetails.
:type: str
"""
self._display_name = display_name
@property
def db_unique_name(self):
"""
**[Required]** Gets the db_unique_name of this CreateProtectedDatabaseDetails.
The dbUniqueName of the protected database in Recovery Service. You cannot change the unique name.
:return: The db_unique_name of this CreateProtectedDatabaseDetails.
:rtype: str
"""
return self._db_unique_name
@db_unique_name.setter
def db_unique_name(self, db_unique_name):
"""
Sets the db_unique_name of this CreateProtectedDatabaseDetails.
The dbUniqueName of the protected database in Recovery Service. You cannot change the unique name.
:param db_unique_name: The db_unique_name of this CreateProtectedDatabaseDetails.
:type: str
"""
self._db_unique_name = db_unique_name
@property
def database_size(self):
"""
Gets the database_size of this CreateProtectedDatabaseDetails.
The size of the protected database. XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L - 500GB to 1TB, XL - 1TB to 5TB, XXL - Greater than 5TB.
Allowed values for this property are: "XS", "S", "M", "L", "XL", "XXL", "AUTO"
:return: The database_size of this CreateProtectedDatabaseDetails.
:rtype: str
"""
return self._database_size
@database_size.setter
def database_size(self, database_size):
"""
Sets the database_size of this CreateProtectedDatabaseDetails.
The size of the protected database. XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L - 500GB to 1TB, XL - 1TB to 5TB, XXL - Greater than 5TB.
:param database_size: The database_size of this CreateProtectedDatabaseDetails.
:type: str
"""
allowed_values = ["XS", "S", "M", "L", "XL", "XXL", "AUTO"]
if not value_allowed_none_or_none_sentinel(database_size, allowed_values):
raise ValueError(
f"Invalid value for `database_size`, must be None or one of {allowed_values}"
)
self._database_size = database_size
@property
def password(self):
"""
**[Required]** Gets the password of this CreateProtectedDatabaseDetails.
Password credential which can be used to connect to Protected Database.
It must contain at least 2 uppercase, 2 lowercase, 2 numeric and 2 special characters.
The special characters must be underscore (_), number sign (#) or hyphen (-). The password must not contain the username \"admin\", regardless of casing.
:return: The password of this CreateProtectedDatabaseDetails.
:rtype: str
"""
return self._password
@password.setter
def password(self, password):
"""
Sets the password of this CreateProtectedDatabaseDetails.
Password credential which can be used to connect to Protected Database.
It must contain at least 2 uppercase, 2 lowercase, 2 numeric and 2 special characters.
The special characters must be underscore (_), number sign (#) or hyphen (-). The password must not contain the username \"admin\", regardless of casing.
:param password: The password of this CreateProtectedDatabaseDetails.
:type: str
"""
self._password = password
@property
def protection_policy_id(self):
"""
**[Required]** Gets the protection_policy_id of this CreateProtectedDatabaseDetails.
The OCID of the protection policy associated with the protected database.
:return: The protection_policy_id of this CreateProtectedDatabaseDetails.
:rtype: str
"""
return self._protection_policy_id
@protection_policy_id.setter
def protection_policy_id(self, protection_policy_id):
"""
Sets the protection_policy_id of this CreateProtectedDatabaseDetails.
The OCID of the protection policy associated with the protected database.
:param protection_policy_id: The protection_policy_id of this CreateProtectedDatabaseDetails.
:type: str
"""
self._protection_policy_id = protection_policy_id
@property
def recovery_service_subnets(self):
"""
**[Required]** Gets the recovery_service_subnets of this CreateProtectedDatabaseDetails.
List of recovery service subnet resources associated with the protected database.
:return: The recovery_service_subnets of this CreateProtectedDatabaseDetails.
:rtype: list[oci.recovery.models.RecoveryServiceSubnetInput]
"""
return self._recovery_service_subnets
@recovery_service_subnets.setter
def recovery_service_subnets(self, recovery_service_subnets):
"""
Sets the recovery_service_subnets of this CreateProtectedDatabaseDetails.
List of recovery service subnet resources associated with the protected database.
:param recovery_service_subnets: The recovery_service_subnets of this CreateProtectedDatabaseDetails.
:type: list[oci.recovery.models.RecoveryServiceSubnetInput]
"""
self._recovery_service_subnets = recovery_service_subnets
@property
def database_id(self):
"""
Gets the database_id of this CreateProtectedDatabaseDetails.
The OCID of the protected database.
:return: The database_id of this CreateProtectedDatabaseDetails.
:rtype: str
"""
return self._database_id
@database_id.setter
def database_id(self, database_id):
"""
Sets the database_id of this CreateProtectedDatabaseDetails.
The OCID of the protected database.
:param database_id: The database_id of this CreateProtectedDatabaseDetails.
:type: str
"""
self._database_id = database_id
@property
def compartment_id(self):
"""
**[Required]** Gets the compartment_id of this CreateProtectedDatabaseDetails.
The OCID of the compartment that contains the protected database.
:return: The compartment_id of this CreateProtectedDatabaseDetails.
:rtype: str
"""
return self._compartment_id
@compartment_id.setter
def compartment_id(self, compartment_id):
"""
Sets the compartment_id of this CreateProtectedDatabaseDetails.
The OCID of the compartment that contains the protected database.
:param compartment_id: The compartment_id of this CreateProtectedDatabaseDetails.
:type: str
"""
self._compartment_id = compartment_id
@property
def database_size_in_gbs(self):
"""
Gets the database_size_in_gbs of this CreateProtectedDatabaseDetails.
The size of the database, in gigabytes.
:return: The database_size_in_gbs of this CreateProtectedDatabaseDetails.
:rtype: int
"""
return self._database_size_in_gbs
@database_size_in_gbs.setter
def database_size_in_gbs(self, database_size_in_gbs):
"""
Sets the database_size_in_gbs of this CreateProtectedDatabaseDetails.
The size of the database, in gigabytes.
:param database_size_in_gbs: The database_size_in_gbs of this CreateProtectedDatabaseDetails.
:type: int
"""
self._database_size_in_gbs = database_size_in_gbs
@property
def change_rate(self):
"""
Gets the change_rate of this CreateProtectedDatabaseDetails.
The percentage of data changes that exist in the database between successive incremental backups.
:return: The change_rate of this CreateProtectedDatabaseDetails.
:rtype: float
"""
return self._change_rate
@change_rate.setter
def change_rate(self, change_rate):
"""
Sets the change_rate of this CreateProtectedDatabaseDetails.
The percentage of data changes that exist in the database between successive incremental backups.
:param change_rate: The change_rate of this CreateProtectedDatabaseDetails.
:type: float
"""
self._change_rate = change_rate
@property
def compression_ratio(self):
"""
Gets the compression_ratio of this CreateProtectedDatabaseDetails.
The compression ratio of the protected database. The compression ratio represents the ratio of compressed block size to expanded block size.
:return: The compression_ratio of this CreateProtectedDatabaseDetails.
:rtype: float
"""
return self._compression_ratio
@compression_ratio.setter
def compression_ratio(self, compression_ratio):
"""
Sets the compression_ratio of this CreateProtectedDatabaseDetails.
The compression ratio of the protected database. The compression ratio represents the ratio of compressed block size to expanded block size.
:param compression_ratio: The compression_ratio of this CreateProtectedDatabaseDetails.
:type: float
"""
self._compression_ratio = compression_ratio
@property
def is_redo_logs_shipped(self):
"""
Gets the is_redo_logs_shipped of this CreateProtectedDatabaseDetails.
The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service.
Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups.
:return: The is_redo_logs_shipped of this CreateProtectedDatabaseDetails.
:rtype: bool
"""
return self._is_redo_logs_shipped
@is_redo_logs_shipped.setter
def is_redo_logs_shipped(self, is_redo_logs_shipped):
"""
Sets the is_redo_logs_shipped of this CreateProtectedDatabaseDetails.
The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service.
Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups.
:param is_redo_logs_shipped: The is_redo_logs_shipped of this CreateProtectedDatabaseDetails.
:type: bool
"""
self._is_redo_logs_shipped = is_redo_logs_shipped
@property
def subscription_id(self):
"""
Gets the subscription_id of this CreateProtectedDatabaseDetails.
The OCID of the cloud service subscription to which you want to link the protected database.
For example, specify the Microsoft Azure subscription ID if you want to provision the protected database in Azure.
:return: The subscription_id of this CreateProtectedDatabaseDetails.
:rtype: str
"""
return self._subscription_id
@subscription_id.setter
def subscription_id(self, subscription_id):
"""
Sets the subscription_id of this CreateProtectedDatabaseDetails.
The OCID of the cloud service subscription to which you want to link the protected database.
For example, specify the Microsoft Azure subscription ID if you want to provision the protected database in Azure.
:param subscription_id: The subscription_id of this CreateProtectedDatabaseDetails.
:type: str
"""
self._subscription_id = subscription_id
@property
def freeform_tags(self):
"""
Gets the freeform_tags of this CreateProtectedDatabaseDetails.
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{\"bar-key\": \"value\"}`
:return: The freeform_tags of this CreateProtectedDatabaseDetails.
:rtype: dict(str, str)
"""
return self._freeform_tags
@freeform_tags.setter
def freeform_tags(self, freeform_tags):
"""
Sets the freeform_tags of this CreateProtectedDatabaseDetails.
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{\"bar-key\": \"value\"}`
:param freeform_tags: The freeform_tags of this CreateProtectedDatabaseDetails.
:type: dict(str, str)
"""
self._freeform_tags = freeform_tags
@property
def defined_tags(self):
"""
Gets the defined_tags of this CreateProtectedDatabaseDetails.
Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`. For more information, see `Resource Tags`__
__ https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm
:return: The defined_tags of this CreateProtectedDatabaseDetails.
:rtype: dict(str, dict(str, object))
"""
return self._defined_tags
@defined_tags.setter
def defined_tags(self, defined_tags):
"""
Sets the defined_tags of this CreateProtectedDatabaseDetails.
Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`. For more information, see `Resource Tags`__
__ https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm
:param defined_tags: The defined_tags of this CreateProtectedDatabaseDetails.
:type: dict(str, dict(str, object))
"""
self._defined_tags = defined_tags
def __repr__(self):
return formatted_flat_dict(self)
def __eq__(self, other):
if other is None:
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
return not self == other