# coding: utf-8
# Copyright (c) 2016, 2026, 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: 20200131


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 ComplianceDocument(object):
    """
    A compliance document that exists in the tenancy.
    """

    #: A constant which can be used with the lifecycle_state property of a ComplianceDocument.
    #: This constant has a value of "ACTIVE"
    LIFECYCLE_STATE_ACTIVE = "ACTIVE"

    #: A constant which can be used with the lifecycle_state property of a ComplianceDocument.
    #: This constant has a value of "INACTIVE"
    LIFECYCLE_STATE_INACTIVE = "INACTIVE"

    def __init__(self, **kwargs):
        """
        Initializes a new ComplianceDocument 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 ComplianceDocument.
        :type id: str

        :param name:
            The value to assign to the name property of this ComplianceDocument.
        :type name: str

        :param time_created:
            The value to assign to the time_created property of this ComplianceDocument.
        :type time_created: datetime

        :param lifecycle_state:
            The value to assign to the lifecycle_state property of this ComplianceDocument.
            Allowed values for this property are: "ACTIVE", "INACTIVE"
        :type lifecycle_state: str

        :param document_file_name:
            The value to assign to the document_file_name property of this ComplianceDocument.
        :type document_file_name: str

        :param version:
            The value to assign to the version property of this ComplianceDocument.
        :type version: int

        :param type:
            The value to assign to the type property of this ComplianceDocument.
        :type type: str

        :param platform:
            The value to assign to the platform property of this ComplianceDocument.
        :type platform: str

        :param time_updated:
            The value to assign to the time_updated property of this ComplianceDocument.
        :type time_updated: datetime

        :param saas_service_name:
            The value to assign to the saas_service_name property of this ComplianceDocument.
        :type saas_service_name: str

        """
        self.swagger_types = {
            'id': 'str',
            'name': 'str',
            'time_created': 'datetime',
            'lifecycle_state': 'str',
            'document_file_name': 'str',
            'version': 'int',
            'type': 'str',
            'platform': 'str',
            'time_updated': 'datetime',
            'saas_service_name': 'str'
        }
        self.attribute_map = {
            'id': 'id',
            'name': 'name',
            'time_created': 'timeCreated',
            'lifecycle_state': 'lifecycleState',
            'document_file_name': 'documentFileName',
            'version': 'version',
            'type': 'type',
            'platform': 'platform',
            'time_updated': 'timeUpdated',
            'saas_service_name': 'saasServiceName'
        }
        self._id = None
        self._name = None
        self._time_created = None
        self._lifecycle_state = None
        self._document_file_name = None
        self._version = None
        self._type = None
        self._platform = None
        self._time_updated = None
        self._saas_service_name = None

    @property
    def id(self):
        """
        **[Required]** Gets the id of this ComplianceDocument.
        The `OCID`__ of the compliance document, which is assigned
        when you create the document as an Oracle Cloud Infrastructure resource and is immutable.

        __ https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm


        :return: The id of this ComplianceDocument.
        :rtype: str
        """
        return self._id

    @id.setter
    def id(self, id):
        """
        Sets the id of this ComplianceDocument.
        The `OCID`__ of the compliance document, which is assigned
        when you create the document as an Oracle Cloud Infrastructure resource and is immutable.

        __ https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm


        :param id: The id of this ComplianceDocument.
        :type: str
        """
        self._id = id

    @property
    def name(self):
        """
        **[Required]** Gets the name of this ComplianceDocument.
        A friendly name or title for the compliance document. You cannot update this value later.
        Avoid entering confidential information.


        :return: The name of this ComplianceDocument.
        :rtype: str
        """
        return self._name

    @name.setter
    def name(self, name):
        """
        Sets the name of this ComplianceDocument.
        A friendly name or title for the compliance document. You cannot update this value later.
        Avoid entering confidential information.


        :param name: The name of this ComplianceDocument.
        :type: str
        """
        self._name = name

    @property
    def time_created(self):
        """
        **[Required]** Gets the time_created of this ComplianceDocument.
        The date and time the compliance document was created, expressed in `RFC 3339`__ timestamp format.

        __ https://tools.ietf.org/html/rfc3339


        :return: The time_created of this ComplianceDocument.
        :rtype: datetime
        """
        return self._time_created

    @time_created.setter
    def time_created(self, time_created):
        """
        Sets the time_created of this ComplianceDocument.
        The date and time the compliance document was created, expressed in `RFC 3339`__ timestamp format.

        __ https://tools.ietf.org/html/rfc3339


        :param time_created: The time_created of this ComplianceDocument.
        :type: datetime
        """
        self._time_created = time_created

    @property
    def lifecycle_state(self):
        """
        **[Required]** Gets the lifecycle_state of this ComplianceDocument.
        The current lifecycle state of the compliance document.

        Allowed values for this property are: "ACTIVE", "INACTIVE"


        :return: The lifecycle_state of this ComplianceDocument.
        :rtype: str
        """
        return self._lifecycle_state

    @lifecycle_state.setter
    def lifecycle_state(self, lifecycle_state):
        """
        Sets the lifecycle_state of this ComplianceDocument.
        The current lifecycle state of the compliance document.


        :param lifecycle_state: The lifecycle_state of this ComplianceDocument.
        :type: str
        """
        allowed_values = ["ACTIVE", "INACTIVE"]
        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 document_file_name(self):
        """
        **[Required]** Gets the document_file_name of this ComplianceDocument.
        The file name of the compliance document.


        :return: The document_file_name of this ComplianceDocument.
        :rtype: str
        """
        return self._document_file_name

    @document_file_name.setter
    def document_file_name(self, document_file_name):
        """
        Sets the document_file_name of this ComplianceDocument.
        The file name of the compliance document.


        :param document_file_name: The document_file_name of this ComplianceDocument.
        :type: str
        """
        self._document_file_name = document_file_name

    @property
    def version(self):
        """
        **[Required]** Gets the version of this ComplianceDocument.
        The version number of the compliance document.


        :return: The version of this ComplianceDocument.
        :rtype: int
        """
        return self._version

    @version.setter
    def version(self, version):
        """
        Sets the version of this ComplianceDocument.
        The version number of the compliance document.


        :param version: The version of this ComplianceDocument.
        :type: int
        """
        self._version = version

    @property
    def type(self):
        """
        **[Required]** Gets the type of this ComplianceDocument.
        The type of compliance document. For definitions of supported types of compliance documents, see `Types of Compliance Documents`__.

        __ https://docs.oracle.com/en-us/iaas/Content/ComplianceDocuments/Concepts/compliancedocsoverview.htm#DocTypes


        :return: The type of this ComplianceDocument.
        :rtype: str
        """
        return self._type

    @type.setter
    def type(self, type):
        """
        Sets the type of this ComplianceDocument.
        The type of compliance document. For definitions of supported types of compliance documents, see `Types of Compliance Documents`__.

        __ https://docs.oracle.com/en-us/iaas/Content/ComplianceDocuments/Concepts/compliancedocsoverview.htm#DocTypes


        :param type: The type of this ComplianceDocument.
        :type: str
        """
        self._type = type

    @property
    def platform(self):
        """
        **[Required]** Gets the platform of this ComplianceDocument.
        The information technology infrastructure platform, or set of services, to which the compliance document belongs. A platform
        can also be described as an environment or a business pillar. For definitions of supported environments, see `Types of Environments`__.

        __ https://docs.oracle.com/en-us/iaas/Content/ComplianceDocuments/Concepts/compliancedocsoverview.htm#EnvironmentTypes


        :return: The platform of this ComplianceDocument.
        :rtype: str
        """
        return self._platform

    @platform.setter
    def platform(self, platform):
        """
        Sets the platform of this ComplianceDocument.
        The information technology infrastructure platform, or set of services, to which the compliance document belongs. A platform
        can also be described as an environment or a business pillar. For definitions of supported environments, see `Types of Environments`__.

        __ https://docs.oracle.com/en-us/iaas/Content/ComplianceDocuments/Concepts/compliancedocsoverview.htm#EnvironmentTypes


        :param platform: The platform of this ComplianceDocument.
        :type: str
        """
        self._platform = platform

    @property
    def time_updated(self):
        """
        **[Required]** Gets the time_updated of this ComplianceDocument.
        The date and time the compliance document was last updated, expressed in `RFC 3339`__ timestamp format.

        __ https://tools.ietf.org/html/rfc3339


        :return: The time_updated of this ComplianceDocument.
        :rtype: datetime
        """
        return self._time_updated

    @time_updated.setter
    def time_updated(self, time_updated):
        """
        Sets the time_updated of this ComplianceDocument.
        The date and time the compliance document was last updated, expressed in `RFC 3339`__ timestamp format.

        __ https://tools.ietf.org/html/rfc3339


        :param time_updated: The time_updated of this ComplianceDocument.
        :type: datetime
        """
        self._time_updated = time_updated

    @property
    def saas_service_name(self):
        """
        Gets the saas_service_name of this ComplianceDocument.
        The saas service name to which compliance document belongs. For other types such as 'OCI' / 'PaaS' this value will be null.


        :return: The saas_service_name of this ComplianceDocument.
        :rtype: str
        """
        return self._saas_service_name

    @saas_service_name.setter
    def saas_service_name(self, saas_service_name):
        """
        Sets the saas_service_name of this ComplianceDocument.
        The saas service name to which compliance document belongs. For other types such as 'OCI' / 'PaaS' this value will be null.


        :param saas_service_name: The saas_service_name of this ComplianceDocument.
        :type: str
        """
        self._saas_service_name = saas_service_name

    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
