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

oci/load_balancer/models/health_checker.py

@@ -0,0 +1,381 @@
+# 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 HealthChecker(object):
+    """
+    The health check policy configuration.
+    For more information, see `Editing Health Check Policies`__.
+
+    __ https://docs.cloud.oracle.com/Content/Balance/Tasks/editinghealthcheck.htm
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new HealthChecker object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param protocol:
+            The value to assign to the protocol property of this HealthChecker.
+        :type protocol: str
+
+        :param url_path:
+            The value to assign to the url_path property of this HealthChecker.
+        :type url_path: str
+
+        :param port:
+            The value to assign to the port property of this HealthChecker.
+        :type port: int
+
+        :param return_code:
+            The value to assign to the return_code property of this HealthChecker.
+        :type return_code: int
+
+        :param retries:
+            The value to assign to the retries property of this HealthChecker.
+        :type retries: int
+
+        :param timeout_in_millis:
+            The value to assign to the timeout_in_millis property of this HealthChecker.
+        :type timeout_in_millis: int
+
+        :param interval_in_millis:
+            The value to assign to the interval_in_millis property of this HealthChecker.
+        :type interval_in_millis: int
+
+        :param response_body_regex:
+            The value to assign to the response_body_regex property of this HealthChecker.
+        :type response_body_regex: str
+
+        :param is_force_plain_text:
+            The value to assign to the is_force_plain_text property of this HealthChecker.
+        :type is_force_plain_text: bool
+
+        """
+        self.swagger_types = {
+            'protocol': 'str',
+            'url_path': 'str',
+            'port': 'int',
+            'return_code': 'int',
+            'retries': 'int',
+            'timeout_in_millis': 'int',
+            'interval_in_millis': 'int',
+            'response_body_regex': 'str',
+            'is_force_plain_text': 'bool'
+        }
+
+        self.attribute_map = {
+            'protocol': 'protocol',
+            'url_path': 'urlPath',
+            'port': 'port',
+            'return_code': 'returnCode',
+            'retries': 'retries',
+            'timeout_in_millis': 'timeoutInMillis',
+            'interval_in_millis': 'intervalInMillis',
+            'response_body_regex': 'responseBodyRegex',
+            'is_force_plain_text': 'isForcePlainText'
+        }
+
+        self._protocol = None
+        self._url_path = None
+        self._port = None
+        self._return_code = None
+        self._retries = None
+        self._timeout_in_millis = None
+        self._interval_in_millis = None
+        self._response_body_regex = None
+        self._is_force_plain_text = None
+
+    @property
+    def protocol(self):
+        """
+        **[Required]** Gets the protocol of this HealthChecker.
+        The protocol the health check must use; either HTTP or TCP.
+
+        Example: `HTTP`
+
+
+        :return: The protocol of this HealthChecker.
+        :rtype: str
+        """
+        return self._protocol
+
+    @protocol.setter
+    def protocol(self, protocol):
+        """
+        Sets the protocol of this HealthChecker.
+        The protocol the health check must use; either HTTP or TCP.
+
+        Example: `HTTP`
+
+
+        :param protocol: The protocol of this HealthChecker.
+        :type: str
+        """
+        self._protocol = protocol
+
+    @property
+    def url_path(self):
+        """
+        Gets the url_path of this HealthChecker.
+        The path against which to run the health check.
+
+        Example: `/healthcheck`
+
+
+        :return: The url_path of this HealthChecker.
+        :rtype: str
+        """
+        return self._url_path
+
+    @url_path.setter
+    def url_path(self, url_path):
+        """
+        Sets the url_path of this HealthChecker.
+        The path against which to run the health check.
+
+        Example: `/healthcheck`
+
+
+        :param url_path: The url_path of this HealthChecker.
+        :type: str
+        """
+        self._url_path = url_path
+
+    @property
+    def port(self):
+        """
+        **[Required]** Gets the port of this HealthChecker.
+        The backend server port against which to run the health check. If the port is not specified, the load balancer uses the
+        port information from the `Backend` object.
+
+        Example: `8080`
+
+
+        :return: The port of this HealthChecker.
+        :rtype: int
+        """
+        return self._port
+
+    @port.setter
+    def port(self, port):
+        """
+        Sets the port of this HealthChecker.
+        The backend server port against which to run the health check. If the port is not specified, the load balancer uses the
+        port information from the `Backend` object.
+
+        Example: `8080`
+
+
+        :param port: The port of this HealthChecker.
+        :type: int
+        """
+        self._port = port
+
+    @property
+    def return_code(self):
+        """
+        **[Required]** Gets the return_code of this HealthChecker.
+        The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol,
+        you can use common HTTP status codes such as \"200\".
+
+        Example: `200`
+
+
+        :return: The return_code of this HealthChecker.
+        :rtype: int
+        """
+        return self._return_code
+
+    @return_code.setter
+    def return_code(self, return_code):
+        """
+        Sets the return_code of this HealthChecker.
+        The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol,
+        you can use common HTTP status codes such as \"200\".
+
+        Example: `200`
+
+
+        :param return_code: The return_code of this HealthChecker.
+        :type: int
+        """
+        self._return_code = return_code
+
+    @property
+    def retries(self):
+        """
+        Gets the retries of this HealthChecker.
+        The number of retries to attempt before a backend server is considered \"unhealthy\". This number also applies
+        when recovering a server to the \"healthy\" state. Defaults to 3.
+
+        Example: `3`
+
+
+        :return: The retries of this HealthChecker.
+        :rtype: int
+        """
+        return self._retries
+
+    @retries.setter
+    def retries(self, retries):
+        """
+        Sets the retries of this HealthChecker.
+        The number of retries to attempt before a backend server is considered \"unhealthy\". This number also applies
+        when recovering a server to the \"healthy\" state. Defaults to 3.
+
+        Example: `3`
+
+
+        :param retries: The retries of this HealthChecker.
+        :type: int
+        """
+        self._retries = retries
+
+    @property
+    def timeout_in_millis(self):
+        """
+        Gets the timeout_in_millis of this HealthChecker.
+        The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply
+        returns within this timeout period. Defaults to 3000 (3 seconds).
+
+        Example: `3000`
+
+
+        :return: The timeout_in_millis of this HealthChecker.
+        :rtype: int
+        """
+        return self._timeout_in_millis
+
+    @timeout_in_millis.setter
+    def timeout_in_millis(self, timeout_in_millis):
+        """
+        Sets the timeout_in_millis of this HealthChecker.
+        The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply
+        returns within this timeout period. Defaults to 3000 (3 seconds).
+
+        Example: `3000`
+
+
+        :param timeout_in_millis: The timeout_in_millis of this HealthChecker.
+        :type: int
+        """
+        self._timeout_in_millis = timeout_in_millis
+
+    @property
+    def interval_in_millis(self):
+        """
+        Gets the interval_in_millis of this HealthChecker.
+        The interval between health checks, in milliseconds. The default is 10000 (10 seconds).
+
+        Example: `10000`
+
+
+        :return: The interval_in_millis of this HealthChecker.
+        :rtype: int
+        """
+        return self._interval_in_millis
+
+    @interval_in_millis.setter
+    def interval_in_millis(self, interval_in_millis):
+        """
+        Sets the interval_in_millis of this HealthChecker.
+        The interval between health checks, in milliseconds. The default is 10000 (10 seconds).
+
+        Example: `10000`
+
+
+        :param interval_in_millis: The interval_in_millis of this HealthChecker.
+        :type: int
+        """
+        self._interval_in_millis = interval_in_millis
+
+    @property
+    def response_body_regex(self):
+        """
+        **[Required]** Gets the response_body_regex of this HealthChecker.
+        A regular expression for parsing the response body from the backend server.
+
+        Example: `^((?!false).|\\s)*$`
+
+
+        :return: The response_body_regex of this HealthChecker.
+        :rtype: str
+        """
+        return self._response_body_regex
+
+    @response_body_regex.setter
+    def response_body_regex(self, response_body_regex):
+        """
+        Sets the response_body_regex of this HealthChecker.
+        A regular expression for parsing the response body from the backend server.
+
+        Example: `^((?!false).|\\s)*$`
+
+
+        :param response_body_regex: The response_body_regex of this HealthChecker.
+        :type: str
+        """
+        self._response_body_regex = response_body_regex
+
+    @property
+    def is_force_plain_text(self):
+        """
+        Gets the is_force_plain_text of this HealthChecker.
+        Specifies if health checks should always be done using plain text instead of depending on
+        whether or not the associated backend set is using SSL.
+
+        If \"true\", health checks will be done using plain text even if the associated backend set is configured
+        to use SSL.
+
+        If \"false\", health checks will be done using SSL encryption if the associated backend set is configured
+        to use SSL. If the backend set is not so configured the health checks will be done using plain text.
+
+        Example: `false`
+
+
+        :return: The is_force_plain_text of this HealthChecker.
+        :rtype: bool
+        """
+        return self._is_force_plain_text
+
+    @is_force_plain_text.setter
+    def is_force_plain_text(self, is_force_plain_text):
+        """
+        Sets the is_force_plain_text of this HealthChecker.
+        Specifies if health checks should always be done using plain text instead of depending on
+        whether or not the associated backend set is using SSL.
+
+        If \"true\", health checks will be done using plain text even if the associated backend set is configured
+        to use SSL.
+
+        If \"false\", health checks will be done using SSL encryption if the associated backend set is configured
+        to use SSL. If the backend set is not so configured the health checks will be done using plain text.
+
+        Example: `false`
+
+
+        :param is_force_plain_text: The is_force_plain_text of this HealthChecker.
+        :type: bool
+        """
+        self._is_force_plain_text = is_force_plain_text
+
+    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