# 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: 20200501


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 BackendSet(object):
    """
    The configuration of a network load balancer backend set.
    For more information about backend set configuration, see
    `Backend Sets for Network Load Balancers`__.

    **Caution:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

    __ https://docs.cloud.oracle.com/Content/NetworkLoadBalancer/BackendSets/backend-set-management.htm
    """

    #: A constant which can be used with the policy property of a BackendSet.
    #: This constant has a value of "TWO_TUPLE"
    POLICY_TWO_TUPLE = "TWO_TUPLE"

    #: A constant which can be used with the policy property of a BackendSet.
    #: This constant has a value of "THREE_TUPLE"
    POLICY_THREE_TUPLE = "THREE_TUPLE"

    #: A constant which can be used with the policy property of a BackendSet.
    #: This constant has a value of "FIVE_TUPLE"
    POLICY_FIVE_TUPLE = "FIVE_TUPLE"

    #: A constant which can be used with the ip_version property of a BackendSet.
    #: This constant has a value of "IPV4"
    IP_VERSION_IPV4 = "IPV4"

    #: A constant which can be used with the ip_version property of a BackendSet.
    #: This constant has a value of "IPV6"
    IP_VERSION_IPV6 = "IPV6"

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

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

        :param policy:
            The value to assign to the policy property of this BackendSet.
            Allowed values for this property are: "TWO_TUPLE", "THREE_TUPLE", "FIVE_TUPLE", 'UNKNOWN_ENUM_VALUE'.
            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
        :type policy: str

        :param is_preserve_source:
            The value to assign to the is_preserve_source property of this BackendSet.
        :type is_preserve_source: bool

        :param is_fail_open:
            The value to assign to the is_fail_open property of this BackendSet.
        :type is_fail_open: bool

        :param is_instant_failover_enabled:
            The value to assign to the is_instant_failover_enabled property of this BackendSet.
        :type is_instant_failover_enabled: bool

        :param is_instant_failover_tcp_reset_enabled:
            The value to assign to the is_instant_failover_tcp_reset_enabled property of this BackendSet.
        :type is_instant_failover_tcp_reset_enabled: bool

        :param are_operationally_active_backends_preferred:
            The value to assign to the are_operationally_active_backends_preferred property of this BackendSet.
        :type are_operationally_active_backends_preferred: bool

        :param ip_version:
            The value to assign to the ip_version property of this BackendSet.
            Allowed values for this property are: "IPV4", "IPV6", 'UNKNOWN_ENUM_VALUE'.
            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
        :type ip_version: str

        :param backends:
            The value to assign to the backends property of this BackendSet.
        :type backends: list[oci.network_load_balancer.models.Backend]

        :param health_checker:
            The value to assign to the health_checker property of this BackendSet.
        :type health_checker: oci.network_load_balancer.models.HealthChecker

        """
        self.swagger_types = {
            'name': 'str',
            'policy': 'str',
            'is_preserve_source': 'bool',
            'is_fail_open': 'bool',
            'is_instant_failover_enabled': 'bool',
            'is_instant_failover_tcp_reset_enabled': 'bool',
            'are_operationally_active_backends_preferred': 'bool',
            'ip_version': 'str',
            'backends': 'list[Backend]',
            'health_checker': 'HealthChecker'
        }
        self.attribute_map = {
            'name': 'name',
            'policy': 'policy',
            'is_preserve_source': 'isPreserveSource',
            'is_fail_open': 'isFailOpen',
            'is_instant_failover_enabled': 'isInstantFailoverEnabled',
            'is_instant_failover_tcp_reset_enabled': 'isInstantFailoverTcpResetEnabled',
            'are_operationally_active_backends_preferred': 'areOperationallyActiveBackendsPreferred',
            'ip_version': 'ipVersion',
            'backends': 'backends',
            'health_checker': 'healthChecker'
        }
        self._name = None
        self._policy = None
        self._is_preserve_source = None
        self._is_fail_open = None
        self._is_instant_failover_enabled = None
        self._is_instant_failover_tcp_reset_enabled = None
        self._are_operationally_active_backends_preferred = None
        self._ip_version = None
        self._backends = None
        self._health_checker = None

    @property
    def name(self):
        """
        **[Required]** Gets the name of this BackendSet.
        A user-friendly name for the backend set that must be unique and cannot be changed.

        Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot
        contain spaces. Avoid entering confidential information.

        Example: `example_backend_set`


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

    @name.setter
    def name(self, name):
        """
        Sets the name of this BackendSet.
        A user-friendly name for the backend set that must be unique and cannot be changed.

        Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot
        contain spaces. Avoid entering confidential information.

        Example: `example_backend_set`


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

    @property
    def policy(self):
        """
        Gets the policy of this BackendSet.
        The network load balancer policy for the backend set.

        Example: `FIVE_TUPLE`

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


        :return: The policy of this BackendSet.
        :rtype: str
        """
        return self._policy

    @policy.setter
    def policy(self, policy):
        """
        Sets the policy of this BackendSet.
        The network load balancer policy for the backend set.

        Example: `FIVE_TUPLE`


        :param policy: The policy of this BackendSet.
        :type: str
        """
        allowed_values = ["TWO_TUPLE", "THREE_TUPLE", "FIVE_TUPLE"]
        if not value_allowed_none_or_none_sentinel(policy, allowed_values):
            policy = 'UNKNOWN_ENUM_VALUE'
        self._policy = policy

    @property
    def is_preserve_source(self):
        """
        Gets the is_preserve_source of this BackendSet.
        If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends.
        Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled.
        The value is true by default.


        :return: The is_preserve_source of this BackendSet.
        :rtype: bool
        """
        return self._is_preserve_source

    @is_preserve_source.setter
    def is_preserve_source(self, is_preserve_source):
        """
        Sets the is_preserve_source of this BackendSet.
        If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends.
        Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled.
        The value is true by default.


        :param is_preserve_source: The is_preserve_source of this BackendSet.
        :type: bool
        """
        self._is_preserve_source = is_preserve_source

    @property
    def is_fail_open(self):
        """
        Gets the is_fail_open of this BackendSet.
        If enabled, the network load balancer will continue to distribute traffic in the configured distribution in the event all backends are unhealthy.
        The value is false by default.


        :return: The is_fail_open of this BackendSet.
        :rtype: bool
        """
        return self._is_fail_open

    @is_fail_open.setter
    def is_fail_open(self, is_fail_open):
        """
        Sets the is_fail_open of this BackendSet.
        If enabled, the network load balancer will continue to distribute traffic in the configured distribution in the event all backends are unhealthy.
        The value is false by default.


        :param is_fail_open: The is_fail_open of this BackendSet.
        :type: bool
        """
        self._is_fail_open = is_fail_open

    @property
    def is_instant_failover_enabled(self):
        """
        Gets the is_instant_failover_enabled of this BackendSet.
        If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.


        :return: The is_instant_failover_enabled of this BackendSet.
        :rtype: bool
        """
        return self._is_instant_failover_enabled

    @is_instant_failover_enabled.setter
    def is_instant_failover_enabled(self, is_instant_failover_enabled):
        """
        Sets the is_instant_failover_enabled of this BackendSet.
        If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.


        :param is_instant_failover_enabled: The is_instant_failover_enabled of this BackendSet.
        :type: bool
        """
        self._is_instant_failover_enabled = is_instant_failover_enabled

    @property
    def is_instant_failover_tcp_reset_enabled(self):
        """
        Gets the is_instant_failover_tcp_reset_enabled of this BackendSet.
        If enabled along with instant failover, the network load balancer will send TCP RST to the clients for the existing connections instead of failing over to a healthy backend. This only applies when using the instant failover. By default, TCP RST is enabled.


        :return: The is_instant_failover_tcp_reset_enabled of this BackendSet.
        :rtype: bool
        """
        return self._is_instant_failover_tcp_reset_enabled

    @is_instant_failover_tcp_reset_enabled.setter
    def is_instant_failover_tcp_reset_enabled(self, is_instant_failover_tcp_reset_enabled):
        """
        Sets the is_instant_failover_tcp_reset_enabled of this BackendSet.
        If enabled along with instant failover, the network load balancer will send TCP RST to the clients for the existing connections instead of failing over to a healthy backend. This only applies when using the instant failover. By default, TCP RST is enabled.


        :param is_instant_failover_tcp_reset_enabled: The is_instant_failover_tcp_reset_enabled of this BackendSet.
        :type: bool
        """
        self._is_instant_failover_tcp_reset_enabled = is_instant_failover_tcp_reset_enabled

    @property
    def are_operationally_active_backends_preferred(self):
        """
        Gets the are_operationally_active_backends_preferred of this BackendSet.
        If enabled, NLB supports active-standby backends. The standby backend takes over the traffic when the active node fails, and continues to serve the traffic even when the old active node is back healthy.


        :return: The are_operationally_active_backends_preferred of this BackendSet.
        :rtype: bool
        """
        return self._are_operationally_active_backends_preferred

    @are_operationally_active_backends_preferred.setter
    def are_operationally_active_backends_preferred(self, are_operationally_active_backends_preferred):
        """
        Sets the are_operationally_active_backends_preferred of this BackendSet.
        If enabled, NLB supports active-standby backends. The standby backend takes over the traffic when the active node fails, and continues to serve the traffic even when the old active node is back healthy.


        :param are_operationally_active_backends_preferred: The are_operationally_active_backends_preferred of this BackendSet.
        :type: bool
        """
        self._are_operationally_active_backends_preferred = are_operationally_active_backends_preferred

    @property
    def ip_version(self):
        """
        Gets the ip_version of this BackendSet.
        IP version associated with the backend set.

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


        :return: The ip_version of this BackendSet.
        :rtype: str
        """
        return self._ip_version

    @ip_version.setter
    def ip_version(self, ip_version):
        """
        Sets the ip_version of this BackendSet.
        IP version associated with the backend set.


        :param ip_version: The ip_version of this BackendSet.
        :type: str
        """
        allowed_values = ["IPV4", "IPV6"]
        if not value_allowed_none_or_none_sentinel(ip_version, allowed_values):
            ip_version = 'UNKNOWN_ENUM_VALUE'
        self._ip_version = ip_version

    @property
    def backends(self):
        """
        Gets the backends of this BackendSet.
        An array of backends.


        :return: The backends of this BackendSet.
        :rtype: list[oci.network_load_balancer.models.Backend]
        """
        return self._backends

    @backends.setter
    def backends(self, backends):
        """
        Sets the backends of this BackendSet.
        An array of backends.


        :param backends: The backends of this BackendSet.
        :type: list[oci.network_load_balancer.models.Backend]
        """
        self._backends = backends

    @property
    def health_checker(self):
        """
        **[Required]** Gets the health_checker of this BackendSet.

        :return: The health_checker of this BackendSet.
        :rtype: oci.network_load_balancer.models.HealthChecker
        """
        return self._health_checker

    @health_checker.setter
    def health_checker(self, health_checker):
        """
        Sets the health_checker of this BackendSet.

        :param health_checker: The health_checker of this BackendSet.
        :type: oci.network_load_balancer.models.HealthChecker
        """
        self._health_checker = health_checker

    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