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

oci/load_balancer/models/path_match_condition.py

@@ -0,0 +1,166 @@
+# 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_condition import RuleCondition
+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 PathMatchCondition(RuleCondition):
+    """
+    The path string and match condition to apply when evaluating an incoming URI for redirection.
+    """
+
+    #: A constant which can be used with the operator property of a PathMatchCondition.
+    #: This constant has a value of "EXACT_MATCH"
+    OPERATOR_EXACT_MATCH = "EXACT_MATCH"
+
+    #: A constant which can be used with the operator property of a PathMatchCondition.
+    #: This constant has a value of "FORCE_LONGEST_PREFIX_MATCH"
+    OPERATOR_FORCE_LONGEST_PREFIX_MATCH = "FORCE_LONGEST_PREFIX_MATCH"
+
+    #: A constant which can be used with the operator property of a PathMatchCondition.
+    #: This constant has a value of "PREFIX_MATCH"
+    OPERATOR_PREFIX_MATCH = "PREFIX_MATCH"
+
+    #: A constant which can be used with the operator property of a PathMatchCondition.
+    #: This constant has a value of "SUFFIX_MATCH"
+    OPERATOR_SUFFIX_MATCH = "SUFFIX_MATCH"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new PathMatchCondition object with values from keyword arguments. The default value of the :py:attr:`~oci.load_balancer.models.PathMatchCondition.attribute_name` attribute
+        of this class is ``PATH`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param attribute_name:
+            The value to assign to the attribute_name property of this PathMatchCondition.
+            Allowed values for this property are: "SOURCE_IP_ADDRESS", "SOURCE_VCN_ID", "SOURCE_VCN_IP_ADDRESS", "PATH", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type attribute_name: str
+
+        :param attribute_value:
+            The value to assign to the attribute_value property of this PathMatchCondition.
+        :type attribute_value: str
+
+        :param operator:
+            The value to assign to the operator property of this PathMatchCondition.
+            Allowed values for this property are: "EXACT_MATCH", "FORCE_LONGEST_PREFIX_MATCH", "PREFIX_MATCH", "SUFFIX_MATCH", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type operator: str
+
+        """
+        self.swagger_types = {
+            'attribute_name': 'str',
+            'attribute_value': 'str',
+            'operator': 'str'
+        }
+
+        self.attribute_map = {
+            'attribute_name': 'attributeName',
+            'attribute_value': 'attributeValue',
+            'operator': 'operator'
+        }
+
+        self._attribute_name = None
+        self._attribute_value = None
+        self._operator = None
+        self._attribute_name = 'PATH'
+
+    @property
+    def attribute_value(self):
+        """
+        **[Required]** Gets the attribute_value of this PathMatchCondition.
+        The path string that the redirection rule applies to.
+
+        Example: `/example`
+
+
+        :return: The attribute_value of this PathMatchCondition.
+        :rtype: str
+        """
+        return self._attribute_value
+
+    @attribute_value.setter
+    def attribute_value(self, attribute_value):
+        """
+        Sets the attribute_value of this PathMatchCondition.
+        The path string that the redirection rule applies to.
+
+        Example: `/example`
+
+
+        :param attribute_value: The attribute_value of this PathMatchCondition.
+        :type: str
+        """
+        self._attribute_value = attribute_value
+
+    @property
+    def operator(self):
+        """
+        **[Required]** Gets the operator of this PathMatchCondition.
+        A string that specifies how to compare the PathMatchCondition object's `attributeValue` string to the
+        incoming URI.
+
+        *  **EXACT_MATCH** - The incoming URI path must exactly and completely match the `attributeValue` string.
+
+        *  **FORCE_LONGEST_PREFIX_MATCH** - The system looks for the `attributeValue` string with the best,
+           longest match of the beginning portion of the incoming URI path.
+
+        *  **PREFIX_MATCH** - The beginning portion of the incoming URI path must exactly match the
+           `attributeValue` string.
+
+        *  **SUFFIX_MATCH** - The ending portion of the incoming URI path must exactly match the `attributeValue`
+           string.
+
+        Allowed values for this property are: "EXACT_MATCH", "FORCE_LONGEST_PREFIX_MATCH", "PREFIX_MATCH", "SUFFIX_MATCH", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The operator of this PathMatchCondition.
+        :rtype: str
+        """
+        return self._operator
+
+    @operator.setter
+    def operator(self, operator):
+        """
+        Sets the operator of this PathMatchCondition.
+        A string that specifies how to compare the PathMatchCondition object's `attributeValue` string to the
+        incoming URI.
+
+        *  **EXACT_MATCH** - The incoming URI path must exactly and completely match the `attributeValue` string.
+
+        *  **FORCE_LONGEST_PREFIX_MATCH** - The system looks for the `attributeValue` string with the best,
+           longest match of the beginning portion of the incoming URI path.
+
+        *  **PREFIX_MATCH** - The beginning portion of the incoming URI path must exactly match the
+           `attributeValue` string.
+
+        *  **SUFFIX_MATCH** - The ending portion of the incoming URI path must exactly match the `attributeValue`
+           string.
+
+
+        :param operator: The operator of this PathMatchCondition.
+        :type: str
+        """
+        allowed_values = ["EXACT_MATCH", "FORCE_LONGEST_PREFIX_MATCH", "PREFIX_MATCH", "SUFFIX_MATCH"]
+        if not value_allowed_none_or_none_sentinel(operator, allowed_values):
+            operator = 'UNKNOWN_ENUM_VALUE'
+        self._operator = operator
+
+    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/path_match_type.py

@@ -0,0 +1,126 @@
+# 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 PathMatchType(object):
+    """
+    The type of matching to apply to incoming URIs.
+    """
+
+    #: A constant which can be used with the match_type property of a PathMatchType.
+    #: This constant has a value of "EXACT_MATCH"
+    MATCH_TYPE_EXACT_MATCH = "EXACT_MATCH"
+
+    #: A constant which can be used with the match_type property of a PathMatchType.
+    #: This constant has a value of "FORCE_LONGEST_PREFIX_MATCH"
+    MATCH_TYPE_FORCE_LONGEST_PREFIX_MATCH = "FORCE_LONGEST_PREFIX_MATCH"
+
+    #: A constant which can be used with the match_type property of a PathMatchType.
+    #: This constant has a value of "PREFIX_MATCH"
+    MATCH_TYPE_PREFIX_MATCH = "PREFIX_MATCH"
+
+    #: A constant which can be used with the match_type property of a PathMatchType.
+    #: This constant has a value of "SUFFIX_MATCH"
+    MATCH_TYPE_SUFFIX_MATCH = "SUFFIX_MATCH"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new PathMatchType object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param match_type:
+            The value to assign to the match_type property of this PathMatchType.
+            Allowed values for this property are: "EXACT_MATCH", "FORCE_LONGEST_PREFIX_MATCH", "PREFIX_MATCH", "SUFFIX_MATCH", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type match_type: str
+
+        """
+        self.swagger_types = {
+            'match_type': 'str'
+        }
+
+        self.attribute_map = {
+            'match_type': 'matchType'
+        }
+
+        self._match_type = None
+
+    @property
+    def match_type(self):
+        """
+        **[Required]** Gets the match_type of this PathMatchType.
+        Specifies how the load balancing service compares a :func:`path_route`
+        object's `path` string against the incoming URI.
+
+        *  **EXACT_MATCH** - Looks for a `path` string that exactly matches the incoming URI path.
+
+        *  **FORCE_LONGEST_PREFIX_MATCH** - Looks for the `path` string with the best, longest match of the beginning
+           portion of the incoming URI path.
+
+        *  **PREFIX_MATCH** - Looks for a `path` string that matches the beginning portion of the incoming URI path.
+
+        *  **SUFFIX_MATCH** - Looks for a `path` string that matches the ending portion of the incoming URI path.
+
+        For a full description of how the system handles `matchType` in a path route set containing multiple rules, see
+        `Managing Request Routing`__.
+
+        __ https://docs.cloud.oracle.com/Content/Balance/Tasks/managingrequest.htm
+
+        Allowed values for this property are: "EXACT_MATCH", "FORCE_LONGEST_PREFIX_MATCH", "PREFIX_MATCH", "SUFFIX_MATCH", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The match_type of this PathMatchType.
+        :rtype: str
+        """
+        return self._match_type
+
+    @match_type.setter
+    def match_type(self, match_type):
+        """
+        Sets the match_type of this PathMatchType.
+        Specifies how the load balancing service compares a :func:`path_route`
+        object's `path` string against the incoming URI.
+
+        *  **EXACT_MATCH** - Looks for a `path` string that exactly matches the incoming URI path.
+
+        *  **FORCE_LONGEST_PREFIX_MATCH** - Looks for the `path` string with the best, longest match of the beginning
+           portion of the incoming URI path.
+
+        *  **PREFIX_MATCH** - Looks for a `path` string that matches the beginning portion of the incoming URI path.
+
+        *  **SUFFIX_MATCH** - Looks for a `path` string that matches the ending portion of the incoming URI path.
+
+        For a full description of how the system handles `matchType` in a path route set containing multiple rules, see
+        `Managing Request Routing`__.
+
+        __ https://docs.cloud.oracle.com/Content/Balance/Tasks/managingrequest.htm
+
+
+        :param match_type: The match_type of this PathMatchType.
+        :type: str
+        """
+        allowed_values = ["EXACT_MATCH", "FORCE_LONGEST_PREFIX_MATCH", "PREFIX_MATCH", "SUFFIX_MATCH"]
+        if not value_allowed_none_or_none_sentinel(match_type, allowed_values):
+            match_type = 'UNKNOWN_ENUM_VALUE'
+        self._match_type = match_type
+
+    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/path_route.py

@@ -0,0 +1,156 @@
+# 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 PathRoute(object):
+    """
+    A \"path route rule\" to evaluate an incoming URI path, and then route a matching request to the specified backend set.
+
+    Path route rules apply only to HTTP and HTTPS requests. They have no effect on TCP requests.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new PathRoute object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param path:
+            The value to assign to the path property of this PathRoute.
+        :type path: str
+
+        :param path_match_type:
+            The value to assign to the path_match_type property of this PathRoute.
+        :type path_match_type: oci.load_balancer.models.PathMatchType
+
+        :param backend_set_name:
+            The value to assign to the backend_set_name property of this PathRoute.
+        :type backend_set_name: str
+
+        """
+        self.swagger_types = {
+            'path': 'str',
+            'path_match_type': 'PathMatchType',
+            'backend_set_name': 'str'
+        }
+
+        self.attribute_map = {
+            'path': 'path',
+            'path_match_type': 'pathMatchType',
+            'backend_set_name': 'backendSetName'
+        }
+
+        self._path = None
+        self._path_match_type = None
+        self._backend_set_name = None
+
+    @property
+    def path(self):
+        """
+        **[Required]** Gets the path of this PathRoute.
+        The path string to match against the incoming URI path.
+
+        *  Path strings are case-insensitive.
+
+        *  Asterisk (*) wildcards are not supported.
+
+        *  Regular expressions are not supported.
+
+        Example: `/example/video/123`
+
+
+        :return: The path of this PathRoute.
+        :rtype: str
+        """
+        return self._path
+
+    @path.setter
+    def path(self, path):
+        """
+        Sets the path of this PathRoute.
+        The path string to match against the incoming URI path.
+
+        *  Path strings are case-insensitive.
+
+        *  Asterisk (*) wildcards are not supported.
+
+        *  Regular expressions are not supported.
+
+        Example: `/example/video/123`
+
+
+        :param path: The path of this PathRoute.
+        :type: str
+        """
+        self._path = path
+
+    @property
+    def path_match_type(self):
+        """
+        **[Required]** Gets the path_match_type of this PathRoute.
+        The type of matching to apply to incoming URIs.
+
+
+        :return: The path_match_type of this PathRoute.
+        :rtype: oci.load_balancer.models.PathMatchType
+        """
+        return self._path_match_type
+
+    @path_match_type.setter
+    def path_match_type(self, path_match_type):
+        """
+        Sets the path_match_type of this PathRoute.
+        The type of matching to apply to incoming URIs.
+
+
+        :param path_match_type: The path_match_type of this PathRoute.
+        :type: oci.load_balancer.models.PathMatchType
+        """
+        self._path_match_type = path_match_type
+
+    @property
+    def backend_set_name(self):
+        """
+        **[Required]** Gets the backend_set_name of this PathRoute.
+        The name of the target backend set for requests where the incoming URI matches the specified path.
+
+        Example: `example_backend_set`
+
+
+        :return: The backend_set_name of this PathRoute.
+        :rtype: str
+        """
+        return self._backend_set_name
+
+    @backend_set_name.setter
+    def backend_set_name(self, backend_set_name):
+        """
+        Sets the backend_set_name of this PathRoute.
+        The name of the target backend set for requests where the incoming URI matches the specified path.
+
+        Example: `example_backend_set`
+
+
+        :param backend_set_name: The backend_set_name of this PathRoute.
+        :type: str
+        """
+        self._backend_set_name = backend_set_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/path_route_set.py

@@ -0,0 +1,112 @@
+# 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 PathRouteSet(object):
+    """
+    A named set of path route rules. For more information, see
+    `Managing Request Routing`__.
+
+    **Warning:** 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/managingrequest.htm
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new PathRouteSet 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 PathRouteSet.
+        :type name: str
+
+        :param path_routes:
+            The value to assign to the path_routes property of this PathRouteSet.
+        :type path_routes: list[oci.load_balancer.models.PathRoute]
+
+        """
+        self.swagger_types = {
+            'name': 'str',
+            'path_routes': 'list[PathRoute]'
+        }
+
+        self.attribute_map = {
+            'name': 'name',
+            'path_routes': 'pathRoutes'
+        }
+
+        self._name = None
+        self._path_routes = None
+
+    @property
+    def name(self):
+        """
+        **[Required]** Gets the name of this PathRouteSet.
+        The unique name for this set of path route rules. Avoid entering confidential information.
+
+        Example: `example_path_route_set`
+
+
+        :return: The name of this PathRouteSet.
+        :rtype: str
+        """
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        """
+        Sets the name of this PathRouteSet.
+        The unique name for this set of path route rules. Avoid entering confidential information.
+
+        Example: `example_path_route_set`
+
+
+        :param name: The name of this PathRouteSet.
+        :type: str
+        """
+        self._name = name
+
+    @property
+    def path_routes(self):
+        """
+        **[Required]** Gets the path_routes of this PathRouteSet.
+        The set of path route rules.
+
+
+        :return: The path_routes of this PathRouteSet.
+        :rtype: list[oci.load_balancer.models.PathRoute]
+        """
+        return self._path_routes
+
+    @path_routes.setter
+    def path_routes(self, path_routes):
+        """
+        Sets the path_routes of this PathRouteSet.
+        The set of path route rules.
+
+
+        :param path_routes: The path_routes of this PathRouteSet.
+        :type: list[oci.load_balancer.models.PathRoute]
+        """
+        self._path_routes = path_routes
+
+    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/path_route_set_details.py

@@ -0,0 +1,72 @@
+# 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 PathRouteSetDetails(object):
+    """
+    A set of path route rules.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new PathRouteSetDetails object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param path_routes:
+            The value to assign to the path_routes property of this PathRouteSetDetails.
+        :type path_routes: list[oci.load_balancer.models.PathRoute]
+
+        """
+        self.swagger_types = {
+            'path_routes': 'list[PathRoute]'
+        }
+
+        self.attribute_map = {
+            'path_routes': 'pathRoutes'
+        }
+
+        self._path_routes = None
+
+    @property
+    def path_routes(self):
+        """
+        **[Required]** Gets the path_routes of this PathRouteSetDetails.
+        The set of path route rules.
+
+
+        :return: The path_routes of this PathRouteSetDetails.
+        :rtype: list[oci.load_balancer.models.PathRoute]
+        """
+        return self._path_routes
+
+    @path_routes.setter
+    def path_routes(self, path_routes):
+        """
+        Sets the path_routes of this PathRouteSetDetails.
+        The set of path route rules.
+
+
+        :param path_routes: The path_routes of this PathRouteSetDetails.
+        :type: list[oci.load_balancer.models.PathRoute]
+        """
+        self._path_routes = path_routes
+
+    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