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

oci/network_load_balancer/models/backend_set_details.py

@@ -0,0 +1,306 @@
+# 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 BackendSetDetails(object):
+    """
+    The configuration of a network load balancer backend set.
+    For more information about backend set configuration, see
+    `Managing Backend Sets`__.
+
+    **Caution:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
+
+    __ https://docs.cloud.oracle.com/Content/Balance/Tasks/managingbackendsets.htm
+    """
+
+    #: A constant which can be used with the policy property of a BackendSetDetails.
+    #: 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 BackendSetDetails.
+    #: 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 BackendSetDetails.
+    #: 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 BackendSetDetails.
+    #: This constant has a value of "IPV4"
+    IP_VERSION_IPV4 = "IPV4"
+
+    #: A constant which can be used with the ip_version property of a BackendSetDetails.
+    #: This constant has a value of "IPV6"
+    IP_VERSION_IPV6 = "IPV6"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new BackendSetDetails object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param policy:
+            The value to assign to the policy property of this BackendSetDetails.
+            Allowed values for this property are: "TWO_TUPLE", "THREE_TUPLE", "FIVE_TUPLE"
+        :type policy: str
+
+        :param ip_version:
+            The value to assign to the ip_version property of this BackendSetDetails.
+            Allowed values for this property are: "IPV4", "IPV6"
+        :type ip_version: str
+
+        :param is_preserve_source:
+            The value to assign to the is_preserve_source property of this BackendSetDetails.
+        :type is_preserve_source: bool
+
+        :param is_fail_open:
+            The value to assign to the is_fail_open property of this BackendSetDetails.
+        :type is_fail_open: bool
+
+        :param is_instant_failover_enabled:
+            The value to assign to the is_instant_failover_enabled property of this BackendSetDetails.
+        :type is_instant_failover_enabled: bool
+
+        :param backends:
+            The value to assign to the backends property of this BackendSetDetails.
+        :type backends: list[oci.network_load_balancer.models.Backend]
+
+        :param health_checker:
+            The value to assign to the health_checker property of this BackendSetDetails.
+        :type health_checker: oci.network_load_balancer.models.HealthChecker
+
+        """
+        self.swagger_types = {
+            'policy': 'str',
+            'ip_version': 'str',
+            'is_preserve_source': 'bool',
+            'is_fail_open': 'bool',
+            'is_instant_failover_enabled': 'bool',
+            'backends': 'list[Backend]',
+            'health_checker': 'HealthChecker'
+        }
+
+        self.attribute_map = {
+            'policy': 'policy',
+            'ip_version': 'ipVersion',
+            'is_preserve_source': 'isPreserveSource',
+            'is_fail_open': 'isFailOpen',
+            'is_instant_failover_enabled': 'isInstantFailoverEnabled',
+            'backends': 'backends',
+            'health_checker': 'healthChecker'
+        }
+
+        self._policy = None
+        self._ip_version = None
+        self._is_preserve_source = None
+        self._is_fail_open = None
+        self._is_instant_failover_enabled = None
+        self._backends = None
+        self._health_checker = None
+
+    @property
+    def policy(self):
+        """
+        Gets the policy of this BackendSetDetails.
+        The network load balancer policy for the backend set.
+
+        Example: `FIVE_TUPLE`
+
+        Allowed values for this property are: "TWO_TUPLE", "THREE_TUPLE", "FIVE_TUPLE"
+
+
+        :return: The policy of this BackendSetDetails.
+        :rtype: str
+        """
+        return self._policy
+
+    @policy.setter
+    def policy(self, policy):
+        """
+        Sets the policy of this BackendSetDetails.
+        The network load balancer policy for the backend set.
+
+        Example: `FIVE_TUPLE`
+
+
+        :param policy: The policy of this BackendSetDetails.
+        :type: str
+        """
+        allowed_values = ["TWO_TUPLE", "THREE_TUPLE", "FIVE_TUPLE"]
+        if not value_allowed_none_or_none_sentinel(policy, allowed_values):
+            raise ValueError(
+                f"Invalid value for `policy`, must be None or one of {allowed_values}"
+            )
+        self._policy = policy
+
+    @property
+    def ip_version(self):
+        """
+        Gets the ip_version of this BackendSetDetails.
+        IP version associated with the backend set.
+
+        Allowed values for this property are: "IPV4", "IPV6"
+
+
+        :return: The ip_version of this BackendSetDetails.
+        :rtype: str
+        """
+        return self._ip_version
+
+    @ip_version.setter
+    def ip_version(self, ip_version):
+        """
+        Sets the ip_version of this BackendSetDetails.
+        IP version associated with the backend set.
+
+
+        :param ip_version: The ip_version of this BackendSetDetails.
+        :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 is_preserve_source(self):
+        """
+        Gets the is_preserve_source of this BackendSetDetails.
+        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 BackendSetDetails.
+        :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 BackendSetDetails.
+        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 BackendSetDetails.
+        :type: bool
+        """
+        self._is_preserve_source = is_preserve_source
+
+    @property
+    def is_fail_open(self):
+        """
+        Gets the is_fail_open of this BackendSetDetails.
+        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 BackendSetDetails.
+        :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 BackendSetDetails.
+        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 BackendSetDetails.
+        :type: bool
+        """
+        self._is_fail_open = is_fail_open
+
+    @property
+    def is_instant_failover_enabled(self):
+        """
+        Gets the is_instant_failover_enabled of this BackendSetDetails.
+        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 BackendSetDetails.
+        :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 BackendSetDetails.
+        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 BackendSetDetails.
+        :type: bool
+        """
+        self._is_instant_failover_enabled = is_instant_failover_enabled
+
+    @property
+    def backends(self):
+        """
+        Gets the backends of this BackendSetDetails.
+        An array of backends.
+
+
+        :return: The backends of this BackendSetDetails.
+        :rtype: list[oci.network_load_balancer.models.Backend]
+        """
+        return self._backends
+
+    @backends.setter
+    def backends(self, backends):
+        """
+        Sets the backends of this BackendSetDetails.
+        An array of backends.
+
+
+        :param backends: The backends of this BackendSetDetails.
+        :type: list[oci.network_load_balancer.models.Backend]
+        """
+        self._backends = backends
+
+    @property
+    def health_checker(self):
+        """
+        **[Required]** Gets the health_checker of this BackendSetDetails.
+
+        :return: The health_checker of this BackendSetDetails.
+        :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 BackendSetDetails.
+
+        :param health_checker: The health_checker of this BackendSetDetails.
+        :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

oci/network_load_balancer/models/backend_set_health.py

@@ -0,0 +1,265 @@
+# 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 BackendSetHealth(object):
+    """
+    The health status details for a backend set.
+
+    This object does not explicitly enumerate backend servers with a status of `OK`. However, the backend sets are included in the
+    `totalBackendCount` sum.
+    """
+
+    #: A constant which can be used with the status property of a BackendSetHealth.
+    #: This constant has a value of "OK"
+    STATUS_OK = "OK"
+
+    #: A constant which can be used with the status property of a BackendSetHealth.
+    #: This constant has a value of "WARNING"
+    STATUS_WARNING = "WARNING"
+
+    #: A constant which can be used with the status property of a BackendSetHealth.
+    #: This constant has a value of "CRITICAL"
+    STATUS_CRITICAL = "CRITICAL"
+
+    #: A constant which can be used with the status property of a BackendSetHealth.
+    #: This constant has a value of "UNKNOWN"
+    STATUS_UNKNOWN = "UNKNOWN"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new BackendSetHealth object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param status:
+            The value to assign to the status property of this BackendSetHealth.
+            Allowed values for this property are: "OK", "WARNING", "CRITICAL", "UNKNOWN", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type status: str
+
+        :param warning_state_backend_names:
+            The value to assign to the warning_state_backend_names property of this BackendSetHealth.
+        :type warning_state_backend_names: list[str]
+
+        :param critical_state_backend_names:
+            The value to assign to the critical_state_backend_names property of this BackendSetHealth.
+        :type critical_state_backend_names: list[str]
+
+        :param unknown_state_backend_names:
+            The value to assign to the unknown_state_backend_names property of this BackendSetHealth.
+        :type unknown_state_backend_names: list[str]
+
+        :param total_backend_count:
+            The value to assign to the total_backend_count property of this BackendSetHealth.
+        :type total_backend_count: int
+
+        """
+        self.swagger_types = {
+            'status': 'str',
+            'warning_state_backend_names': 'list[str]',
+            'critical_state_backend_names': 'list[str]',
+            'unknown_state_backend_names': 'list[str]',
+            'total_backend_count': 'int'
+        }
+
+        self.attribute_map = {
+            'status': 'status',
+            'warning_state_backend_names': 'warningStateBackendNames',
+            'critical_state_backend_names': 'criticalStateBackendNames',
+            'unknown_state_backend_names': 'unknownStateBackendNames',
+            'total_backend_count': 'totalBackendCount'
+        }
+
+        self._status = None
+        self._warning_state_backend_names = None
+        self._critical_state_backend_names = None
+        self._unknown_state_backend_names = None
+        self._total_backend_count = None
+
+    @property
+    def status(self):
+        """
+        **[Required]** Gets the status of this BackendSetHealth.
+        Overall health status of the backend set.
+
+        *  **OK:** All backend servers in the backend set return a status of `OK`.
+
+        *  **WARNING:** Half or more of the backend servers in a backend set return a status of `OK` and at least one backend
+        server returns a status of `WARNING`, `CRITICAL`, or `UNKNOWN`.
+
+        *  **CRITICAL:** Fewer than half of the backend servers in a backend set return a status of `OK`.
+
+        *  **UNKNOWN:** If no probes have yet been sent to the backends, or the system is
+        unable to retrieve metrics from the backends.
+
+        Allowed values for this property are: "OK", "WARNING", "CRITICAL", "UNKNOWN", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The status of this BackendSetHealth.
+        :rtype: str
+        """
+        return self._status
+
+    @status.setter
+    def status(self, status):
+        """
+        Sets the status of this BackendSetHealth.
+        Overall health status of the backend set.
+
+        *  **OK:** All backend servers in the backend set return a status of `OK`.
+
+        *  **WARNING:** Half or more of the backend servers in a backend set return a status of `OK` and at least one backend
+        server returns a status of `WARNING`, `CRITICAL`, or `UNKNOWN`.
+
+        *  **CRITICAL:** Fewer than half of the backend servers in a backend set return a status of `OK`.
+
+        *  **UNKNOWN:** If no probes have yet been sent to the backends, or the system is
+        unable to retrieve metrics from the backends.
+
+
+        :param status: The status of this BackendSetHealth.
+        :type: str
+        """
+        allowed_values = ["OK", "WARNING", "CRITICAL", "UNKNOWN"]
+        if not value_allowed_none_or_none_sentinel(status, allowed_values):
+            status = 'UNKNOWN_ENUM_VALUE'
+        self._status = status
+
+    @property
+    def warning_state_backend_names(self):
+        """
+        **[Required]** Gets the warning_state_backend_names of this BackendSetHealth.
+        A list of backend servers that are currently in the `WARNING` health state. The list identifies each backend server by
+        IP address or OCID and port.
+
+        Example: `10.0.0.3:8080` or `ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>:8080`
+
+
+        :return: The warning_state_backend_names of this BackendSetHealth.
+        :rtype: list[str]
+        """
+        return self._warning_state_backend_names
+
+    @warning_state_backend_names.setter
+    def warning_state_backend_names(self, warning_state_backend_names):
+        """
+        Sets the warning_state_backend_names of this BackendSetHealth.
+        A list of backend servers that are currently in the `WARNING` health state. The list identifies each backend server by
+        IP address or OCID and port.
+
+        Example: `10.0.0.3:8080` or `ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>:8080`
+
+
+        :param warning_state_backend_names: The warning_state_backend_names of this BackendSetHealth.
+        :type: list[str]
+        """
+        self._warning_state_backend_names = warning_state_backend_names
+
+    @property
+    def critical_state_backend_names(self):
+        """
+        **[Required]** Gets the critical_state_backend_names of this BackendSetHealth.
+        A list of backend servers that are currently in the `CRITICAL` health state. The list identifies each backend server by
+        IP address and port.
+
+        Example: `10.0.0.4:8080`
+
+
+        :return: The critical_state_backend_names of this BackendSetHealth.
+        :rtype: list[str]
+        """
+        return self._critical_state_backend_names
+
+    @critical_state_backend_names.setter
+    def critical_state_backend_names(self, critical_state_backend_names):
+        """
+        Sets the critical_state_backend_names of this BackendSetHealth.
+        A list of backend servers that are currently in the `CRITICAL` health state. The list identifies each backend server by
+        IP address and port.
+
+        Example: `10.0.0.4:8080`
+
+
+        :param critical_state_backend_names: The critical_state_backend_names of this BackendSetHealth.
+        :type: list[str]
+        """
+        self._critical_state_backend_names = critical_state_backend_names
+
+    @property
+    def unknown_state_backend_names(self):
+        """
+        **[Required]** Gets the unknown_state_backend_names of this BackendSetHealth.
+        A list of backend servers that are currently in the `UNKNOWN` health state. The list identifies each backend server by
+        IP address and port.
+
+        Example: `10.0.0.5:8080`
+
+
+        :return: The unknown_state_backend_names of this BackendSetHealth.
+        :rtype: list[str]
+        """
+        return self._unknown_state_backend_names
+
+    @unknown_state_backend_names.setter
+    def unknown_state_backend_names(self, unknown_state_backend_names):
+        """
+        Sets the unknown_state_backend_names of this BackendSetHealth.
+        A list of backend servers that are currently in the `UNKNOWN` health state. The list identifies each backend server by
+        IP address and port.
+
+        Example: `10.0.0.5:8080`
+
+
+        :param unknown_state_backend_names: The unknown_state_backend_names of this BackendSetHealth.
+        :type: list[str]
+        """
+        self._unknown_state_backend_names = unknown_state_backend_names
+
+    @property
+    def total_backend_count(self):
+        """
+        **[Required]** Gets the total_backend_count of this BackendSetHealth.
+        The total number of backend servers in this backend set.
+
+        Example: `7`
+
+
+        :return: The total_backend_count of this BackendSetHealth.
+        :rtype: int
+        """
+        return self._total_backend_count
+
+    @total_backend_count.setter
+    def total_backend_count(self, total_backend_count):
+        """
+        Sets the total_backend_count of this BackendSetHealth.
+        The total number of backend servers in this backend set.
+
+        Example: `7`
+
+
+        :param total_backend_count: The total_backend_count of this BackendSetHealth.
+        :type: int
+        """
+        self._total_backend_count = total_backend_count
+
+    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