File: //lib/mysqlsh/lib/python3.8/site-packages/oci/psql/models/db_instance.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: 20220915
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 DbInstance(object):
"""
Information about a database instance node.
"""
#: A constant which can be used with the lifecycle_state property of a DbInstance.
#: This constant has a value of "CREATING"
LIFECYCLE_STATE_CREATING = "CREATING"
#: A constant which can be used with the lifecycle_state property of a DbInstance.
#: This constant has a value of "UPDATING"
LIFECYCLE_STATE_UPDATING = "UPDATING"
#: A constant which can be used with the lifecycle_state property of a DbInstance.
#: This constant has a value of "ACTIVE"
LIFECYCLE_STATE_ACTIVE = "ACTIVE"
#: A constant which can be used with the lifecycle_state property of a DbInstance.
#: This constant has a value of "INACTIVE"
LIFECYCLE_STATE_INACTIVE = "INACTIVE"
#: A constant which can be used with the lifecycle_state property of a DbInstance.
#: This constant has a value of "DELETING"
LIFECYCLE_STATE_DELETING = "DELETING"
#: A constant which can be used with the lifecycle_state property of a DbInstance.
#: This constant has a value of "DELETED"
LIFECYCLE_STATE_DELETED = "DELETED"
#: A constant which can be used with the lifecycle_state property of a DbInstance.
#: This constant has a value of "FAILED"
LIFECYCLE_STATE_FAILED = "FAILED"
def __init__(self, **kwargs):
"""
Initializes a new DbInstance 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 DbInstance.
:type id: str
:param display_name:
The value to assign to the display_name property of this DbInstance.
:type display_name: str
:param description:
The value to assign to the description property of this DbInstance.
:type description: str
:param availability_domain:
The value to assign to the availability_domain property of this DbInstance.
:type availability_domain: str
:param lifecycle_state:
The value to assign to the lifecycle_state property of this DbInstance.
Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:type lifecycle_state: str
:param lifecycle_details:
The value to assign to the lifecycle_details property of this DbInstance.
:type lifecycle_details: str
:param time_created:
The value to assign to the time_created property of this DbInstance.
:type time_created: datetime
:param time_updated:
The value to assign to the time_updated property of this DbInstance.
:type time_updated: datetime
"""
self.swagger_types = {
'id': 'str',
'display_name': 'str',
'description': 'str',
'availability_domain': 'str',
'lifecycle_state': 'str',
'lifecycle_details': 'str',
'time_created': 'datetime',
'time_updated': 'datetime'
}
self.attribute_map = {
'id': 'id',
'display_name': 'displayName',
'description': 'description',
'availability_domain': 'availabilityDomain',
'lifecycle_state': 'lifecycleState',
'lifecycle_details': 'lifecycleDetails',
'time_created': 'timeCreated',
'time_updated': 'timeUpdated'
}
self._id = None
self._display_name = None
self._description = None
self._availability_domain = None
self._lifecycle_state = None
self._lifecycle_details = None
self._time_created = None
self._time_updated = None
@property
def id(self):
"""
**[Required]** Gets the id of this DbInstance.
A unique identifier for the database instance node. Immutable on creation.
:return: The id of this DbInstance.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this DbInstance.
A unique identifier for the database instance node. Immutable on creation.
:param id: The id of this DbInstance.
:type: str
"""
self._id = id
@property
def display_name(self):
"""
Gets the display_name of this DbInstance.
A user-friendly display name for the database instance node. Avoid entering confidential information.
:return: The display_name of this DbInstance.
:rtype: str
"""
return self._display_name
@display_name.setter
def display_name(self, display_name):
"""
Sets the display_name of this DbInstance.
A user-friendly display name for the database instance node. Avoid entering confidential information.
:param display_name: The display_name of this DbInstance.
:type: str
"""
self._display_name = display_name
@property
def description(self):
"""
Gets the description of this DbInstance.
Description of the database instance node.
:return: The description of this DbInstance.
:rtype: str
"""
return self._description
@description.setter
def description(self, description):
"""
Sets the description of this DbInstance.
Description of the database instance node.
:param description: The description of this DbInstance.
:type: str
"""
self._description = description
@property
def availability_domain(self):
"""
**[Required]** Gets the availability_domain of this DbInstance.
The availability domain in which the database instance node is located.
:return: The availability_domain of this DbInstance.
:rtype: str
"""
return self._availability_domain
@availability_domain.setter
def availability_domain(self, availability_domain):
"""
Sets the availability_domain of this DbInstance.
The availability domain in which the database instance node is located.
:param availability_domain: The availability_domain of this DbInstance.
:type: str
"""
self._availability_domain = availability_domain
@property
def lifecycle_state(self):
"""
**[Required]** Gets the lifecycle_state of this DbInstance.
The current state of the database instance node.
Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:return: The lifecycle_state of this DbInstance.
:rtype: str
"""
return self._lifecycle_state
@lifecycle_state.setter
def lifecycle_state(self, lifecycle_state):
"""
Sets the lifecycle_state of this DbInstance.
The current state of the database instance node.
:param lifecycle_state: The lifecycle_state of this DbInstance.
:type: str
"""
allowed_values = ["CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED"]
if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values):
lifecycle_state = 'UNKNOWN_ENUM_VALUE'
self._lifecycle_state = lifecycle_state
@property
def lifecycle_details(self):
"""
Gets the lifecycle_details of this DbInstance.
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
:return: The lifecycle_details of this DbInstance.
:rtype: str
"""
return self._lifecycle_details
@lifecycle_details.setter
def lifecycle_details(self, lifecycle_details):
"""
Sets the lifecycle_details of this DbInstance.
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
:param lifecycle_details: The lifecycle_details of this DbInstance.
:type: str
"""
self._lifecycle_details = lifecycle_details
@property
def time_created(self):
"""
**[Required]** Gets the time_created of this DbInstance.
The date and time that the database instance node was created, expressed in
`RFC 3339`__ timestamp format.
Example: `2016-08-25T21:10:29.600Z`
__ https://tools.ietf.org/rfc/rfc3339
:return: The time_created of this DbInstance.
:rtype: datetime
"""
return self._time_created
@time_created.setter
def time_created(self, time_created):
"""
Sets the time_created of this DbInstance.
The date and time that the database instance node was created, expressed in
`RFC 3339`__ timestamp format.
Example: `2016-08-25T21:10:29.600Z`
__ https://tools.ietf.org/rfc/rfc3339
:param time_created: The time_created of this DbInstance.
:type: datetime
"""
self._time_created = time_created
@property
def time_updated(self):
"""
Gets the time_updated of this DbInstance.
The date and time that the database instance node was updated, expressed in
`RFC 3339`__ timestamp format.
Example: `2016-08-25T21:10:29.600Z`
__ https://tools.ietf.org/rfc/rfc3339
:return: The time_updated of this DbInstance.
:rtype: datetime
"""
return self._time_updated
@time_updated.setter
def time_updated(self, time_updated):
"""
Sets the time_updated of this DbInstance.
The date and time that the database instance node was updated, expressed in
`RFC 3339`__ timestamp format.
Example: `2016-08-25T21:10:29.600Z`
__ https://tools.ietf.org/rfc/rfc3339
:param time_updated: The time_updated of this DbInstance.
:type: datetime
"""
self._time_updated = time_updated
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