# coding: utf-8
# Copyright (c) 2016, 2024, 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 MacsecProperties(object):
    """
    Properties used for MACsec (if capable).
    """

    #: A constant which can be used with the state property of a MacsecProperties.
    #: This constant has a value of "ENABLED"
    STATE_ENABLED = "ENABLED"

    #: A constant which can be used with the state property of a MacsecProperties.
    #: This constant has a value of "DISABLED"
    STATE_DISABLED = "DISABLED"

    #: A constant which can be used with the encryption_cipher property of a MacsecProperties.
    #: This constant has a value of "AES128_GCM"
    ENCRYPTION_CIPHER_AES128_GCM = "AES128_GCM"

    #: A constant which can be used with the encryption_cipher property of a MacsecProperties.
    #: This constant has a value of "AES128_GCM_XPN"
    ENCRYPTION_CIPHER_AES128_GCM_XPN = "AES128_GCM_XPN"

    #: A constant which can be used with the encryption_cipher property of a MacsecProperties.
    #: This constant has a value of "AES256_GCM"
    ENCRYPTION_CIPHER_AES256_GCM = "AES256_GCM"

    #: A constant which can be used with the encryption_cipher property of a MacsecProperties.
    #: This constant has a value of "AES256_GCM_XPN"
    ENCRYPTION_CIPHER_AES256_GCM_XPN = "AES256_GCM_XPN"

    def __init__(self, **kwargs):
        """
        Initializes a new MacsecProperties object with values from keyword arguments.
        The following keyword arguments are supported (corresponding to the getters/setters of this class):

        :param state:
            The value to assign to the state property of this MacsecProperties.
            Allowed values for this property are: "ENABLED", "DISABLED", 'UNKNOWN_ENUM_VALUE'.
            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
        :type state: str

        :param primary_key:
            The value to assign to the primary_key property of this MacsecProperties.
        :type primary_key: oci.core.models.MacsecKey

        :param encryption_cipher:
            The value to assign to the encryption_cipher property of this MacsecProperties.
            Allowed values for this property are: "AES128_GCM", "AES128_GCM_XPN", "AES256_GCM", "AES256_GCM_XPN", 'UNKNOWN_ENUM_VALUE'.
            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
        :type encryption_cipher: str

        :param is_unprotected_traffic_allowed:
            The value to assign to the is_unprotected_traffic_allowed property of this MacsecProperties.
        :type is_unprotected_traffic_allowed: bool

        """
        self.swagger_types = {
            'state': 'str',
            'primary_key': 'MacsecKey',
            'encryption_cipher': 'str',
            'is_unprotected_traffic_allowed': 'bool'
        }

        self.attribute_map = {
            'state': 'state',
            'primary_key': 'primaryKey',
            'encryption_cipher': 'encryptionCipher',
            'is_unprotected_traffic_allowed': 'isUnprotectedTrafficAllowed'
        }

        self._state = None
        self._primary_key = None
        self._encryption_cipher = None
        self._is_unprotected_traffic_allowed = None

    @property
    def state(self):
        """
        **[Required]** Gets the state of this MacsecProperties.
        Indicates whether or not MACsec is enabled.

        Allowed values for this property are: "ENABLED", "DISABLED", 'UNKNOWN_ENUM_VALUE'.
        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.


        :return: The state of this MacsecProperties.
        :rtype: str
        """
        return self._state

    @state.setter
    def state(self, state):
        """
        Sets the state of this MacsecProperties.
        Indicates whether or not MACsec is enabled.


        :param state: The state of this MacsecProperties.
        :type: str
        """
        allowed_values = ["ENABLED", "DISABLED"]
        if not value_allowed_none_or_none_sentinel(state, allowed_values):
            state = 'UNKNOWN_ENUM_VALUE'
        self._state = state

    @property
    def primary_key(self):
        """
        Gets the primary_key of this MacsecProperties.

        :return: The primary_key of this MacsecProperties.
        :rtype: oci.core.models.MacsecKey
        """
        return self._primary_key

    @primary_key.setter
    def primary_key(self, primary_key):
        """
        Sets the primary_key of this MacsecProperties.

        :param primary_key: The primary_key of this MacsecProperties.
        :type: oci.core.models.MacsecKey
        """
        self._primary_key = primary_key

    @property
    def encryption_cipher(self):
        """
        Gets the encryption_cipher of this MacsecProperties.
        Type of encryption cipher suite to use for the MACsec connection.

        Allowed values for this property are: "AES128_GCM", "AES128_GCM_XPN", "AES256_GCM", "AES256_GCM_XPN", 'UNKNOWN_ENUM_VALUE'.
        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.


        :return: The encryption_cipher of this MacsecProperties.
        :rtype: str
        """
        return self._encryption_cipher

    @encryption_cipher.setter
    def encryption_cipher(self, encryption_cipher):
        """
        Sets the encryption_cipher of this MacsecProperties.
        Type of encryption cipher suite to use for the MACsec connection.


        :param encryption_cipher: The encryption_cipher of this MacsecProperties.
        :type: str
        """
        allowed_values = ["AES128_GCM", "AES128_GCM_XPN", "AES256_GCM", "AES256_GCM_XPN"]
        if not value_allowed_none_or_none_sentinel(encryption_cipher, allowed_values):
            encryption_cipher = 'UNKNOWN_ENUM_VALUE'
        self._encryption_cipher = encryption_cipher

    @property
    def is_unprotected_traffic_allowed(self):
        """
        Gets the is_unprotected_traffic_allowed of this MacsecProperties.
        Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails.


        :return: The is_unprotected_traffic_allowed of this MacsecProperties.
        :rtype: bool
        """
        return self._is_unprotected_traffic_allowed

    @is_unprotected_traffic_allowed.setter
    def is_unprotected_traffic_allowed(self, is_unprotected_traffic_allowed):
        """
        Sets the is_unprotected_traffic_allowed of this MacsecProperties.
        Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails.


        :param is_unprotected_traffic_allowed: The is_unprotected_traffic_allowed of this MacsecProperties.
        :type: bool
        """
        self._is_unprotected_traffic_allowed = is_unprotected_traffic_allowed

    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
