mv-oci-sdk 2.142.0__py3-none-any.whl → 2.142.0.2__py3-none-any.whl

oci/network_load_balancer/models/listener_details.py

@@ -0,0 +1,396 @@
+# 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 ListenerDetails(object):
+    """
+    The listener's configuration.
+    For more information about backend set configuration, see
+    `Managing Load Balancer Listeners`__.
+
+    __ https://docs.cloud.oracle.com/Content/Balance/Tasks/managinglisteners.htm
+    """
+
+    #: A constant which can be used with the ip_version property of a ListenerDetails.
+    #: This constant has a value of "IPV4"
+    IP_VERSION_IPV4 = "IPV4"
+
+    #: A constant which can be used with the ip_version property of a ListenerDetails.
+    #: This constant has a value of "IPV6"
+    IP_VERSION_IPV6 = "IPV6"
+
+    #: A constant which can be used with the protocol property of a ListenerDetails.
+    #: This constant has a value of "ANY"
+    PROTOCOL_ANY = "ANY"
+
+    #: A constant which can be used with the protocol property of a ListenerDetails.
+    #: This constant has a value of "TCP"
+    PROTOCOL_TCP = "TCP"
+
+    #: A constant which can be used with the protocol property of a ListenerDetails.
+    #: This constant has a value of "UDP"
+    PROTOCOL_UDP = "UDP"
+
+    #: A constant which can be used with the protocol property of a ListenerDetails.
+    #: This constant has a value of "TCP_AND_UDP"
+    PROTOCOL_TCP_AND_UDP = "TCP_AND_UDP"
+
+    #: A constant which can be used with the protocol property of a ListenerDetails.
+    #: This constant has a value of "L3IP"
+    PROTOCOL_L3_IP = "L3IP"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new ListenerDetails 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 ListenerDetails.
+        :type name: str
+
+        :param default_backend_set_name:
+            The value to assign to the default_backend_set_name property of this ListenerDetails.
+        :type default_backend_set_name: str
+
+        :param ip_version:
+            The value to assign to the ip_version property of this ListenerDetails.
+            Allowed values for this property are: "IPV4", "IPV6"
+        :type ip_version: str
+
+        :param port:
+            The value to assign to the port property of this ListenerDetails.
+        :type port: int
+
+        :param protocol:
+            The value to assign to the protocol property of this ListenerDetails.
+            Allowed values for this property are: "ANY", "TCP", "UDP", "TCP_AND_UDP", "L3IP"
+        :type protocol: str
+
+        :param is_ppv2_enabled:
+            The value to assign to the is_ppv2_enabled property of this ListenerDetails.
+        :type is_ppv2_enabled: bool
+
+        :param tcp_idle_timeout:
+            The value to assign to the tcp_idle_timeout property of this ListenerDetails.
+        :type tcp_idle_timeout: int
+
+        :param udp_idle_timeout:
+            The value to assign to the udp_idle_timeout property of this ListenerDetails.
+        :type udp_idle_timeout: int
+
+        :param l3_ip_idle_timeout:
+            The value to assign to the l3_ip_idle_timeout property of this ListenerDetails.
+        :type l3_ip_idle_timeout: int
+
+        """
+        self.swagger_types = {
+            'name': 'str',
+            'default_backend_set_name': 'str',
+            'ip_version': 'str',
+            'port': 'int',
+            'protocol': 'str',
+            'is_ppv2_enabled': 'bool',
+            'tcp_idle_timeout': 'int',
+            'udp_idle_timeout': 'int',
+            'l3_ip_idle_timeout': 'int'
+        }
+
+        self.attribute_map = {
+            'name': 'name',
+            'default_backend_set_name': 'defaultBackendSetName',
+            'ip_version': 'ipVersion',
+            'port': 'port',
+            'protocol': 'protocol',
+            'is_ppv2_enabled': 'isPpv2Enabled',
+            'tcp_idle_timeout': 'tcpIdleTimeout',
+            'udp_idle_timeout': 'udpIdleTimeout',
+            'l3_ip_idle_timeout': 'l3IpIdleTimeout'
+        }
+
+        self._name = None
+        self._default_backend_set_name = None
+        self._ip_version = None
+        self._port = None
+        self._protocol = None
+        self._is_ppv2_enabled = None
+        self._tcp_idle_timeout = None
+        self._udp_idle_timeout = None
+        self._l3_ip_idle_timeout = None
+
+    @property
+    def name(self):
+        """
+        **[Required]** Gets the name of this ListenerDetails.
+        A friendly name for the listener. It must be unique and it cannot be changed.
+
+        Example: `example_listener`
+
+
+        :return: The name of this ListenerDetails.
+        :rtype: str
+        """
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        """
+        Sets the name of this ListenerDetails.
+        A friendly name for the listener. It must be unique and it cannot be changed.
+
+        Example: `example_listener`
+
+
+        :param name: The name of this ListenerDetails.
+        :type: str
+        """
+        self._name = name
+
+    @property
+    def default_backend_set_name(self):
+        """
+        **[Required]** Gets the default_backend_set_name of this ListenerDetails.
+        The name of the associated backend set.
+
+        Example: `example_backend_set`
+
+
+        :return: The default_backend_set_name of this ListenerDetails.
+        :rtype: str
+        """
+        return self._default_backend_set_name
+
+    @default_backend_set_name.setter
+    def default_backend_set_name(self, default_backend_set_name):
+        """
+        Sets the default_backend_set_name of this ListenerDetails.
+        The name of the associated backend set.
+
+        Example: `example_backend_set`
+
+
+        :param default_backend_set_name: The default_backend_set_name of this ListenerDetails.
+        :type: str
+        """
+        self._default_backend_set_name = default_backend_set_name
+
+    @property
+    def ip_version(self):
+        """
+        Gets the ip_version of this ListenerDetails.
+        IP version associated with the listener.
+
+        Allowed values for this property are: "IPV4", "IPV6"
+
+
+        :return: The ip_version of this ListenerDetails.
+        :rtype: str
+        """
+        return self._ip_version
+
+    @ip_version.setter
+    def ip_version(self, ip_version):
+        """
+        Sets the ip_version of this ListenerDetails.
+        IP version associated with the listener.
+
+
+        :param ip_version: The ip_version of this ListenerDetails.
+        :type: str
+        """
+        allowed_values = ["IPV4", "IPV6"]
+        if not value_allowed_none_or_none_sentinel(ip_version, allowed_values):
+            raise ValueError(
+                f"Invalid value for `ip_version`, must be None or one of {allowed_values}"
+            )
+        self._ip_version = ip_version
+
+    @property
+    def port(self):
+        """
+        **[Required]** Gets the port of this ListenerDetails.
+        The communication port for the listener.
+
+        Example: `80`
+
+
+        :return: The port of this ListenerDetails.
+        :rtype: int
+        """
+        return self._port
+
+    @port.setter
+    def port(self, port):
+        """
+        Sets the port of this ListenerDetails.
+        The communication port for the listener.
+
+        Example: `80`
+
+
+        :param port: The port of this ListenerDetails.
+        :type: int
+        """
+        self._port = port
+
+    @property
+    def protocol(self):
+        """
+        **[Required]** Gets the protocol of this ListenerDetails.
+        The protocol on which the listener accepts connection requests.
+        For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port.
+        For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true).
+        \"ListNetworkLoadBalancersProtocols\" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead.
+
+        Example: `TCP`
+
+        Allowed values for this property are: "ANY", "TCP", "UDP", "TCP_AND_UDP", "L3IP"
+
+
+        :return: The protocol of this ListenerDetails.
+        :rtype: str
+        """
+        return self._protocol
+
+    @protocol.setter
+    def protocol(self, protocol):
+        """
+        Sets the protocol of this ListenerDetails.
+        The protocol on which the listener accepts connection requests.
+        For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port.
+        For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true).
+        \"ListNetworkLoadBalancersProtocols\" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead.
+
+        Example: `TCP`
+
+
+        :param protocol: The protocol of this ListenerDetails.
+        :type: str
+        """
+        allowed_values = ["ANY", "TCP", "UDP", "TCP_AND_UDP", "L3IP"]
+        if not value_allowed_none_or_none_sentinel(protocol, allowed_values):
+            raise ValueError(
+                f"Invalid value for `protocol`, must be None or one of {allowed_values}"
+            )
+        self._protocol = protocol
+
+    @property
+    def is_ppv2_enabled(self):
+        """
+        Gets the is_ppv2_enabled of this ListenerDetails.
+        Property to enable/disable PPv2 feature for this listener.
+
+
+        :return: The is_ppv2_enabled of this ListenerDetails.
+        :rtype: bool
+        """
+        return self._is_ppv2_enabled
+
+    @is_ppv2_enabled.setter
+    def is_ppv2_enabled(self, is_ppv2_enabled):
+        """
+        Sets the is_ppv2_enabled of this ListenerDetails.
+        Property to enable/disable PPv2 feature for this listener.
+
+
+        :param is_ppv2_enabled: The is_ppv2_enabled of this ListenerDetails.
+        :type: bool
+        """
+        self._is_ppv2_enabled = is_ppv2_enabled
+
+    @property
+    def tcp_idle_timeout(self):
+        """
+        Gets the tcp_idle_timeout of this ListenerDetails.
+        The duration for TCP idle timeout in seconds.
+        Example: `300`
+
+
+        :return: The tcp_idle_timeout of this ListenerDetails.
+        :rtype: int
+        """
+        return self._tcp_idle_timeout
+
+    @tcp_idle_timeout.setter
+    def tcp_idle_timeout(self, tcp_idle_timeout):
+        """
+        Sets the tcp_idle_timeout of this ListenerDetails.
+        The duration for TCP idle timeout in seconds.
+        Example: `300`
+
+
+        :param tcp_idle_timeout: The tcp_idle_timeout of this ListenerDetails.
+        :type: int
+        """
+        self._tcp_idle_timeout = tcp_idle_timeout
+
+    @property
+    def udp_idle_timeout(self):
+        """
+        Gets the udp_idle_timeout of this ListenerDetails.
+        The duration for UDP idle timeout in seconds.
+        Example: `120`
+
+
+        :return: The udp_idle_timeout of this ListenerDetails.
+        :rtype: int
+        """
+        return self._udp_idle_timeout
+
+    @udp_idle_timeout.setter
+    def udp_idle_timeout(self, udp_idle_timeout):
+        """
+        Sets the udp_idle_timeout of this ListenerDetails.
+        The duration for UDP idle timeout in seconds.
+        Example: `120`
+
+
+        :param udp_idle_timeout: The udp_idle_timeout of this ListenerDetails.
+        :type: int
+        """
+        self._udp_idle_timeout = udp_idle_timeout
+
+    @property
+    def l3_ip_idle_timeout(self):
+        """
+        Gets the l3_ip_idle_timeout of this ListenerDetails.
+        The duration for L3IP idle timeout in seconds.
+        Example: `200`
+
+
+        :return: The l3_ip_idle_timeout of this ListenerDetails.
+        :rtype: int
+        """
+        return self._l3_ip_idle_timeout
+
+    @l3_ip_idle_timeout.setter
+    def l3_ip_idle_timeout(self, l3_ip_idle_timeout):
+        """
+        Sets the l3_ip_idle_timeout of this ListenerDetails.
+        The duration for L3IP idle timeout in seconds.
+        Example: `200`
+
+
+        :param l3_ip_idle_timeout: The l3_ip_idle_timeout of this ListenerDetails.
+        :type: int
+        """
+        self._l3_ip_idle_timeout = l3_ip_idle_timeout
+
+    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