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

oci/load_balancer/models/backend_set_details.py

@@ -0,0 +1,262 @@
+# 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: 20170115
+
+
+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 details for a load balancer backend set.
+    For more information on backend set configuration, see
+    `Managing Backend Sets`__.
+
+    **Note:** The `sessionPersistenceConfiguration` (application cookie stickiness) and `lbCookieSessionPersistenceConfiguration`
+    (LB cookie stickiness) attributes are mutually exclusive. To avoid returning an error, configure only one of these two
+    attributes per backend set.
+
+    __ https://docs.cloud.oracle.com/Content/Balance/Tasks/managingbackendsets.htm
+    """
+
+    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.
+        :type policy: str
+
+        :param backends:
+            The value to assign to the backends property of this BackendSetDetails.
+        :type backends: list[oci.load_balancer.models.BackendDetails]
+
+        :param backend_max_connections:
+            The value to assign to the backend_max_connections property of this BackendSetDetails.
+        :type backend_max_connections: int
+
+        :param health_checker:
+            The value to assign to the health_checker property of this BackendSetDetails.
+        :type health_checker: oci.load_balancer.models.HealthCheckerDetails
+
+        :param ssl_configuration:
+            The value to assign to the ssl_configuration property of this BackendSetDetails.
+        :type ssl_configuration: oci.load_balancer.models.SSLConfigurationDetails
+
+        :param session_persistence_configuration:
+            The value to assign to the session_persistence_configuration property of this BackendSetDetails.
+        :type session_persistence_configuration: oci.load_balancer.models.SessionPersistenceConfigurationDetails
+
+        :param lb_cookie_session_persistence_configuration:
+            The value to assign to the lb_cookie_session_persistence_configuration property of this BackendSetDetails.
+        :type lb_cookie_session_persistence_configuration: oci.load_balancer.models.LBCookieSessionPersistenceConfigurationDetails
+
+        """
+        self.swagger_types = {
+            'policy': 'str',
+            'backends': 'list[BackendDetails]',
+            'backend_max_connections': 'int',
+            'health_checker': 'HealthCheckerDetails',
+            'ssl_configuration': 'SSLConfigurationDetails',
+            'session_persistence_configuration': 'SessionPersistenceConfigurationDetails',
+            'lb_cookie_session_persistence_configuration': 'LBCookieSessionPersistenceConfigurationDetails'
+        }
+
+        self.attribute_map = {
+            'policy': 'policy',
+            'backends': 'backends',
+            'backend_max_connections': 'backendMaxConnections',
+            'health_checker': 'healthChecker',
+            'ssl_configuration': 'sslConfiguration',
+            'session_persistence_configuration': 'sessionPersistenceConfiguration',
+            'lb_cookie_session_persistence_configuration': 'lbCookieSessionPersistenceConfiguration'
+        }
+
+        self._policy = None
+        self._backends = None
+        self._backend_max_connections = None
+        self._health_checker = None
+        self._ssl_configuration = None
+        self._session_persistence_configuration = None
+        self._lb_cookie_session_persistence_configuration = None
+
+    @property
+    def policy(self):
+        """
+        **[Required]** Gets the policy of this BackendSetDetails.
+        The load balancer policy for the backend set. To get a list of available policies, use the
+        :func:`list_policies` operation.
+
+        Example: `LEAST_CONNECTIONS`
+
+
+        :return: The policy of this BackendSetDetails.
+        :rtype: str
+        """
+        return self._policy
+
+    @policy.setter
+    def policy(self, policy):
+        """
+        Sets the policy of this BackendSetDetails.
+        The load balancer policy for the backend set. To get a list of available policies, use the
+        :func:`list_policies` operation.
+
+        Example: `LEAST_CONNECTIONS`
+
+
+        :param policy: The policy of this BackendSetDetails.
+        :type: str
+        """
+        self._policy = policy
+
+    @property
+    def backends(self):
+        """
+        Gets the backends of this BackendSetDetails.
+
+        :return: The backends of this BackendSetDetails.
+        :rtype: list[oci.load_balancer.models.BackendDetails]
+        """
+        return self._backends
+
+    @backends.setter
+    def backends(self, backends):
+        """
+        Sets the backends of this BackendSetDetails.
+
+        :param backends: The backends of this BackendSetDetails.
+        :type: list[oci.load_balancer.models.BackendDetails]
+        """
+        self._backends = backends
+
+    @property
+    def backend_max_connections(self):
+        """
+        Gets the backend_max_connections of this BackendSetDetails.
+        The maximum number of simultaneous connections the load balancer can make to any backend
+        in the backend set unless the backend has its own maxConnections setting. If this is not
+        set then the number of simultaneous connections the load balancer can make to any backend
+        in the backend set unless the backend has its own maxConnections setting is unlimited.
+
+        Example: `300`
+
+
+        :return: The backend_max_connections of this BackendSetDetails.
+        :rtype: int
+        """
+        return self._backend_max_connections
+
+    @backend_max_connections.setter
+    def backend_max_connections(self, backend_max_connections):
+        """
+        Sets the backend_max_connections of this BackendSetDetails.
+        The maximum number of simultaneous connections the load balancer can make to any backend
+        in the backend set unless the backend has its own maxConnections setting. If this is not
+        set then the number of simultaneous connections the load balancer can make to any backend
+        in the backend set unless the backend has its own maxConnections setting is unlimited.
+
+        Example: `300`
+
+
+        :param backend_max_connections: The backend_max_connections of this BackendSetDetails.
+        :type: int
+        """
+        self._backend_max_connections = backend_max_connections
+
+    @property
+    def health_checker(self):
+        """
+        **[Required]** Gets the health_checker of this BackendSetDetails.
+
+        :return: The health_checker of this BackendSetDetails.
+        :rtype: oci.load_balancer.models.HealthCheckerDetails
+        """
+        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.load_balancer.models.HealthCheckerDetails
+        """
+        self._health_checker = health_checker
+
+    @property
+    def ssl_configuration(self):
+        """
+        Gets the ssl_configuration of this BackendSetDetails.
+
+        :return: The ssl_configuration of this BackendSetDetails.
+        :rtype: oci.load_balancer.models.SSLConfigurationDetails
+        """
+        return self._ssl_configuration
+
+    @ssl_configuration.setter
+    def ssl_configuration(self, ssl_configuration):
+        """
+        Sets the ssl_configuration of this BackendSetDetails.
+
+        :param ssl_configuration: The ssl_configuration of this BackendSetDetails.
+        :type: oci.load_balancer.models.SSLConfigurationDetails
+        """
+        self._ssl_configuration = ssl_configuration
+
+    @property
+    def session_persistence_configuration(self):
+        """
+        Gets the session_persistence_configuration of this BackendSetDetails.
+
+        :return: The session_persistence_configuration of this BackendSetDetails.
+        :rtype: oci.load_balancer.models.SessionPersistenceConfigurationDetails
+        """
+        return self._session_persistence_configuration
+
+    @session_persistence_configuration.setter
+    def session_persistence_configuration(self, session_persistence_configuration):
+        """
+        Sets the session_persistence_configuration of this BackendSetDetails.
+
+        :param session_persistence_configuration: The session_persistence_configuration of this BackendSetDetails.
+        :type: oci.load_balancer.models.SessionPersistenceConfigurationDetails
+        """
+        self._session_persistence_configuration = session_persistence_configuration
+
+    @property
+    def lb_cookie_session_persistence_configuration(self):
+        """
+        Gets the lb_cookie_session_persistence_configuration of this BackendSetDetails.
+
+        :return: The lb_cookie_session_persistence_configuration of this BackendSetDetails.
+        :rtype: oci.load_balancer.models.LBCookieSessionPersistenceConfigurationDetails
+        """
+        return self._lb_cookie_session_persistence_configuration
+
+    @lb_cookie_session_persistence_configuration.setter
+    def lb_cookie_session_persistence_configuration(self, lb_cookie_session_persistence_configuration):
+        """
+        Sets the lb_cookie_session_persistence_configuration of this BackendSetDetails.
+
+        :param lb_cookie_session_persistence_configuration: The lb_cookie_session_persistence_configuration of this BackendSetDetails.
+        :type: oci.load_balancer.models.LBCookieSessionPersistenceConfigurationDetails
+        """
+        self._lb_cookie_session_persistence_configuration = lb_cookie_session_persistence_configuration
+
+    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/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: 20170115
+
+
+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, they 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 set's backend servers 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 set's backend servers return a status of `OK`.
+
+        *  **UNKNOWN:** More than half of the backend set's backend servers return a status of `UNKNOWN`, the system was
+        unable to retrieve metrics, or the backend set does not have a listener attached.
+
+        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 set's backend servers 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 set's backend servers return a status of `OK`.
+
+        *  **UNKNOWN:** More than half of the backend set's backend servers return a status of `UNKNOWN`, the system was
+        unable to retrieve metrics, or the backend set does not have a listener attached.
+
+
+        :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 and port.
+
+        Example: `10.0.0.3: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 and port.
+
+        Example: `10.0.0.3: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