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

oci/load_balancer/models/load_balancer_health.py

@@ -0,0 +1,281 @@
+# 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 LoadBalancerHealth(object):
+    """
+    The health status details for the specified load balancer.
+
+    This object does not explicitly enumerate backend sets with a status of `OK`. However, they are included in the
+    `totalBackendSetCount` sum.
+    """
+
+    #: A constant which can be used with the status property of a LoadBalancerHealth.
+    #: This constant has a value of "OK"
+    STATUS_OK = "OK"
+
+    #: A constant which can be used with the status property of a LoadBalancerHealth.
+    #: This constant has a value of "WARNING"
+    STATUS_WARNING = "WARNING"
+
+    #: A constant which can be used with the status property of a LoadBalancerHealth.
+    #: This constant has a value of "CRITICAL"
+    STATUS_CRITICAL = "CRITICAL"
+
+    #: A constant which can be used with the status property of a LoadBalancerHealth.
+    #: This constant has a value of "UNKNOWN"
+    STATUS_UNKNOWN = "UNKNOWN"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new LoadBalancerHealth 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 LoadBalancerHealth.
+            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_set_names:
+            The value to assign to the warning_state_backend_set_names property of this LoadBalancerHealth.
+        :type warning_state_backend_set_names: list[str]
+
+        :param critical_state_backend_set_names:
+            The value to assign to the critical_state_backend_set_names property of this LoadBalancerHealth.
+        :type critical_state_backend_set_names: list[str]
+
+        :param unknown_state_backend_set_names:
+            The value to assign to the unknown_state_backend_set_names property of this LoadBalancerHealth.
+        :type unknown_state_backend_set_names: list[str]
+
+        :param total_backend_set_count:
+            The value to assign to the total_backend_set_count property of this LoadBalancerHealth.
+        :type total_backend_set_count: int
+
+        """
+        self.swagger_types = {
+            'status': 'str',
+            'warning_state_backend_set_names': 'list[str]',
+            'critical_state_backend_set_names': 'list[str]',
+            'unknown_state_backend_set_names': 'list[str]',
+            'total_backend_set_count': 'int'
+        }
+
+        self.attribute_map = {
+            'status': 'status',
+            'warning_state_backend_set_names': 'warningStateBackendSetNames',
+            'critical_state_backend_set_names': 'criticalStateBackendSetNames',
+            'unknown_state_backend_set_names': 'unknownStateBackendSetNames',
+            'total_backend_set_count': 'totalBackendSetCount'
+        }
+
+        self._status = None
+        self._warning_state_backend_set_names = None
+        self._critical_state_backend_set_names = None
+        self._unknown_state_backend_set_names = None
+        self._total_backend_set_count = None
+
+    @property
+    def status(self):
+        """
+        **[Required]** Gets the status of this LoadBalancerHealth.
+        The overall health status of the load balancer.
+
+        *  **OK:** All backend sets associated with the load balancer return a status of `OK`.
+
+        *  **WARNING:** At least one of the backend sets associated with the load balancer returns a status of `WARNING`,
+        no backend sets return a status of `CRITICAL`, and the load balancer life cycle state is `ACTIVE`.
+
+        *  **CRITICAL:** One or more of the backend sets associated with the load balancer return a status of `CRITICAL`.
+
+        *  **UNKNOWN:** If any one of the following conditions is true:
+
+            *  The load balancer life cycle state is not `ACTIVE`.
+
+            *  No backend sets are defined for the load balancer.
+
+            *  More than half of the backend sets associated with the load balancer return a status of `UNKNOWN`, none of the backend
+               sets return a status of `WARNING` or `CRITICAL`, and the load balancer life cycle state is `ACTIVE`.
+
+            *  The system could not retrieve metrics for any reason.
+
+        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 LoadBalancerHealth.
+        :rtype: str
+        """
+        return self._status
+
+    @status.setter
+    def status(self, status):
+        """
+        Sets the status of this LoadBalancerHealth.
+        The overall health status of the load balancer.
+
+        *  **OK:** All backend sets associated with the load balancer return a status of `OK`.
+
+        *  **WARNING:** At least one of the backend sets associated with the load balancer returns a status of `WARNING`,
+        no backend sets return a status of `CRITICAL`, and the load balancer life cycle state is `ACTIVE`.
+
+        *  **CRITICAL:** One or more of the backend sets associated with the load balancer return a status of `CRITICAL`.
+
+        *  **UNKNOWN:** If any one of the following conditions is true:
+
+            *  The load balancer life cycle state is not `ACTIVE`.
+
+            *  No backend sets are defined for the load balancer.
+
+            *  More than half of the backend sets associated with the load balancer return a status of `UNKNOWN`, none of the backend
+               sets return a status of `WARNING` or `CRITICAL`, and the load balancer life cycle state is `ACTIVE`.
+
+            *  The system could not retrieve metrics for any reason.
+
+
+        :param status: The status of this LoadBalancerHealth.
+        :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_set_names(self):
+        """
+        **[Required]** Gets the warning_state_backend_set_names of this LoadBalancerHealth.
+        A list of backend sets that are currently in the `WARNING` health state. The list identifies each backend set by the
+        friendly name you assigned when you created it.
+
+        Example: `example_backend_set3`
+
+
+        :return: The warning_state_backend_set_names of this LoadBalancerHealth.
+        :rtype: list[str]
+        """
+        return self._warning_state_backend_set_names
+
+    @warning_state_backend_set_names.setter
+    def warning_state_backend_set_names(self, warning_state_backend_set_names):
+        """
+        Sets the warning_state_backend_set_names of this LoadBalancerHealth.
+        A list of backend sets that are currently in the `WARNING` health state. The list identifies each backend set by the
+        friendly name you assigned when you created it.
+
+        Example: `example_backend_set3`
+
+
+        :param warning_state_backend_set_names: The warning_state_backend_set_names of this LoadBalancerHealth.
+        :type: list[str]
+        """
+        self._warning_state_backend_set_names = warning_state_backend_set_names
+
+    @property
+    def critical_state_backend_set_names(self):
+        """
+        **[Required]** Gets the critical_state_backend_set_names of this LoadBalancerHealth.
+        A list of backend sets that are currently in the `CRITICAL` health state. The list identifies each backend set by the
+        friendly name you assigned when you created it.
+
+        Example: `example_backend_set`
+
+
+        :return: The critical_state_backend_set_names of this LoadBalancerHealth.
+        :rtype: list[str]
+        """
+        return self._critical_state_backend_set_names
+
+    @critical_state_backend_set_names.setter
+    def critical_state_backend_set_names(self, critical_state_backend_set_names):
+        """
+        Sets the critical_state_backend_set_names of this LoadBalancerHealth.
+        A list of backend sets that are currently in the `CRITICAL` health state. The list identifies each backend set by the
+        friendly name you assigned when you created it.
+
+        Example: `example_backend_set`
+
+
+        :param critical_state_backend_set_names: The critical_state_backend_set_names of this LoadBalancerHealth.
+        :type: list[str]
+        """
+        self._critical_state_backend_set_names = critical_state_backend_set_names
+
+    @property
+    def unknown_state_backend_set_names(self):
+        """
+        **[Required]** Gets the unknown_state_backend_set_names of this LoadBalancerHealth.
+        A list of backend sets that are currently in the `UNKNOWN` health state. The list identifies each backend set by the
+        friendly name you assigned when you created it.
+
+        Example: `example_backend_set2`
+
+
+        :return: The unknown_state_backend_set_names of this LoadBalancerHealth.
+        :rtype: list[str]
+        """
+        return self._unknown_state_backend_set_names
+
+    @unknown_state_backend_set_names.setter
+    def unknown_state_backend_set_names(self, unknown_state_backend_set_names):
+        """
+        Sets the unknown_state_backend_set_names of this LoadBalancerHealth.
+        A list of backend sets that are currently in the `UNKNOWN` health state. The list identifies each backend set by the
+        friendly name you assigned when you created it.
+
+        Example: `example_backend_set2`
+
+
+        :param unknown_state_backend_set_names: The unknown_state_backend_set_names of this LoadBalancerHealth.
+        :type: list[str]
+        """
+        self._unknown_state_backend_set_names = unknown_state_backend_set_names
+
+    @property
+    def total_backend_set_count(self):
+        """
+        **[Required]** Gets the total_backend_set_count of this LoadBalancerHealth.
+        The total number of backend sets associated with this load balancer.
+
+        Example: `4`
+
+
+        :return: The total_backend_set_count of this LoadBalancerHealth.
+        :rtype: int
+        """
+        return self._total_backend_set_count
+
+    @total_backend_set_count.setter
+    def total_backend_set_count(self, total_backend_set_count):
+        """
+        Sets the total_backend_set_count of this LoadBalancerHealth.
+        The total number of backend sets associated with this load balancer.
+
+        Example: `4`
+
+
+        :param total_backend_set_count: The total_backend_set_count of this LoadBalancerHealth.
+        :type: int
+        """
+        self._total_backend_set_count = total_backend_set_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

oci/load_balancer/models/load_balancer_health_summary.py

@@ -0,0 +1,167 @@
+# 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 LoadBalancerHealthSummary(object):
+    """
+    A health status summary for the specified load balancer.
+    """
+
+    #: A constant which can be used with the status property of a LoadBalancerHealthSummary.
+    #: This constant has a value of "OK"
+    STATUS_OK = "OK"
+
+    #: A constant which can be used with the status property of a LoadBalancerHealthSummary.
+    #: This constant has a value of "WARNING"
+    STATUS_WARNING = "WARNING"
+
+    #: A constant which can be used with the status property of a LoadBalancerHealthSummary.
+    #: This constant has a value of "CRITICAL"
+    STATUS_CRITICAL = "CRITICAL"
+
+    #: A constant which can be used with the status property of a LoadBalancerHealthSummary.
+    #: This constant has a value of "UNKNOWN"
+    STATUS_UNKNOWN = "UNKNOWN"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new LoadBalancerHealthSummary object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param load_balancer_id:
+            The value to assign to the load_balancer_id property of this LoadBalancerHealthSummary.
+        :type load_balancer_id: str
+
+        :param status:
+            The value to assign to the status property of this LoadBalancerHealthSummary.
+            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
+
+        """
+        self.swagger_types = {
+            'load_balancer_id': 'str',
+            'status': 'str'
+        }
+
+        self.attribute_map = {
+            'load_balancer_id': 'loadBalancerId',
+            'status': 'status'
+        }
+
+        self._load_balancer_id = None
+        self._status = None
+
+    @property
+    def load_balancer_id(self):
+        """
+        **[Required]** Gets the load_balancer_id of this LoadBalancerHealthSummary.
+        The `OCID`__ of the load balancer the health status is associated with.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :return: The load_balancer_id of this LoadBalancerHealthSummary.
+        :rtype: str
+        """
+        return self._load_balancer_id
+
+    @load_balancer_id.setter
+    def load_balancer_id(self, load_balancer_id):
+        """
+        Sets the load_balancer_id of this LoadBalancerHealthSummary.
+        The `OCID`__ of the load balancer the health status is associated with.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :param load_balancer_id: The load_balancer_id of this LoadBalancerHealthSummary.
+        :type: str
+        """
+        self._load_balancer_id = load_balancer_id
+
+    @property
+    def status(self):
+        """
+        **[Required]** Gets the status of this LoadBalancerHealthSummary.
+        The overall health status of the load balancer.
+
+        *  **OK:** All backend sets associated with the load balancer return a status of `OK`.
+
+        *  **WARNING:** At least one of the backend sets associated with the load balancer returns a status of `WARNING`,
+        no backend sets return a status of `CRITICAL`, and the load balancer life cycle state is `ACTIVE`.
+
+        *  **CRITICAL:** One or more of the backend sets associated with the load balancer return a status of `CRITICAL`.
+
+        *  **UNKNOWN:** If any one of the following conditions is true:
+
+            *  The load balancer life cycle state is not `ACTIVE`.
+
+            *  No backend sets are defined for the load balancer.
+
+            *  More than half of the backend sets associated with the load balancer return a status of `UNKNOWN`, none of the backend
+               sets return a status of `WARNING` or `CRITICAL`, and the load balancer life cycle state is `ACTIVE`.
+
+            *  The system could not retrieve metrics for any reason.
+
+        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 LoadBalancerHealthSummary.
+        :rtype: str
+        """
+        return self._status
+
+    @status.setter
+    def status(self, status):
+        """
+        Sets the status of this LoadBalancerHealthSummary.
+        The overall health status of the load balancer.
+
+        *  **OK:** All backend sets associated with the load balancer return a status of `OK`.
+
+        *  **WARNING:** At least one of the backend sets associated with the load balancer returns a status of `WARNING`,
+        no backend sets return a status of `CRITICAL`, and the load balancer life cycle state is `ACTIVE`.
+
+        *  **CRITICAL:** One or more of the backend sets associated with the load balancer return a status of `CRITICAL`.
+
+        *  **UNKNOWN:** If any one of the following conditions is true:
+
+            *  The load balancer life cycle state is not `ACTIVE`.
+
+            *  No backend sets are defined for the load balancer.
+
+            *  More than half of the backend sets associated with the load balancer return a status of `UNKNOWN`, none of the backend
+               sets return a status of `WARNING` or `CRITICAL`, and the load balancer life cycle state is `ACTIVE`.
+
+            *  The system could not retrieve metrics for any reason.
+
+
+        :param status: The status of this LoadBalancerHealthSummary.
+        :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
+
+    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/load_balancer_policy.py

@@ -0,0 +1,80 @@
+# 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 LoadBalancerPolicy(object):
+    """
+    A policy that determines how traffic is distributed among backend servers.
+    For more information on load balancing policies, see
+    `How Load Balancing Policies Work`__.
+
+    __ https://docs.cloud.oracle.com/Content/Balance/Reference/lbpolicies.htm
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new LoadBalancerPolicy 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 LoadBalancerPolicy.
+        :type name: str
+
+        """
+        self.swagger_types = {
+            'name': 'str'
+        }
+
+        self.attribute_map = {
+            'name': 'name'
+        }
+
+        self._name = None
+
+    @property
+    def name(self):
+        """
+        **[Required]** Gets the name of this LoadBalancerPolicy.
+        The name of a load balancing policy.
+
+        Example: 'LEAST_CONNECTIONS'
+
+
+        :return: The name of this LoadBalancerPolicy.
+        :rtype: str
+        """
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        """
+        Sets the name of this LoadBalancerPolicy.
+        The name of a load balancing policy.
+
+        Example: 'LEAST_CONNECTIONS'
+
+
+        :param name: The name of this LoadBalancerPolicy.
+        :type: str
+        """
+        self._name = name
+
+    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/load_balancer_protocol.py

@@ -0,0 +1,76 @@
+# 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 LoadBalancerProtocol(object):
+    """
+    A protocol that defines the type of traffic accepted by a listener.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new LoadBalancerProtocol 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 LoadBalancerProtocol.
+        :type name: str
+
+        """
+        self.swagger_types = {
+            'name': 'str'
+        }
+
+        self.attribute_map = {
+            'name': 'name'
+        }
+
+        self._name = None
+
+    @property
+    def name(self):
+        """
+        **[Required]** Gets the name of this LoadBalancerProtocol.
+        The name of a protocol.
+
+        Example: 'HTTP'
+
+
+        :return: The name of this LoadBalancerProtocol.
+        :rtype: str
+        """
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        """
+        Sets the name of this LoadBalancerProtocol.
+        The name of a protocol.
+
+        Example: 'HTTP'
+
+
+        :param name: The name of this LoadBalancerProtocol.
+        :type: str
+        """
+        self._name = name
+
+    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/load_balancer_shape.py

@@ -0,0 +1,80 @@
+# 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 LoadBalancerShape(object):
+    """
+    A shape is a template that determines the total pre-provisioned bandwidth (ingress plus egress) for the
+    load balancer.
+
+    Note that the pre-provisioned maximum capacity applies to aggregated connections, not to a single client
+    attempting to use the full bandwidth.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new LoadBalancerShape 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 LoadBalancerShape.
+        :type name: str
+
+        """
+        self.swagger_types = {
+            'name': 'str'
+        }
+
+        self.attribute_map = {
+            'name': 'name'
+        }
+
+        self._name = None
+
+    @property
+    def name(self):
+        """
+        **[Required]** Gets the name of this LoadBalancerShape.
+        The name of the shape.
+
+        Example: `100Mbps`
+
+
+        :return: The name of this LoadBalancerShape.
+        :rtype: str
+        """
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        """
+        Sets the name of this LoadBalancerShape.
+        The name of the shape.
+
+        Example: `100Mbps`
+
+
+        :param name: The name of this LoadBalancerShape.
+        :type: str
+        """
+        self._name = name
+
+    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