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_summary.py

@@ -0,0 +1,347 @@
+# 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 BackendSetSummary(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 BackendSetSummary.
+    #: 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 BackendSetSummary.
+    #: 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 BackendSetSummary.
+    #: 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 BackendSetSummary.
+    #: This constant has a value of "IPV4"
+    IP_VERSION_IPV4 = "IPV4"
+
+    #: A constant which can be used with the ip_version property of a BackendSetSummary.
+    #: This constant has a value of "IPV6"
+    IP_VERSION_IPV6 = "IPV6"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new BackendSetSummary 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 BackendSetSummary.
+        :type name: str
+
+        :param policy:
+            The value to assign to the policy property of this BackendSetSummary.
+            Allowed values for this property are: "TWO_TUPLE", "THREE_TUPLE", "FIVE_TUPLE", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type policy: str
+
+        :param is_preserve_source:
+            The value to assign to the is_preserve_source property of this BackendSetSummary.
+        :type is_preserve_source: bool
+
+        :param is_fail_open:
+            The value to assign to the is_fail_open property of this BackendSetSummary.
+        :type is_fail_open: bool
+
+        :param is_instant_failover_enabled:
+            The value to assign to the is_instant_failover_enabled property of this BackendSetSummary.
+        :type is_instant_failover_enabled: bool
+
+        :param ip_version:
+            The value to assign to the ip_version property of this BackendSetSummary.
+            Allowed values for this property are: "IPV4", "IPV6", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type ip_version: str
+
+        :param backends:
+            The value to assign to the backends property of this BackendSetSummary.
+        :type backends: list[oci.network_load_balancer.models.Backend]
+
+        :param health_checker:
+            The value to assign to the health_checker property of this BackendSetSummary.
+        :type health_checker: oci.network_load_balancer.models.HealthChecker
+
+        """
+        self.swagger_types = {
+            'name': 'str',
+            'policy': 'str',
+            'is_preserve_source': 'bool',
+            'is_fail_open': 'bool',
+            'is_instant_failover_enabled': 'bool',
+            'ip_version': 'str',
+            'backends': 'list[Backend]',
+            'health_checker': 'HealthChecker'
+        }
+
+        self.attribute_map = {
+            'name': 'name',
+            'policy': 'policy',
+            'is_preserve_source': 'isPreserveSource',
+            'is_fail_open': 'isFailOpen',
+            'is_instant_failover_enabled': 'isInstantFailoverEnabled',
+            'ip_version': 'ipVersion',
+            'backends': 'backends',
+            'health_checker': 'healthChecker'
+        }
+
+        self._name = None
+        self._policy = None
+        self._is_preserve_source = None
+        self._is_fail_open = None
+        self._is_instant_failover_enabled = None
+        self._ip_version = None
+        self._backends = None
+        self._health_checker = None
+
+    @property
+    def name(self):
+        """
+        **[Required]** Gets the name of this BackendSetSummary.
+        A user-friendly name for the backend set that must be unique and 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 BackendSetSummary.
+        :rtype: str
+        """
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        """
+        Sets the name of this BackendSetSummary.
+        A user-friendly name for the backend set that must be unique and 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 BackendSetSummary.
+        :type: str
+        """
+        self._name = name
+
+    @property
+    def policy(self):
+        """
+        **[Required]** Gets the policy of this BackendSetSummary.
+        The network load balancer policy for the backend set.
+
+        Example: `FIVE_TUPLE`
+
+        Allowed values for this property are: "TWO_TUPLE", "THREE_TUPLE", "FIVE_TUPLE", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The policy of this BackendSetSummary.
+        :rtype: str
+        """
+        return self._policy
+
+    @policy.setter
+    def policy(self, policy):
+        """
+        Sets the policy of this BackendSetSummary.
+        The network load balancer policy for the backend set.
+
+        Example: `FIVE_TUPLE`
+
+
+        :param policy: The policy of this BackendSetSummary.
+        :type: str
+        """
+        allowed_values = ["TWO_TUPLE", "THREE_TUPLE", "FIVE_TUPLE"]
+        if not value_allowed_none_or_none_sentinel(policy, allowed_values):
+            policy = 'UNKNOWN_ENUM_VALUE'
+        self._policy = policy
+
+    @property
+    def is_preserve_source(self):
+        """
+        Gets the is_preserve_source of this BackendSetSummary.
+        If this parameter is enabled, the network load balancer preserves the source IP of the packet forwarded to the backend servers.
+        Backend servers see the original source IP. If the `isPreserveSourceDestination` parameter is enabled for the network load balancer resource, this parameter cannot be disabled.
+        The value is true by default.
+
+
+        :return: The is_preserve_source of this BackendSetSummary.
+        :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 BackendSetSummary.
+        If this parameter is enabled, the network load balancer preserves the source IP of the packet forwarded to the backend servers.
+        Backend servers see the original source IP. If the `isPreserveSourceDestination` parameter is enabled for the network load balancer resource, this parameter cannot be disabled.
+        The value is true by default.
+
+
+        :param is_preserve_source: The is_preserve_source of this BackendSetSummary.
+        :type: bool
+        """
+        self._is_preserve_source = is_preserve_source
+
+    @property
+    def is_fail_open(self):
+        """
+        Gets the is_fail_open of this BackendSetSummary.
+        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 BackendSetSummary.
+        :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 BackendSetSummary.
+        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 BackendSetSummary.
+        :type: bool
+        """
+        self._is_fail_open = is_fail_open
+
+    @property
+    def is_instant_failover_enabled(self):
+        """
+        Gets the is_instant_failover_enabled of this BackendSetSummary.
+        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 BackendSetSummary.
+        :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 BackendSetSummary.
+        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 BackendSetSummary.
+        :type: bool
+        """
+        self._is_instant_failover_enabled = is_instant_failover_enabled
+
+    @property
+    def ip_version(self):
+        """
+        Gets the ip_version of this BackendSetSummary.
+        IP version associated with the backend set.
+
+        Allowed values for this property are: "IPV4", "IPV6", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The ip_version of this BackendSetSummary.
+        :rtype: str
+        """
+        return self._ip_version
+
+    @ip_version.setter
+    def ip_version(self, ip_version):
+        """
+        Sets the ip_version of this BackendSetSummary.
+        IP version associated with the backend set.
+
+
+        :param ip_version: The ip_version of this BackendSetSummary.
+        :type: str
+        """
+        allowed_values = ["IPV4", "IPV6"]
+        if not value_allowed_none_or_none_sentinel(ip_version, allowed_values):
+            ip_version = 'UNKNOWN_ENUM_VALUE'
+        self._ip_version = ip_version
+
+    @property
+    def backends(self):
+        """
+        **[Required]** Gets the backends of this BackendSetSummary.
+        An array of backends.
+
+
+        :return: The backends of this BackendSetSummary.
+        :rtype: list[oci.network_load_balancer.models.Backend]
+        """
+        return self._backends
+
+    @backends.setter
+    def backends(self, backends):
+        """
+        Sets the backends of this BackendSetSummary.
+        An array of backends.
+
+
+        :param backends: The backends of this BackendSetSummary.
+        :type: list[oci.network_load_balancer.models.Backend]
+        """
+        self._backends = backends
+
+    @property
+    def health_checker(self):
+        """
+        **[Required]** Gets the health_checker of this BackendSetSummary.
+
+        :return: The health_checker of this BackendSetSummary.
+        :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 BackendSetSummary.
+
+        :param health_checker: The health_checker of this BackendSetSummary.
+        :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_summary.py

@@ -0,0 +1,338 @@
+# 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 BackendSummary(object):
+    """
+    The configuration of a backend server that is a member of a network load balancer backend set.
+    For more information, see `Managing Backend Servers`__.
+
+    __ https://docs.cloud.oracle.com/Content/Balance/Tasks/managingbackendservers.htm
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new BackendSummary 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 BackendSummary.
+        :type name: str
+
+        :param ip_address:
+            The value to assign to the ip_address property of this BackendSummary.
+        :type ip_address: str
+
+        :param target_id:
+            The value to assign to the target_id property of this BackendSummary.
+        :type target_id: str
+
+        :param port:
+            The value to assign to the port property of this BackendSummary.
+        :type port: int
+
+        :param weight:
+            The value to assign to the weight property of this BackendSummary.
+        :type weight: int
+
+        :param is_drain:
+            The value to assign to the is_drain property of this BackendSummary.
+        :type is_drain: bool
+
+        :param is_backup:
+            The value to assign to the is_backup property of this BackendSummary.
+        :type is_backup: bool
+
+        :param is_offline:
+            The value to assign to the is_offline property of this BackendSummary.
+        :type is_offline: bool
+
+        """
+        self.swagger_types = {
+            'name': 'str',
+            'ip_address': 'str',
+            'target_id': 'str',
+            'port': 'int',
+            'weight': 'int',
+            'is_drain': 'bool',
+            'is_backup': 'bool',
+            'is_offline': 'bool'
+        }
+
+        self.attribute_map = {
+            'name': 'name',
+            'ip_address': 'ipAddress',
+            'target_id': 'targetId',
+            'port': 'port',
+            'weight': 'weight',
+            'is_drain': 'isDrain',
+            'is_backup': 'isBackup',
+            'is_offline': 'isOffline'
+        }
+
+        self._name = None
+        self._ip_address = None
+        self._target_id = None
+        self._port = None
+        self._weight = None
+        self._is_drain = None
+        self._is_backup = None
+        self._is_offline = None
+
+    @property
+    def name(self):
+        """
+        Gets the name of this BackendSummary.
+        A read-only field showing the IP address/IP 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 BackendSummary.
+        :rtype: str
+        """
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        """
+        Sets the name of this BackendSummary.
+        A read-only field showing the IP address/IP 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 BackendSummary.
+        :type: str
+        """
+        self._name = name
+
+    @property
+    def ip_address(self):
+        """
+        Gets the ip_address of this BackendSummary.
+        The IP address of the backend server.
+        Example: `10.0.0.3`
+
+
+        :return: The ip_address of this BackendSummary.
+        :rtype: str
+        """
+        return self._ip_address
+
+    @ip_address.setter
+    def ip_address(self, ip_address):
+        """
+        Sets the ip_address of this BackendSummary.
+        The IP address of the backend server.
+        Example: `10.0.0.3`
+
+
+        :param ip_address: The ip_address of this BackendSummary.
+        :type: str
+        """
+        self._ip_address = ip_address
+
+    @property
+    def target_id(self):
+        """
+        Gets the target_id of this BackendSummary.
+        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 BackendSummary.
+        :rtype: str
+        """
+        return self._target_id
+
+    @target_id.setter
+    def target_id(self, target_id):
+        """
+        Sets the target_id of this BackendSummary.
+        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 BackendSummary.
+        :type: str
+        """
+        self._target_id = target_id
+
+    @property
+    def port(self):
+        """
+        **[Required]** Gets the port of this BackendSummary.
+        The communication port for the backend server.
+
+        Example: `8080`
+
+
+        :return: The port of this BackendSummary.
+        :rtype: int
+        """
+        return self._port
+
+    @port.setter
+    def port(self, port):
+        """
+        Sets the port of this BackendSummary.
+        The communication port for the backend server.
+
+        Example: `8080`
+
+
+        :param port: The port of this BackendSummary.
+        :type: int
+        """
+        self._port = port
+
+    @property
+    def weight(self):
+        """
+        Gets the weight of this BackendSummary.
+        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 BackendSummary.
+        :rtype: int
+        """
+        return self._weight
+
+    @weight.setter
+    def weight(self, weight):
+        """
+        Sets the weight of this BackendSummary.
+        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 BackendSummary.
+        :type: int
+        """
+        self._weight = weight
+
+    @property
+    def is_drain(self):
+        """
+        Gets the is_drain of this BackendSummary.
+        Whether the network load balancer should drain this server. Servers marked \"isDrain\" receive no
+        incoming traffic.
+
+        Example: `false`
+
+
+        :return: The is_drain of this BackendSummary.
+        :rtype: bool
+        """
+        return self._is_drain
+
+    @is_drain.setter
+    def is_drain(self, is_drain):
+        """
+        Sets the is_drain of this BackendSummary.
+        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 BackendSummary.
+        :type: bool
+        """
+        self._is_drain = is_drain
+
+    @property
+    def is_backup(self):
+        """
+        Gets the is_backup of this BackendSummary.
+        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 BackendSummary.
+        :rtype: bool
+        """
+        return self._is_backup
+
+    @is_backup.setter
+    def is_backup(self, is_backup):
+        """
+        Sets the is_backup of this BackendSummary.
+        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 BackendSummary.
+        :type: bool
+        """
+        self._is_backup = is_backup
+
+    @property
+    def is_offline(self):
+        """
+        Gets the is_offline of this BackendSummary.
+        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 BackendSummary.
+        :rtype: bool
+        """
+        return self._is_offline
+
+    @is_offline.setter
+    def is_offline(self, is_offline):
+        """
+        Sets the is_offline of this BackendSummary.
+        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 BackendSummary.
+        :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