File: //lib/mysqlsh/lib/python3.8/site-packages/oci/database/models/db_home_from_agent_resource_id.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: 20160918
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 DbHomeFromAgentResourceId(object):
"""
DbHomeFromAgentResourceId model.
"""
#: A constant which can be used with the lifecycle_state property of a DbHomeFromAgentResourceId.
#: This constant has a value of "PROVISIONING"
LIFECYCLE_STATE_PROVISIONING = "PROVISIONING"
#: A constant which can be used with the lifecycle_state property of a DbHomeFromAgentResourceId.
#: This constant has a value of "AVAILABLE"
LIFECYCLE_STATE_AVAILABLE = "AVAILABLE"
#: A constant which can be used with the lifecycle_state property of a DbHomeFromAgentResourceId.
#: This constant has a value of "UPDATING"
LIFECYCLE_STATE_UPDATING = "UPDATING"
#: A constant which can be used with the lifecycle_state property of a DbHomeFromAgentResourceId.
#: This constant has a value of "TERMINATING"
LIFECYCLE_STATE_TERMINATING = "TERMINATING"
#: A constant which can be used with the lifecycle_state property of a DbHomeFromAgentResourceId.
#: This constant has a value of "TERMINATED"
LIFECYCLE_STATE_TERMINATED = "TERMINATED"
#: A constant which can be used with the lifecycle_state property of a DbHomeFromAgentResourceId.
#: This constant has a value of "FAILED"
LIFECYCLE_STATE_FAILED = "FAILED"
def __init__(self, **kwargs):
"""
Initializes a new DbHomeFromAgentResourceId object with values from keyword arguments.
The following keyword arguments are supported (corresponding to the getters/setters of this class):
:param id:
The value to assign to the id property of this DbHomeFromAgentResourceId.
:type id: str
:param compartment_id:
The value to assign to the compartment_id property of this DbHomeFromAgentResourceId.
:type compartment_id: str
:param display_name:
The value to assign to the display_name property of this DbHomeFromAgentResourceId.
:type display_name: str
:param last_patch_history_entry_id:
The value to assign to the last_patch_history_entry_id property of this DbHomeFromAgentResourceId.
:type last_patch_history_entry_id: str
:param lifecycle_state:
The value to assign to the lifecycle_state property of this DbHomeFromAgentResourceId.
Allowed values for this property are: "PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED"
:type lifecycle_state: str
:param db_system_id:
The value to assign to the db_system_id property of this DbHomeFromAgentResourceId.
:type db_system_id: str
:param vm_cluster_id:
The value to assign to the vm_cluster_id property of this DbHomeFromAgentResourceId.
:type vm_cluster_id: str
:param db_version:
The value to assign to the db_version property of this DbHomeFromAgentResourceId.
:type db_version: str
:param db_home_location:
The value to assign to the db_home_location property of this DbHomeFromAgentResourceId.
:type db_home_location: str
:param lifecycle_details:
The value to assign to the lifecycle_details property of this DbHomeFromAgentResourceId.
:type lifecycle_details: str
:param time_created:
The value to assign to the time_created property of this DbHomeFromAgentResourceId.
:type time_created: datetime
:param kms_key_id:
The value to assign to the kms_key_id property of this DbHomeFromAgentResourceId.
:type kms_key_id: str
:param one_off_patches:
The value to assign to the one_off_patches property of this DbHomeFromAgentResourceId.
:type one_off_patches: list[str]
:param freeform_tags:
The value to assign to the freeform_tags property of this DbHomeFromAgentResourceId.
:type freeform_tags: dict(str, str)
:param defined_tags:
The value to assign to the defined_tags property of this DbHomeFromAgentResourceId.
:type defined_tags: dict(str, dict(str, object))
:param database_software_image_id:
The value to assign to the database_software_image_id property of this DbHomeFromAgentResourceId.
:type database_software_image_id: str
:param is_unified_auditing_enabled:
The value to assign to the is_unified_auditing_enabled property of this DbHomeFromAgentResourceId.
:type is_unified_auditing_enabled: bool
"""
self.swagger_types = {
'id': 'str',
'compartment_id': 'str',
'display_name': 'str',
'last_patch_history_entry_id': 'str',
'lifecycle_state': 'str',
'db_system_id': 'str',
'vm_cluster_id': 'str',
'db_version': 'str',
'db_home_location': 'str',
'lifecycle_details': 'str',
'time_created': 'datetime',
'kms_key_id': 'str',
'one_off_patches': 'list[str]',
'freeform_tags': 'dict(str, str)',
'defined_tags': 'dict(str, dict(str, object))',
'database_software_image_id': 'str',
'is_unified_auditing_enabled': 'bool'
}
self.attribute_map = {
'id': 'id',
'compartment_id': 'compartmentId',
'display_name': 'displayName',
'last_patch_history_entry_id': 'lastPatchHistoryEntryId',
'lifecycle_state': 'lifecycleState',
'db_system_id': 'dbSystemId',
'vm_cluster_id': 'vmClusterId',
'db_version': 'dbVersion',
'db_home_location': 'dbHomeLocation',
'lifecycle_details': 'lifecycleDetails',
'time_created': 'timeCreated',
'kms_key_id': 'kmsKeyId',
'one_off_patches': 'oneOffPatches',
'freeform_tags': 'freeformTags',
'defined_tags': 'definedTags',
'database_software_image_id': 'databaseSoftwareImageId',
'is_unified_auditing_enabled': 'isUnifiedAuditingEnabled'
}
self._id = None
self._compartment_id = None
self._display_name = None
self._last_patch_history_entry_id = None
self._lifecycle_state = None
self._db_system_id = None
self._vm_cluster_id = None
self._db_version = None
self._db_home_location = None
self._lifecycle_details = None
self._time_created = None
self._kms_key_id = None
self._one_off_patches = None
self._freeform_tags = None
self._defined_tags = None
self._database_software_image_id = None
self._is_unified_auditing_enabled = None
@property
def id(self):
"""
**[Required]** Gets the id of this DbHomeFromAgentResourceId.
The `OCID`__ of the Database Home.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:return: The id of this DbHomeFromAgentResourceId.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this DbHomeFromAgentResourceId.
The `OCID`__ of the Database Home.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:param id: The id of this DbHomeFromAgentResourceId.
:type: str
"""
self._id = id
@property
def compartment_id(self):
"""
**[Required]** Gets the compartment_id of this DbHomeFromAgentResourceId.
The `OCID`__ of the compartment.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:return: The compartment_id of this DbHomeFromAgentResourceId.
:rtype: str
"""
return self._compartment_id
@compartment_id.setter
def compartment_id(self, compartment_id):
"""
Sets the compartment_id of this DbHomeFromAgentResourceId.
The `OCID`__ of the compartment.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:param compartment_id: The compartment_id of this DbHomeFromAgentResourceId.
:type: str
"""
self._compartment_id = compartment_id
@property
def display_name(self):
"""
**[Required]** Gets the display_name of this DbHomeFromAgentResourceId.
The user-provided name for the Database Home. The name does not need to be unique.
:return: The display_name of this DbHomeFromAgentResourceId.
:rtype: str
"""
return self._display_name
@display_name.setter
def display_name(self, display_name):
"""
Sets the display_name of this DbHomeFromAgentResourceId.
The user-provided name for the Database Home. The name does not need to be unique.
:param display_name: The display_name of this DbHomeFromAgentResourceId.
:type: str
"""
self._display_name = display_name
@property
def last_patch_history_entry_id(self):
"""
Gets the last_patch_history_entry_id of this DbHomeFromAgentResourceId.
The `OCID`__ of the last patch history. This value is updated as soon as a patch operation is started.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:return: The last_patch_history_entry_id of this DbHomeFromAgentResourceId.
:rtype: str
"""
return self._last_patch_history_entry_id
@last_patch_history_entry_id.setter
def last_patch_history_entry_id(self, last_patch_history_entry_id):
"""
Sets the last_patch_history_entry_id of this DbHomeFromAgentResourceId.
The `OCID`__ of the last patch history. This value is updated as soon as a patch operation is started.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:param last_patch_history_entry_id: The last_patch_history_entry_id of this DbHomeFromAgentResourceId.
:type: str
"""
self._last_patch_history_entry_id = last_patch_history_entry_id
@property
def lifecycle_state(self):
"""
**[Required]** Gets the lifecycle_state of this DbHomeFromAgentResourceId.
The current state of the Database Home.
Allowed values for this property are: "PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED"
:return: The lifecycle_state of this DbHomeFromAgentResourceId.
:rtype: str
"""
return self._lifecycle_state
@lifecycle_state.setter
def lifecycle_state(self, lifecycle_state):
"""
Sets the lifecycle_state of this DbHomeFromAgentResourceId.
The current state of the Database Home.
:param lifecycle_state: The lifecycle_state of this DbHomeFromAgentResourceId.
:type: str
"""
allowed_values = ["PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED"]
if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values):
raise ValueError(
f"Invalid value for `lifecycle_state`, must be None or one of {allowed_values}"
)
self._lifecycle_state = lifecycle_state
@property
def db_system_id(self):
"""
Gets the db_system_id of this DbHomeFromAgentResourceId.
The `OCID`__ of the DB system.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:return: The db_system_id of this DbHomeFromAgentResourceId.
:rtype: str
"""
return self._db_system_id
@db_system_id.setter
def db_system_id(self, db_system_id):
"""
Sets the db_system_id of this DbHomeFromAgentResourceId.
The `OCID`__ of the DB system.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:param db_system_id: The db_system_id of this DbHomeFromAgentResourceId.
:type: str
"""
self._db_system_id = db_system_id
@property
def vm_cluster_id(self):
"""
Gets the vm_cluster_id of this DbHomeFromAgentResourceId.
The `OCID`__ of the VM cluster.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:return: The vm_cluster_id of this DbHomeFromAgentResourceId.
:rtype: str
"""
return self._vm_cluster_id
@vm_cluster_id.setter
def vm_cluster_id(self, vm_cluster_id):
"""
Sets the vm_cluster_id of this DbHomeFromAgentResourceId.
The `OCID`__ of the VM cluster.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:param vm_cluster_id: The vm_cluster_id of this DbHomeFromAgentResourceId.
:type: str
"""
self._vm_cluster_id = vm_cluster_id
@property
def db_version(self):
"""
**[Required]** Gets the db_version of this DbHomeFromAgentResourceId.
The Oracle Database version.
:return: The db_version of this DbHomeFromAgentResourceId.
:rtype: str
"""
return self._db_version
@db_version.setter
def db_version(self, db_version):
"""
Sets the db_version of this DbHomeFromAgentResourceId.
The Oracle Database version.
:param db_version: The db_version of this DbHomeFromAgentResourceId.
:type: str
"""
self._db_version = db_version
@property
def db_home_location(self):
"""
**[Required]** Gets the db_home_location of this DbHomeFromAgentResourceId.
The location of the Oracle Database Home.
:return: The db_home_location of this DbHomeFromAgentResourceId.
:rtype: str
"""
return self._db_home_location
@db_home_location.setter
def db_home_location(self, db_home_location):
"""
Sets the db_home_location of this DbHomeFromAgentResourceId.
The location of the Oracle Database Home.
:param db_home_location: The db_home_location of this DbHomeFromAgentResourceId.
:type: str
"""
self._db_home_location = db_home_location
@property
def lifecycle_details(self):
"""
Gets the lifecycle_details of this DbHomeFromAgentResourceId.
Additional information about the current lifecycle state.
:return: The lifecycle_details of this DbHomeFromAgentResourceId.
:rtype: str
"""
return self._lifecycle_details
@lifecycle_details.setter
def lifecycle_details(self, lifecycle_details):
"""
Sets the lifecycle_details of this DbHomeFromAgentResourceId.
Additional information about the current lifecycle state.
:param lifecycle_details: The lifecycle_details of this DbHomeFromAgentResourceId.
:type: str
"""
self._lifecycle_details = lifecycle_details
@property
def time_created(self):
"""
Gets the time_created of this DbHomeFromAgentResourceId.
The date and time the Database Home was created.
:return: The time_created of this DbHomeFromAgentResourceId.
:rtype: datetime
"""
return self._time_created
@time_created.setter
def time_created(self, time_created):
"""
Sets the time_created of this DbHomeFromAgentResourceId.
The date and time the Database Home was created.
:param time_created: The time_created of this DbHomeFromAgentResourceId.
:type: datetime
"""
self._time_created = time_created
@property
def kms_key_id(self):
"""
Gets the kms_key_id of this DbHomeFromAgentResourceId.
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
:return: The kms_key_id of this DbHomeFromAgentResourceId.
:rtype: str
"""
return self._kms_key_id
@kms_key_id.setter
def kms_key_id(self, kms_key_id):
"""
Sets the kms_key_id of this DbHomeFromAgentResourceId.
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
:param kms_key_id: The kms_key_id of this DbHomeFromAgentResourceId.
:type: str
"""
self._kms_key_id = kms_key_id
@property
def one_off_patches(self):
"""
Gets the one_off_patches of this DbHomeFromAgentResourceId.
List of one-off patches for Database Homes.
:return: The one_off_patches of this DbHomeFromAgentResourceId.
:rtype: list[str]
"""
return self._one_off_patches
@one_off_patches.setter
def one_off_patches(self, one_off_patches):
"""
Sets the one_off_patches of this DbHomeFromAgentResourceId.
List of one-off patches for Database Homes.
:param one_off_patches: The one_off_patches of this DbHomeFromAgentResourceId.
:type: list[str]
"""
self._one_off_patches = one_off_patches
@property
def freeform_tags(self):
"""
Gets the freeform_tags of this DbHomeFromAgentResourceId.
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\"}`
__ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:return: The freeform_tags of this DbHomeFromAgentResourceId.
:rtype: dict(str, str)
"""
return self._freeform_tags
@freeform_tags.setter
def freeform_tags(self, freeform_tags):
"""
Sets the freeform_tags of this DbHomeFromAgentResourceId.
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\"}`
__ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:param freeform_tags: The freeform_tags of this DbHomeFromAgentResourceId.
:type: dict(str, str)
"""
self._freeform_tags = freeform_tags
@property
def defined_tags(self):
"""
Gets the defined_tags of this DbHomeFromAgentResourceId.
Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see `Resource Tags`__.
__ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:return: The defined_tags of this DbHomeFromAgentResourceId.
: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 DbHomeFromAgentResourceId.
Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see `Resource Tags`__.
__ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:param defined_tags: The defined_tags of this DbHomeFromAgentResourceId.
:type: dict(str, dict(str, object))
"""
self._defined_tags = defined_tags
@property
def database_software_image_id(self):
"""
Gets the database_software_image_id of this DbHomeFromAgentResourceId.
The database software image `OCID`__
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:return: The database_software_image_id of this DbHomeFromAgentResourceId.
:rtype: str
"""
return self._database_software_image_id
@database_software_image_id.setter
def database_software_image_id(self, database_software_image_id):
"""
Sets the database_software_image_id of this DbHomeFromAgentResourceId.
The database software image `OCID`__
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:param database_software_image_id: The database_software_image_id of this DbHomeFromAgentResourceId.
:type: str
"""
self._database_software_image_id = database_software_image_id
@property
def is_unified_auditing_enabled(self):
"""
Gets the is_unified_auditing_enabled of this DbHomeFromAgentResourceId.
Indicates whether unified autiding is enabled or not.
:return: The is_unified_auditing_enabled of this DbHomeFromAgentResourceId.
:rtype: bool
"""
return self._is_unified_auditing_enabled
@is_unified_auditing_enabled.setter
def is_unified_auditing_enabled(self, is_unified_auditing_enabled):
"""
Sets the is_unified_auditing_enabled of this DbHomeFromAgentResourceId.
Indicates whether unified autiding is enabled or not.
:param is_unified_auditing_enabled: The is_unified_auditing_enabled of this DbHomeFromAgentResourceId.
:type: bool
"""
self._is_unified_auditing_enabled = is_unified_auditing_enabled
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