Server : Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.4.20 System : Linux st2.domain.com 3.10.0-1127.10.1.el7.x86_64 #1 SMP Wed Jun 3 14:28:03 UTC 2020 x86_64 User : apache ( 48) PHP Version : 7.4.20 Disable Function : NONE Directory : /proc/self/root/usr/share/mysqlsh/oci_sdk/oci/file_storage/models/ |
# coding: utf-8
# Copyright (c) 2016, 2020, Oracle and/or its affiliates. All rights reserved.
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 Snapshot(object):
"""
A point-in-time snapshot of a specified file system.
**Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
"""
#: A constant which can be used with the lifecycle_state property of a Snapshot.
#: This constant has a value of "CREATING"
LIFECYCLE_STATE_CREATING = "CREATING"
#: A constant which can be used with the lifecycle_state property of a Snapshot.
#: This constant has a value of "ACTIVE"
LIFECYCLE_STATE_ACTIVE = "ACTIVE"
#: A constant which can be used with the lifecycle_state property of a Snapshot.
#: This constant has a value of "DELETING"
LIFECYCLE_STATE_DELETING = "DELETING"
#: A constant which can be used with the lifecycle_state property of a Snapshot.
#: This constant has a value of "DELETED"
LIFECYCLE_STATE_DELETED = "DELETED"
def __init__(self, **kwargs):
"""
Initializes a new Snapshot object with values from keyword arguments.
The following keyword arguments are supported (corresponding to the getters/setters of this class):
:param file_system_id:
The value to assign to the file_system_id property of this Snapshot.
:type file_system_id: str
:param id:
The value to assign to the id property of this Snapshot.
:type id: str
:param lifecycle_state:
The value to assign to the lifecycle_state property of this Snapshot.
Allowed values for this property are: "CREATING", "ACTIVE", "DELETING", "DELETED", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:type lifecycle_state: str
:param name:
The value to assign to the name property of this Snapshot.
:type name: str
:param time_created:
The value to assign to the time_created property of this Snapshot.
:type time_created: datetime
:param freeform_tags:
The value to assign to the freeform_tags property of this Snapshot.
:type freeform_tags: dict(str, str)
:param defined_tags:
The value to assign to the defined_tags property of this Snapshot.
:type defined_tags: dict(str, dict(str, object))
"""
self.swagger_types = {
'file_system_id': 'str',
'id': 'str',
'lifecycle_state': 'str',
'name': 'str',
'time_created': 'datetime',
'freeform_tags': 'dict(str, str)',
'defined_tags': 'dict(str, dict(str, object))'
}
self.attribute_map = {
'file_system_id': 'fileSystemId',
'id': 'id',
'lifecycle_state': 'lifecycleState',
'name': 'name',
'time_created': 'timeCreated',
'freeform_tags': 'freeformTags',
'defined_tags': 'definedTags'
}
self._file_system_id = None
self._id = None
self._lifecycle_state = None
self._name = None
self._time_created = None
self._freeform_tags = None
self._defined_tags = None
@property
def file_system_id(self):
"""
**[Required]** Gets the file_system_id of this Snapshot.
The OCID of the file system from which the snapshot
was created.
:return: The file_system_id of this Snapshot.
:rtype: str
"""
return self._file_system_id
@file_system_id.setter
def file_system_id(self, file_system_id):
"""
Sets the file_system_id of this Snapshot.
The OCID of the file system from which the snapshot
was created.
:param file_system_id: The file_system_id of this Snapshot.
:type: str
"""
self._file_system_id = file_system_id
@property
def id(self):
"""
**[Required]** Gets the id of this Snapshot.
The OCID of the snapshot.
:return: The id of this Snapshot.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this Snapshot.
The OCID of the snapshot.
:param id: The id of this Snapshot.
:type: str
"""
self._id = id
@property
def lifecycle_state(self):
"""
**[Required]** Gets the lifecycle_state of this Snapshot.
The current state of the snapshot.
Allowed values for this property are: "CREATING", "ACTIVE", "DELETING", "DELETED", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:return: The lifecycle_state of this Snapshot.
:rtype: str
"""
return self._lifecycle_state
@lifecycle_state.setter
def lifecycle_state(self, lifecycle_state):
"""
Sets the lifecycle_state of this Snapshot.
The current state of the snapshot.
:param lifecycle_state: The lifecycle_state of this Snapshot.
:type: str
"""
allowed_values = ["CREATING", "ACTIVE", "DELETING", "DELETED"]
if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values):
lifecycle_state = 'UNKNOWN_ENUM_VALUE'
self._lifecycle_state = lifecycle_state
@property
def name(self):
"""
**[Required]** Gets the name of this Snapshot.
Name of the snapshot. This value is immutable.
Avoid entering confidential information.
Example: `Sunday`
:return: The name of this Snapshot.
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""
Sets the name of this Snapshot.
Name of the snapshot. This value is immutable.
Avoid entering confidential information.
Example: `Sunday`
:param name: The name of this Snapshot.
:type: str
"""
self._name = name
@property
def time_created(self):
"""
**[Required]** Gets the time_created of this Snapshot.
The date and time the snapshot 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 Snapshot.
:rtype: datetime
"""
return self._time_created
@time_created.setter
def time_created(self, time_created):
"""
Sets the time_created of this Snapshot.
The date and time the snapshot 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 Snapshot.
:type: datetime
"""
self._time_created = time_created
@property
def freeform_tags(self):
"""
Gets the freeform_tags of this Snapshot.
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 Snapshot.
:rtype: dict(str, str)
"""
return self._freeform_tags
@freeform_tags.setter
def freeform_tags(self, freeform_tags):
"""
Sets the freeform_tags of this Snapshot.
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 Snapshot.
:type: dict(str, str)
"""
self._freeform_tags = freeform_tags
@property
def defined_tags(self):
"""
Gets the defined_tags of this Snapshot.
Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see `Resource Tags`__.
Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
__ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:return: The defined_tags of this Snapshot.
: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 Snapshot.
Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see `Resource Tags`__.
Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
__ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:param defined_tags: The defined_tags of this Snapshot.
: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