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

oci/network_load_balancer/models/backend_details.py

@@ -0,0 +1,337 @@
+# 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 BackendDetails(object):
+    """
+    The network network load balancing configuration details of a backend server.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new BackendDetails 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 BackendDetails.
+        :type name: str
+
+        :param ip_address:
+            The value to assign to the ip_address property of this BackendDetails.
+        :type ip_address: str
+
+        :param target_id:
+            The value to assign to the target_id property of this BackendDetails.
+        :type target_id: str
+
+        :param port:
+            The value to assign to the port property of this BackendDetails.
+        :type port: int
+
+        :param weight:
+            The value to assign to the weight property of this BackendDetails.
+        :type weight: int
+
+        :param is_backup:
+            The value to assign to the is_backup property of this BackendDetails.
+        :type is_backup: bool
+
+        :param is_drain:
+            The value to assign to the is_drain property of this BackendDetails.
+        :type is_drain: bool
+
+        :param is_offline:
+            The value to assign to the is_offline property of this BackendDetails.
+        :type is_offline: bool
+
+        """
+        self.swagger_types = {
+            'name': 'str',
+            'ip_address': 'str',
+            'target_id': 'str',
+            'port': 'int',
+            'weight': 'int',
+            'is_backup': 'bool',
+            'is_drain': 'bool',
+            'is_offline': 'bool'
+        }
+
+        self.attribute_map = {
+            'name': 'name',
+            'ip_address': 'ipAddress',
+            'target_id': 'targetId',
+            'port': 'port',
+            'weight': 'weight',
+            'is_backup': 'isBackup',
+            'is_drain': 'isDrain',
+            'is_offline': 'isOffline'
+        }
+
+        self._name = None
+        self._ip_address = None
+        self._target_id = None
+        self._port = None
+        self._weight = None
+        self._is_backup = None
+        self._is_drain = None
+        self._is_offline = None
+
+    @property
+    def name(self):
+        """
+        Gets the name of this BackendDetails.
+        A read-only field showing the IP address/OCID and port that uniquely identify this backend server in the backend set.
+
+        Example: `10.0.0.3:8080`, or `ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>:443` or `10.0.0.3:0`
+
+
+        :return: The name of this BackendDetails.
+        :rtype: str
+        """
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        """
+        Sets the name of this BackendDetails.
+        A read-only field showing the IP address/OCID and port that uniquely identify this backend server in the backend set.
+
+        Example: `10.0.0.3:8080`, or `ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>:443` or `10.0.0.3:0`
+
+
+        :param name: The name of this BackendDetails.
+        :type: str
+        """
+        self._name = name
+
+    @property
+    def ip_address(self):
+        """
+        Gets the ip_address of this BackendDetails.
+        The IP address of the backend server.
+
+        Example: `10.0.0.3`
+
+
+        :return: The ip_address of this BackendDetails.
+        :rtype: str
+        """
+        return self._ip_address
+
+    @ip_address.setter
+    def ip_address(self, ip_address):
+        """
+        Sets the ip_address of this BackendDetails.
+        The IP address of the backend server.
+
+        Example: `10.0.0.3`
+
+
+        :param ip_address: The ip_address of this BackendDetails.
+        :type: str
+        """
+        self._ip_address = ip_address
+
+    @property
+    def target_id(self):
+        """
+        Gets the target_id of this BackendDetails.
+        The IP OCID/Instance OCID associated with the backend server.
+        Example: `ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>`
+
+
+        :return: The target_id of this BackendDetails.
+        :rtype: str
+        """
+        return self._target_id
+
+    @target_id.setter
+    def target_id(self, target_id):
+        """
+        Sets the target_id of this BackendDetails.
+        The IP OCID/Instance OCID associated with the backend server.
+        Example: `ocid1.privateip..oc1.<var>&lt;unique_ID&gt;</var>`
+
+
+        :param target_id: The target_id of this BackendDetails.
+        :type: str
+        """
+        self._target_id = target_id
+
+    @property
+    def port(self):
+        """
+        **[Required]** Gets the port of this BackendDetails.
+        The communication port for the backend server.
+
+        Example: `8080`
+
+
+        :return: The port of this BackendDetails.
+        :rtype: int
+        """
+        return self._port
+
+    @port.setter
+    def port(self, port):
+        """
+        Sets the port of this BackendDetails.
+        The communication port for the backend server.
+
+        Example: `8080`
+
+
+        :param port: The port of this BackendDetails.
+        :type: int
+        """
+        self._port = port
+
+    @property
+    def weight(self):
+        """
+        Gets the weight of this BackendDetails.
+        The network 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 three times the number of new connections
+        as a server weighted '1'.
+        For more information about load balancing policies, see
+        `How Network Load Balancing Policies Work`__.
+
+        Example: `3`
+
+        __ https://docs.cloud.oracle.com/Content/Balance/Reference/lbpolicies.htm
+
+
+        :return: The weight of this BackendDetails.
+        :rtype: int
+        """
+        return self._weight
+
+    @weight.setter
+    def weight(self, weight):
+        """
+        Sets the weight of this BackendDetails.
+        The network 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 three times the number of new connections
+        as a server weighted '1'.
+        For more information about load balancing policies, see
+        `How Network Load Balancing Policies Work`__.
+
+        Example: `3`
+
+        __ https://docs.cloud.oracle.com/Content/Balance/Reference/lbpolicies.htm
+
+
+        :param weight: The weight of this BackendDetails.
+        :type: int
+        """
+        self._weight = weight
+
+    @property
+    def is_backup(self):
+        """
+        Gets the is_backup of this BackendDetails.
+        Whether the network load balancer should treat this server as a backup unit. If `true`, then the network load balancer forwards no ingress
+        traffic to this backend server unless all other backend servers not marked as \"isBackup\" fail the health check policy.
+
+        Example: `false`
+
+
+        :return: The is_backup of this BackendDetails.
+        :rtype: bool
+        """
+        return self._is_backup
+
+    @is_backup.setter
+    def is_backup(self, is_backup):
+        """
+        Sets the is_backup of this BackendDetails.
+        Whether the network load balancer should treat this server as a backup unit. If `true`, then the network load balancer forwards no ingress
+        traffic to this backend server unless all other backend servers not marked as \"isBackup\" fail the health check policy.
+
+        Example: `false`
+
+
+        :param is_backup: The is_backup of this BackendDetails.
+        :type: bool
+        """
+        self._is_backup = is_backup
+
+    @property
+    def is_drain(self):
+        """
+        Gets the is_drain of this BackendDetails.
+        Whether the network load balancer should drain this server. Servers marked \"isDrain\" receive no
+        incoming traffic.
+
+        Example: `false`
+
+
+        :return: The is_drain of this BackendDetails.
+        :rtype: bool
+        """
+        return self._is_drain
+
+    @is_drain.setter
+    def is_drain(self, is_drain):
+        """
+        Sets the is_drain of this BackendDetails.
+        Whether the network load balancer should drain this server. Servers marked \"isDrain\" receive no
+        incoming traffic.
+
+        Example: `false`
+
+
+        :param is_drain: The is_drain of this BackendDetails.
+        :type: bool
+        """
+        self._is_drain = is_drain
+
+    @property
+    def is_offline(self):
+        """
+        Gets the is_offline of this BackendDetails.
+        Whether the network load balancer should treat this server as offline. Offline servers receive no incoming
+        traffic.
+
+        Example: `false`
+
+
+        :return: The is_offline of this BackendDetails.
+        :rtype: bool
+        """
+        return self._is_offline
+
+    @is_offline.setter
+    def is_offline(self, is_offline):
+        """
+        Sets the is_offline of this BackendDetails.
+        Whether the network load balancer should treat this server as offline. Offline servers receive no incoming
+        traffic.
+
+        Example: `false`
+
+
+        :param is_offline: The is_offline of this BackendDetails.
+        :type: bool
+        """
+        self._is_offline = is_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/network_load_balancer/models/backend_health.py

@@ -0,0 +1,145 @@
+# 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 BackendHealth(object):
+    """
+    The health status of the specified backend server.
+    """
+
+    #: 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.network_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.
+
+        *   **OK:**  All health check probes return `OK`
+
+        *   **WARNING:** At least one of the health check probes does not return `OK`
+
+        *   **CRITICAL:** None of the health check probes return `OK`.
+        *
+        *   **UNKNOWN:** One of the health checks probes return `UNKNOWN`,
+        *   or the system is 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.
+
+        *   **OK:**  All health check probes return `OK`
+
+        *   **WARNING:** At least one of the health check probes does not return `OK`
+
+        *   **CRITICAL:** None of the health check probes return `OK`.
+        *
+        *   **UNKNOWN:** One of the health checks probes return `UNKNOWN`,
+        *   or the system is 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.network_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.network_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