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

oci/load_balancer/models/backend_health.py

@@ -0,0 +1,143 @@
+# 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 BackendHealth(object):
+    """
+    The health status of the specified backend server as reported by the primary and standby load balancers.
+    """
+
+    #: A constant which can be used with the status property of a BackendHealth.
+    #: This constant has a value of "OK"
+    STATUS_OK = "OK"
+
+    #: A constant which can be used with the status property of a BackendHealth.
+    #: This constant has a value of "WARNING"
+    STATUS_WARNING = "WARNING"
+
+    #: A constant which can be used with the status property of a BackendHealth.
+    #: This constant has a value of "CRITICAL"
+    STATUS_CRITICAL = "CRITICAL"
+
+    #: A constant which can be used with the status property of a BackendHealth.
+    #: This constant has a value of "UNKNOWN"
+    STATUS_UNKNOWN = "UNKNOWN"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new BackendHealth 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 BackendHealth.
+            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 health_check_results:
+            The value to assign to the health_check_results property of this BackendHealth.
+        :type health_check_results: list[oci.load_balancer.models.HealthCheckResult]
+
+        """
+        self.swagger_types = {
+            'status': 'str',
+            'health_check_results': 'list[HealthCheckResult]'
+        }
+
+        self.attribute_map = {
+            'status': 'status',
+            'health_check_results': 'healthCheckResults'
+        }
+
+        self._status = None
+        self._health_check_results = None
+
+    @property
+    def status(self):
+        """
+        **[Required]** Gets the status of this BackendHealth.
+        The general health status of the specified backend server as reported by the primary and standby load balancers.
+
+        *   **OK:** Both health checks returned `OK`.
+
+        *   **WARNING:** One health check returned `OK` and one did not.
+
+        *   **CRITICAL:** Neither health check returned `OK`.
+
+        *   **UNKNOWN:** One or both health checks returned `UNKNOWN`, or the system was unable to retrieve metrics at this time.
+
+        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 BackendHealth.
+        :rtype: str
+        """
+        return self._status
+
+    @status.setter
+    def status(self, status):
+        """
+        Sets the status of this BackendHealth.
+        The general health status of the specified backend server as reported by the primary and standby load balancers.
+
+        *   **OK:** Both health checks returned `OK`.
+
+        *   **WARNING:** One health check returned `OK` and one did not.
+
+        *   **CRITICAL:** Neither health check returned `OK`.
+
+        *   **UNKNOWN:** One or both health checks returned `UNKNOWN`, or the system was unable to retrieve metrics at this time.
+
+
+        :param status: The status of this BackendHealth.
+        :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 health_check_results(self):
+        """
+        **[Required]** Gets the health_check_results of this BackendHealth.
+        A list of the most recent health check results returned for the specified backend server.
+
+
+        :return: The health_check_results of this BackendHealth.
+        :rtype: list[oci.load_balancer.models.HealthCheckResult]
+        """
+        return self._health_check_results
+
+    @health_check_results.setter
+    def health_check_results(self, health_check_results):
+        """
+        Sets the health_check_results of this BackendHealth.
+        A list of the most recent health check results returned for the specified backend server.
+
+
+        :param health_check_results: The health_check_results of this BackendHealth.
+        :type: list[oci.load_balancer.models.HealthCheckResult]
+        """
+        self._health_check_results = health_check_results
+
+    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.py

@@ -0,0 +1,305 @@
+# 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 BackendSet(object):
+    """
+    The configuration of 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.
+
+    **Warning:** 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
+    """
+
+    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.
+        :type policy: str
+
+        :param backends:
+            The value to assign to the backends property of this BackendSet.
+        :type backends: list[oci.load_balancer.models.Backend]
+
+        :param backend_max_connections:
+            The value to assign to the backend_max_connections property of this BackendSet.
+        :type backend_max_connections: int
+
+        :param health_checker:
+            The value to assign to the health_checker property of this BackendSet.
+        :type health_checker: oci.load_balancer.models.HealthChecker
+
+        :param ssl_configuration:
+            The value to assign to the ssl_configuration property of this BackendSet.
+        :type ssl_configuration: oci.load_balancer.models.SSLConfiguration
+
+        :param session_persistence_configuration:
+            The value to assign to the session_persistence_configuration property of this BackendSet.
+        :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 BackendSet.
+        :type lb_cookie_session_persistence_configuration: oci.load_balancer.models.LBCookieSessionPersistenceConfigurationDetails
+
+        """
+        self.swagger_types = {
+            'name': 'str',
+            'policy': 'str',
+            'backends': 'list[Backend]',
+            'backend_max_connections': 'int',
+            'health_checker': 'HealthChecker',
+            'ssl_configuration': 'SSLConfiguration',
+            'session_persistence_configuration': 'SessionPersistenceConfigurationDetails',
+            'lb_cookie_session_persistence_configuration': 'LBCookieSessionPersistenceConfigurationDetails'
+        }
+
+        self.attribute_map = {
+            'name': 'name',
+            '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._name = None
+        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 name(self):
+        """
+        **[Required]** Gets the name of this BackendSet.
+        A friendly name for the backend set. It must be unique and it 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 friendly name for the backend set. It must be unique and it 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):
+        """
+        **[Required]** Gets the policy of this BackendSet.
+        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 BackendSet.
+        :rtype: str
+        """
+        return self._policy
+
+    @policy.setter
+    def policy(self, policy):
+        """
+        Sets the policy of this BackendSet.
+        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 BackendSet.
+        :type: str
+        """
+        self._policy = policy
+
+    @property
+    def backends(self):
+        """
+        **[Required]** Gets the backends of this BackendSet.
+
+        :return: The backends of this BackendSet.
+        :rtype: list[oci.load_balancer.models.Backend]
+        """
+        return self._backends
+
+    @backends.setter
+    def backends(self, backends):
+        """
+        Sets the backends of this BackendSet.
+
+        :param backends: The backends of this BackendSet.
+        :type: list[oci.load_balancer.models.Backend]
+        """
+        self._backends = backends
+
+    @property
+    def backend_max_connections(self):
+        """
+        Gets the backend_max_connections of this BackendSet.
+        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 BackendSet.
+        :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 BackendSet.
+        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 BackendSet.
+        :type: int
+        """
+        self._backend_max_connections = backend_max_connections
+
+    @property
+    def health_checker(self):
+        """
+        **[Required]** Gets the health_checker of this BackendSet.
+
+        :return: The health_checker of this BackendSet.
+        :rtype: oci.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.load_balancer.models.HealthChecker
+        """
+        self._health_checker = health_checker
+
+    @property
+    def ssl_configuration(self):
+        """
+        Gets the ssl_configuration of this BackendSet.
+
+        :return: The ssl_configuration of this BackendSet.
+        :rtype: oci.load_balancer.models.SSLConfiguration
+        """
+        return self._ssl_configuration
+
+    @ssl_configuration.setter
+    def ssl_configuration(self, ssl_configuration):
+        """
+        Sets the ssl_configuration of this BackendSet.
+
+        :param ssl_configuration: The ssl_configuration of this BackendSet.
+        :type: oci.load_balancer.models.SSLConfiguration
+        """
+        self._ssl_configuration = ssl_configuration
+
+    @property
+    def session_persistence_configuration(self):
+        """
+        Gets the session_persistence_configuration of this BackendSet.
+
+        :return: The session_persistence_configuration of this BackendSet.
+        :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 BackendSet.
+
+        :param session_persistence_configuration: The session_persistence_configuration of this BackendSet.
+        :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 BackendSet.
+
+        :return: The lb_cookie_session_persistence_configuration of this BackendSet.
+        :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 BackendSet.
+
+        :param lb_cookie_session_persistence_configuration: The lb_cookie_session_persistence_configuration of this BackendSet.
+        :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