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

oci/load_balancer/models/update_backend_details.py

@@ -0,0 +1,242 @@
+# 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 UpdateBackendDetails(object):
+    """
+    The configuration details for updating a backend server.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new UpdateBackendDetails object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param weight:
+            The value to assign to the weight property of this UpdateBackendDetails.
+        :type weight: int
+
+        :param max_connections:
+            The value to assign to the max_connections property of this UpdateBackendDetails.
+        :type max_connections: int
+
+        :param backup:
+            The value to assign to the backup property of this UpdateBackendDetails.
+        :type backup: bool
+
+        :param drain:
+            The value to assign to the drain property of this UpdateBackendDetails.
+        :type drain: bool
+
+        :param offline:
+            The value to assign to the offline property of this UpdateBackendDetails.
+        :type offline: bool
+
+        """
+        self.swagger_types = {
+            'weight': 'int',
+            'max_connections': 'int',
+            'backup': 'bool',
+            'drain': 'bool',
+            'offline': 'bool'
+        }
+
+        self.attribute_map = {
+            'weight': 'weight',
+            'max_connections': 'maxConnections',
+            'backup': 'backup',
+            'drain': 'drain',
+            'offline': 'offline'
+        }
+
+        self._weight = None
+        self._max_connections = None
+        self._backup = None
+        self._drain = None
+        self._offline = None
+
+    @property
+    def weight(self):
+        """
+        **[Required]** Gets the weight of this UpdateBackendDetails.
+        The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger
+        proportion of incoming traffic. For example, a server weighted '3' receives 3 times the number of new connections
+        as a server weighted '1'.
+        For more information on load balancing policies, see
+        `How Load Balancing Policies Work`__.
+
+        Example: `3`
+
+        __ https://docs.cloud.oracle.com/Content/Balance/Reference/lbpolicies.htm
+
+
+        :return: The weight of this UpdateBackendDetails.
+        :rtype: int
+        """
+        return self._weight
+
+    @weight.setter
+    def weight(self, weight):
+        """
+        Sets the weight of this UpdateBackendDetails.
+        The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger
+        proportion of incoming traffic. For example, a server weighted '3' receives 3 times the number of new connections
+        as a server weighted '1'.
+        For more information on load balancing policies, see
+        `How Load Balancing Policies Work`__.
+
+        Example: `3`
+
+        __ https://docs.cloud.oracle.com/Content/Balance/Reference/lbpolicies.htm
+
+
+        :param weight: The weight of this UpdateBackendDetails.
+        :type: int
+        """
+        self._weight = weight
+
+    @property
+    def max_connections(self):
+        """
+        Gets the max_connections of this UpdateBackendDetails.
+        The maximum number of simultaneous connections the load balancer can make to the backend.
+        If this is not set then the maximum number of simultaneous connections the load balancer
+        can make to the backend is unlimited.
+
+        Example: `300`
+
+
+        :return: The max_connections of this UpdateBackendDetails.
+        :rtype: int
+        """
+        return self._max_connections
+
+    @max_connections.setter
+    def max_connections(self, max_connections):
+        """
+        Sets the max_connections of this UpdateBackendDetails.
+        The maximum number of simultaneous connections the load balancer can make to the backend.
+        If this is not set then the maximum number of simultaneous connections the load balancer
+        can make to the backend is unlimited.
+
+        Example: `300`
+
+
+        :param max_connections: The max_connections of this UpdateBackendDetails.
+        :type: int
+        """
+        self._max_connections = max_connections
+
+    @property
+    def backup(self):
+        """
+        **[Required]** Gets the backup of this UpdateBackendDetails.
+        Whether the load balancer should treat this server as a backup unit. If `true`, the load balancer forwards no ingress
+        traffic to this backend server unless all other backend servers not marked as \"backup\" fail the health check policy.
+
+        **Note:** You cannot add a backend server marked as `backup` to a backend set that uses the IP Hash policy.
+
+        Example: `false`
+
+
+        :return: The backup of this UpdateBackendDetails.
+        :rtype: bool
+        """
+        return self._backup
+
+    @backup.setter
+    def backup(self, backup):
+        """
+        Sets the backup of this UpdateBackendDetails.
+        Whether the load balancer should treat this server as a backup unit. If `true`, the load balancer forwards no ingress
+        traffic to this backend server unless all other backend servers not marked as \"backup\" fail the health check policy.
+
+        **Note:** You cannot add a backend server marked as `backup` to a backend set that uses the IP Hash policy.
+
+        Example: `false`
+
+
+        :param backup: The backup of this UpdateBackendDetails.
+        :type: bool
+        """
+        self._backup = backup
+
+    @property
+    def drain(self):
+        """
+        **[Required]** Gets the drain of this UpdateBackendDetails.
+        Whether the load balancer should drain this server. Servers marked \"drain\" receive no new
+        incoming traffic.
+
+        Example: `false`
+
+
+        :return: The drain of this UpdateBackendDetails.
+        :rtype: bool
+        """
+        return self._drain
+
+    @drain.setter
+    def drain(self, drain):
+        """
+        Sets the drain of this UpdateBackendDetails.
+        Whether the load balancer should drain this server. Servers marked \"drain\" receive no new
+        incoming traffic.
+
+        Example: `false`
+
+
+        :param drain: The drain of this UpdateBackendDetails.
+        :type: bool
+        """
+        self._drain = drain
+
+    @property
+    def offline(self):
+        """
+        **[Required]** Gets the offline of this UpdateBackendDetails.
+        Whether the load balancer should treat this server as offline. Offline servers receive no incoming
+        traffic.
+
+        Example: `false`
+
+
+        :return: The offline of this UpdateBackendDetails.
+        :rtype: bool
+        """
+        return self._offline
+
+    @offline.setter
+    def offline(self, offline):
+        """
+        Sets the offline of this UpdateBackendDetails.
+        Whether the load balancer should treat this server as offline. Offline servers receive no incoming
+        traffic.
+
+        Example: `false`
+
+
+        :param offline: The offline of this UpdateBackendDetails.
+        :type: bool
+        """
+        self._offline = offline
+
+    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/update_backend_set_details.py

@@ -0,0 +1,264 @@
+# 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 UpdateBackendSetDetails(object):
+    """
+    The configuration details for updating 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 UpdateBackendSetDetails 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 UpdateBackendSetDetails.
+        :type policy: str
+
+        :param backends:
+            The value to assign to the backends property of this UpdateBackendSetDetails.
+        :type backends: list[oci.load_balancer.models.BackendDetails]
+
+        :param backend_max_connections:
+            The value to assign to the backend_max_connections property of this UpdateBackendSetDetails.
+        :type backend_max_connections: int
+
+        :param health_checker:
+            The value to assign to the health_checker property of this UpdateBackendSetDetails.
+        :type health_checker: oci.load_balancer.models.HealthCheckerDetails
+
+        :param ssl_configuration:
+            The value to assign to the ssl_configuration property of this UpdateBackendSetDetails.
+        :type ssl_configuration: oci.load_balancer.models.SSLConfigurationDetails
+
+        :param session_persistence_configuration:
+            The value to assign to the session_persistence_configuration property of this UpdateBackendSetDetails.
+        :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 UpdateBackendSetDetails.
+        :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 UpdateBackendSetDetails.
+        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 UpdateBackendSetDetails.
+        :rtype: str
+        """
+        return self._policy
+
+    @policy.setter
+    def policy(self, policy):
+        """
+        Sets the policy of this UpdateBackendSetDetails.
+        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 UpdateBackendSetDetails.
+        :type: str
+        """
+        self._policy = policy
+
+    @property
+    def backends(self):
+        """
+        **[Required]** Gets the backends of this UpdateBackendSetDetails.
+
+        :return: The backends of this UpdateBackendSetDetails.
+        :rtype: list[oci.load_balancer.models.BackendDetails]
+        """
+        return self._backends
+
+    @backends.setter
+    def backends(self, backends):
+        """
+        Sets the backends of this UpdateBackendSetDetails.
+
+        :param backends: The backends of this UpdateBackendSetDetails.
+        :type: list[oci.load_balancer.models.BackendDetails]
+        """
+        self._backends = backends
+
+    @property
+    def backend_max_connections(self):
+        """
+        Gets the backend_max_connections of this UpdateBackendSetDetails.
+        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 UpdateBackendSetDetails.
+        :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 UpdateBackendSetDetails.
+        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 UpdateBackendSetDetails.
+        :type: int
+        """
+        self._backend_max_connections = backend_max_connections
+
+    @property
+    def health_checker(self):
+        """
+        **[Required]** Gets the health_checker of this UpdateBackendSetDetails.
+
+        :return: The health_checker of this UpdateBackendSetDetails.
+        :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 UpdateBackendSetDetails.
+
+        :param health_checker: The health_checker of this UpdateBackendSetDetails.
+        :type: oci.load_balancer.models.HealthCheckerDetails
+        """
+        self._health_checker = health_checker
+
+    @property
+    def ssl_configuration(self):
+        """
+        Gets the ssl_configuration of this UpdateBackendSetDetails.
+
+        :return: The ssl_configuration of this UpdateBackendSetDetails.
+        :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 UpdateBackendSetDetails.
+
+        :param ssl_configuration: The ssl_configuration of this UpdateBackendSetDetails.
+        :type: oci.load_balancer.models.SSLConfigurationDetails
+        """
+        self._ssl_configuration = ssl_configuration
+
+    @property
+    def session_persistence_configuration(self):
+        """
+        Gets the session_persistence_configuration of this UpdateBackendSetDetails.
+
+        :return: The session_persistence_configuration of this UpdateBackendSetDetails.
+        :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 UpdateBackendSetDetails.
+
+        :param session_persistence_configuration: The session_persistence_configuration of this UpdateBackendSetDetails.
+        :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 UpdateBackendSetDetails.
+
+        :return: The lb_cookie_session_persistence_configuration of this UpdateBackendSetDetails.
+        :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 UpdateBackendSetDetails.
+
+        :param lb_cookie_session_persistence_configuration: The lb_cookie_session_persistence_configuration of this UpdateBackendSetDetails.
+        :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