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

oci/load_balancer/models/connection_configuration.py

@@ -0,0 +1,168 @@
+# 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 ConnectionConfiguration(object):
+    """
+    Configuration details for the connection between the client and backend servers.
+    """
+
+    #: A constant which can be used with the backend_tcp_proxy_protocol_options property of a ConnectionConfiguration.
+    #: This constant has a value of "PP2_TYPE_AUTHORITY"
+    BACKEND_TCP_PROXY_PROTOCOL_OPTIONS_PP2_TYPE_AUTHORITY = "PP2_TYPE_AUTHORITY"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new ConnectionConfiguration object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param idle_timeout:
+            The value to assign to the idle_timeout property of this ConnectionConfiguration.
+        :type idle_timeout: int
+
+        :param backend_tcp_proxy_protocol_version:
+            The value to assign to the backend_tcp_proxy_protocol_version property of this ConnectionConfiguration.
+        :type backend_tcp_proxy_protocol_version: int
+
+        :param backend_tcp_proxy_protocol_options:
+            The value to assign to the backend_tcp_proxy_protocol_options property of this ConnectionConfiguration.
+            Allowed values for items in this list are: "PP2_TYPE_AUTHORITY", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type backend_tcp_proxy_protocol_options: list[str]
+
+        """
+        self.swagger_types = {
+            'idle_timeout': 'int',
+            'backend_tcp_proxy_protocol_version': 'int',
+            'backend_tcp_proxy_protocol_options': 'list[str]'
+        }
+
+        self.attribute_map = {
+            'idle_timeout': 'idleTimeout',
+            'backend_tcp_proxy_protocol_version': 'backendTcpProxyProtocolVersion',
+            'backend_tcp_proxy_protocol_options': 'backendTcpProxyProtocolOptions'
+        }
+
+        self._idle_timeout = None
+        self._backend_tcp_proxy_protocol_version = None
+        self._backend_tcp_proxy_protocol_options = None
+
+    @property
+    def idle_timeout(self):
+        """
+        **[Required]** Gets the idle_timeout of this ConnectionConfiguration.
+        The maximum idle time, in seconds, allowed between two successive receive or two successive send operations
+        between the client and backend servers. A send operation does not reset the timer for receive operations. A
+        receive operation does not reset the timer for send operations.
+
+        For more information, see `Connection Configuration`__.
+
+        Example: `1200`
+
+        __ https://docs.cloud.oracle.com/Content/Balance/Reference/connectionreuse.htm#ConnectionConfiguration
+
+
+        :return: The idle_timeout of this ConnectionConfiguration.
+        :rtype: int
+        """
+        return self._idle_timeout
+
+    @idle_timeout.setter
+    def idle_timeout(self, idle_timeout):
+        """
+        Sets the idle_timeout of this ConnectionConfiguration.
+        The maximum idle time, in seconds, allowed between two successive receive or two successive send operations
+        between the client and backend servers. A send operation does not reset the timer for receive operations. A
+        receive operation does not reset the timer for send operations.
+
+        For more information, see `Connection Configuration`__.
+
+        Example: `1200`
+
+        __ https://docs.cloud.oracle.com/Content/Balance/Reference/connectionreuse.htm#ConnectionConfiguration
+
+
+        :param idle_timeout: The idle_timeout of this ConnectionConfiguration.
+        :type: int
+        """
+        self._idle_timeout = idle_timeout
+
+    @property
+    def backend_tcp_proxy_protocol_version(self):
+        """
+        Gets the backend_tcp_proxy_protocol_version of this ConnectionConfiguration.
+        The backend TCP Proxy Protocol version.
+
+        Example: `1`
+
+
+        :return: The backend_tcp_proxy_protocol_version of this ConnectionConfiguration.
+        :rtype: int
+        """
+        return self._backend_tcp_proxy_protocol_version
+
+    @backend_tcp_proxy_protocol_version.setter
+    def backend_tcp_proxy_protocol_version(self, backend_tcp_proxy_protocol_version):
+        """
+        Sets the backend_tcp_proxy_protocol_version of this ConnectionConfiguration.
+        The backend TCP Proxy Protocol version.
+
+        Example: `1`
+
+
+        :param backend_tcp_proxy_protocol_version: The backend_tcp_proxy_protocol_version of this ConnectionConfiguration.
+        :type: int
+        """
+        self._backend_tcp_proxy_protocol_version = backend_tcp_proxy_protocol_version
+
+    @property
+    def backend_tcp_proxy_protocol_options(self):
+        """
+        Gets the backend_tcp_proxy_protocol_options of this ConnectionConfiguration.
+        An array that represents the PPV2 Options that can be enabled on TCP Listeners.
+        Example: [\"PP2_TYPE_AUTHORITY\"]
+
+        Allowed values for items in this list are: "PP2_TYPE_AUTHORITY", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The backend_tcp_proxy_protocol_options of this ConnectionConfiguration.
+        :rtype: list[str]
+        """
+        return self._backend_tcp_proxy_protocol_options
+
+    @backend_tcp_proxy_protocol_options.setter
+    def backend_tcp_proxy_protocol_options(self, backend_tcp_proxy_protocol_options):
+        """
+        Sets the backend_tcp_proxy_protocol_options of this ConnectionConfiguration.
+        An array that represents the PPV2 Options that can be enabled on TCP Listeners.
+        Example: [\"PP2_TYPE_AUTHORITY\"]
+
+
+        :param backend_tcp_proxy_protocol_options: The backend_tcp_proxy_protocol_options of this ConnectionConfiguration.
+        :type: list[str]
+        """
+        allowed_values = ["PP2_TYPE_AUTHORITY"]
+        if backend_tcp_proxy_protocol_options:
+            backend_tcp_proxy_protocol_options[:] = ['UNKNOWN_ENUM_VALUE' if not value_allowed_none_or_none_sentinel(x, allowed_values) else x for x in backend_tcp_proxy_protocol_options]
+        self._backend_tcp_proxy_protocol_options = backend_tcp_proxy_protocol_options
+
+    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/control_access_using_http_methods_rule.py

@@ -0,0 +1,162 @@
+# 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 .rule import Rule
+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 ControlAccessUsingHttpMethodsRule(Rule):
+    """
+    An object that represents the action of returning a specified response code when the requested HTTP method is not in
+    the list of allowed methods for the listener. The load balancer does not forward a disallowed request to the back end
+    servers. The default response code is `405 Method Not Allowed`.
+
+    If you set the response code to `405` or leave it blank, the system adds an \"allow\" response header that contains a
+    list of the allowed methods for the listener. If you set the response code to anything other than `405` (or blank),
+    the system does not add the \"allow\" response header with a list of allowed methods.
+
+    This rule applies only to HTTP listeners. No more than one `ControlAccessUsingHttpMethodsRule` object can be present in
+    a given listener.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new ControlAccessUsingHttpMethodsRule object with values from keyword arguments. The default value of the :py:attr:`~oci.load_balancer.models.ControlAccessUsingHttpMethodsRule.action` attribute
+        of this class is ``CONTROL_ACCESS_USING_HTTP_METHODS`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param action:
+            The value to assign to the action property of this ControlAccessUsingHttpMethodsRule.
+            Allowed values for this property are: "ADD_HTTP_REQUEST_HEADER", "EXTEND_HTTP_REQUEST_HEADER_VALUE", "REMOVE_HTTP_REQUEST_HEADER", "ADD_HTTP_RESPONSE_HEADER", "EXTEND_HTTP_RESPONSE_HEADER_VALUE", "REMOVE_HTTP_RESPONSE_HEADER", "ALLOW", "CONTROL_ACCESS_USING_HTTP_METHODS", "REDIRECT", "HTTP_HEADER", "IP_BASED_MAX_CONNECTIONS"
+        :type action: str
+
+        :param allowed_methods:
+            The value to assign to the allowed_methods property of this ControlAccessUsingHttpMethodsRule.
+        :type allowed_methods: list[str]
+
+        :param status_code:
+            The value to assign to the status_code property of this ControlAccessUsingHttpMethodsRule.
+        :type status_code: int
+
+        """
+        self.swagger_types = {
+            'action': 'str',
+            'allowed_methods': 'list[str]',
+            'status_code': 'int'
+        }
+
+        self.attribute_map = {
+            'action': 'action',
+            'allowed_methods': 'allowedMethods',
+            'status_code': 'statusCode'
+        }
+
+        self._action = None
+        self._allowed_methods = None
+        self._status_code = None
+        self._action = 'CONTROL_ACCESS_USING_HTTP_METHODS'
+
+    @property
+    def allowed_methods(self):
+        """
+        **[Required]** Gets the allowed_methods of this ControlAccessUsingHttpMethodsRule.
+        The list of HTTP methods allowed for this listener.
+
+        By default, you can specify only the standard HTTP methods defined in the
+        `HTTP Method Registry`__. You can also
+        see a list of supported standard HTTP methods in the Load Balancing service documentation at
+        `Managing Rule Sets`__.
+
+        Your backend application must be able to handle the methods specified in this list.
+
+        The list of HTTP methods is extensible. If you need to configure custom HTTP methods, contact
+        `My Oracle Support`__ to remove the restriction for your tenancy.
+
+        Example: [\"GET\", \"PUT\", \"POST\", \"PROPFIND\"]
+
+        __ http://www.iana.org/assignments/http-methods/http-methods.xhtml
+        __ https://docs.cloud.oracle.com/Content/Balance/Tasks/managingrulesets.htm
+        __ http://support.oracle.com/
+
+
+        :return: The allowed_methods of this ControlAccessUsingHttpMethodsRule.
+        :rtype: list[str]
+        """
+        return self._allowed_methods
+
+    @allowed_methods.setter
+    def allowed_methods(self, allowed_methods):
+        """
+        Sets the allowed_methods of this ControlAccessUsingHttpMethodsRule.
+        The list of HTTP methods allowed for this listener.
+
+        By default, you can specify only the standard HTTP methods defined in the
+        `HTTP Method Registry`__. You can also
+        see a list of supported standard HTTP methods in the Load Balancing service documentation at
+        `Managing Rule Sets`__.
+
+        Your backend application must be able to handle the methods specified in this list.
+
+        The list of HTTP methods is extensible. If you need to configure custom HTTP methods, contact
+        `My Oracle Support`__ to remove the restriction for your tenancy.
+
+        Example: [\"GET\", \"PUT\", \"POST\", \"PROPFIND\"]
+
+        __ http://www.iana.org/assignments/http-methods/http-methods.xhtml
+        __ https://docs.cloud.oracle.com/Content/Balance/Tasks/managingrulesets.htm
+        __ http://support.oracle.com/
+
+
+        :param allowed_methods: The allowed_methods of this ControlAccessUsingHttpMethodsRule.
+        :type: list[str]
+        """
+        self._allowed_methods = allowed_methods
+
+    @property
+    def status_code(self):
+        """
+        Gets the status_code of this ControlAccessUsingHttpMethodsRule.
+        The HTTP status code to return when the requested HTTP method is not in the list of allowed methods.
+        The associated status line returned with the code is mapped from the standard HTTP specification. The
+        default value is `405 (Method Not Allowed)`.
+
+        Example: 403
+
+
+        :return: The status_code of this ControlAccessUsingHttpMethodsRule.
+        :rtype: int
+        """
+        return self._status_code
+
+    @status_code.setter
+    def status_code(self, status_code):
+        """
+        Sets the status_code of this ControlAccessUsingHttpMethodsRule.
+        The HTTP status code to return when the requested HTTP method is not in the list of allowed methods.
+        The associated status line returned with the code is mapped from the standard HTTP specification. The
+        default value is `405 (Method Not Allowed)`.
+
+        Example: 403
+
+
+        :param status_code: The status_code of this ControlAccessUsingHttpMethodsRule.
+        :type: int
+        """
+        self._status_code = status_code
+
+    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/create_backend_details.py

@@ -0,0 +1,316 @@
+# 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 CreateBackendDetails(object):
+    """
+    The configuration details for creating a backend server in a backend set.
+    For more information on backend server configuration, see
+    `Managing Backend Servers`__.
+
+    __ https://docs.cloud.oracle.com/Content/Balance/Tasks/managingbackendservers.htm
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new CreateBackendDetails object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param ip_address:
+            The value to assign to the ip_address property of this CreateBackendDetails.
+        :type ip_address: str
+
+        :param port:
+            The value to assign to the port property of this CreateBackendDetails.
+        :type port: int
+
+        :param weight:
+            The value to assign to the weight property of this CreateBackendDetails.
+        :type weight: int
+
+        :param max_connections:
+            The value to assign to the max_connections property of this CreateBackendDetails.
+        :type max_connections: int
+
+        :param backup:
+            The value to assign to the backup property of this CreateBackendDetails.
+        :type backup: bool
+
+        :param drain:
+            The value to assign to the drain property of this CreateBackendDetails.
+        :type drain: bool
+
+        :param offline:
+            The value to assign to the offline property of this CreateBackendDetails.
+        :type offline: bool
+
+        """
+        self.swagger_types = {
+            'ip_address': 'str',
+            'port': 'int',
+            'weight': 'int',
+            'max_connections': 'int',
+            'backup': 'bool',
+            'drain': 'bool',
+            'offline': 'bool'
+        }
+
+        self.attribute_map = {
+            'ip_address': 'ipAddress',
+            'port': 'port',
+            'weight': 'weight',
+            'max_connections': 'maxConnections',
+            'backup': 'backup',
+            'drain': 'drain',
+            'offline': 'offline'
+        }
+
+        self._ip_address = None
+        self._port = None
+        self._weight = None
+        self._max_connections = None
+        self._backup = None
+        self._drain = None
+        self._offline = None
+
+    @property
+    def ip_address(self):
+        """
+        **[Required]** Gets the ip_address of this CreateBackendDetails.
+        The IP address of the backend server.
+
+        Example: `10.0.0.3`
+
+
+        :return: The ip_address of this CreateBackendDetails.
+        :rtype: str
+        """
+        return self._ip_address
+
+    @ip_address.setter
+    def ip_address(self, ip_address):
+        """
+        Sets the ip_address of this CreateBackendDetails.
+        The IP address of the backend server.
+
+        Example: `10.0.0.3`
+
+
+        :param ip_address: The ip_address of this CreateBackendDetails.
+        :type: str
+        """
+        self._ip_address = ip_address
+
+    @property
+    def port(self):
+        """
+        **[Required]** Gets the port of this CreateBackendDetails.
+        The communication port for the backend server.
+
+        Example: `8080`
+
+
+        :return: The port of this CreateBackendDetails.
+        :rtype: int
+        """
+        return self._port
+
+    @port.setter
+    def port(self, port):
+        """
+        Sets the port of this CreateBackendDetails.
+        The communication port for the backend server.
+
+        Example: `8080`
+
+
+        :param port: The port of this CreateBackendDetails.
+        :type: int
+        """
+        self._port = port
+
+    @property
+    def weight(self):
+        """
+        Gets the weight of this CreateBackendDetails.
+        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 CreateBackendDetails.
+        :rtype: int
+        """
+        return self._weight
+
+    @weight.setter
+    def weight(self, weight):
+        """
+        Sets the weight of this CreateBackendDetails.
+        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 CreateBackendDetails.
+        :type: int
+        """
+        self._weight = weight
+
+    @property
+    def max_connections(self):
+        """
+        Gets the max_connections of this CreateBackendDetails.
+        The maximum number of simultaneous connections the load balancer can make to the backend.
+        If this is not set then number of simultaneous connections the load balancer can make to
+        the backend is unlimited.
+
+        Example: `300`
+
+
+        :return: The max_connections of this CreateBackendDetails.
+        :rtype: int
+        """
+        return self._max_connections
+
+    @max_connections.setter
+    def max_connections(self, max_connections):
+        """
+        Sets the max_connections of this CreateBackendDetails.
+        The maximum number of simultaneous connections the load balancer can make to the backend.
+        If this is not set then number of simultaneous connections the load balancer can make to
+        the backend is unlimited.
+
+        Example: `300`
+
+
+        :param max_connections: The max_connections of this CreateBackendDetails.
+        :type: int
+        """
+        self._max_connections = max_connections
+
+    @property
+    def backup(self):
+        """
+        Gets the backup of this CreateBackendDetails.
+        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 CreateBackendDetails.
+        :rtype: bool
+        """
+        return self._backup
+
+    @backup.setter
+    def backup(self, backup):
+        """
+        Sets the backup of this CreateBackendDetails.
+        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 CreateBackendDetails.
+        :type: bool
+        """
+        self._backup = backup
+
+    @property
+    def drain(self):
+        """
+        Gets the drain of this CreateBackendDetails.
+        Whether the load balancer should drain this server. Servers marked \"drain\" receive no new
+        incoming traffic.
+
+        Example: `false`
+
+
+        :return: The drain of this CreateBackendDetails.
+        :rtype: bool
+        """
+        return self._drain
+
+    @drain.setter
+    def drain(self, drain):
+        """
+        Sets the drain of this CreateBackendDetails.
+        Whether the load balancer should drain this server. Servers marked \"drain\" receive no new
+        incoming traffic.
+
+        Example: `false`
+
+
+        :param drain: The drain of this CreateBackendDetails.
+        :type: bool
+        """
+        self._drain = drain
+
+    @property
+    def offline(self):
+        """
+        Gets the offline of this CreateBackendDetails.
+        Whether the load balancer should treat this server as offline. Offline servers receive no incoming
+        traffic.
+
+        Example: `false`
+
+
+        :return: The offline of this CreateBackendDetails.
+        :rtype: bool
+        """
+        return self._offline
+
+    @offline.setter
+    def offline(self, offline):
+        """
+        Sets the offline of this CreateBackendDetails.
+        Whether the load balancer should treat this server as offline. Offline servers receive no incoming
+        traffic.
+
+        Example: `false`
+
+
+        :param offline: The offline of this CreateBackendDetails.
+        :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