# octavia.api.v2.types.l7rule

# Source code for octavia.api.v2.types.l7rule

    #    Copyright 2016 Blue Box, an IBM Company
    #
    #    Licensed under the Apache License, Version 2.0 (the "License"); you may
    #    not use this file except in compliance with the License. You may obtain
    #    a copy of the License at
    #
    #         http://www.apache.org/licenses/LICENSE-2.0
    #
    #    Unless required by applicable law or agreed to in writing, software
    #    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
    #    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
    #    License for the specific language governing permissions and limitations
    #    under the License.

    from wsme import types as wtypes

    from octavia.api.common import types
    from octavia.common import constants

    class BaseL7Type(types.BaseType):
        _type_to_model_map = {'admin_state_up': 'enabled'}
        _child_map = {}

    class L7RuleResponse(BaseL7Type):
        """Defines which attributes are to be shown on any response."""
        id = wtypes.wsattr(wtypes.UuidType())
        type = wtypes.wsattr(wtypes.StringType())
        compare_type = wtypes.wsattr(wtypes.StringType())
        key = wtypes.wsattr(wtypes.StringType())
        value = wtypes.wsattr(wtypes.StringType())
        invert = wtypes.wsattr(bool)
        provisioning_status = wtypes.wsattr(wtypes.StringType())
        operating_status = wtypes.wsattr(wtypes.StringType())
        created_at = wtypes.wsattr(wtypes.datetime.datetime)
        updated_at = wtypes.wsattr(wtypes.datetime.datetime)
        project_id = wtypes.wsattr(wtypes.StringType())
        admin_state_up = wtypes.wsattr(bool)
        tags = wtypes.wsattr(wtypes.ArrayType(wtypes.StringType()))

        @classmethod
        def from_data_model(cls, data_model, children=False):
            rule = super().from_data_model(
                data_model, children=children)
            return rule

    class L7RuleFullResponse(L7RuleResponse):
        @classmethod
        def _full_response(cls):
            return True

    class L7RuleRootResponse(types.BaseType):
        rule = wtypes.wsattr(L7RuleResponse)

    class L7RulesRootResponse(types.BaseType):
        rules = wtypes.wsattr([L7RuleResponse])
        rules_links = wtypes.wsattr([types.PageType])

    class L7RulePOST(BaseL7Type):
        """Defines mandatory and optional attributes of a POST request."""
        type = wtypes.wsattr(
            wtypes.Enum(str, *constants.SUPPORTED_L7RULE_TYPES),
            mandatory=True)
        compare_type = wtypes.wsattr(
            wtypes.Enum(str, *constants.SUPPORTED_L7RULE_COMPARE_TYPES),
            mandatory=True)
        key = wtypes.wsattr(wtypes.StringType(max_length=255,
                                              pattern=r'^[^\r\n]*$'))
        value = wtypes.wsattr(wtypes.StringType(max_length=255,
                                                pattern=r'^[^\r\n]*$'),
                              mandatory=True)
        invert = wtypes.wsattr(bool, default=False)
        admin_state_up = wtypes.wsattr(bool, default=True)
        # TODO(johnsom) Remove after deprecation (R series)
        project_id = wtypes.wsattr(wtypes.StringType(max_length=36))
        tags = wtypes.wsattr(wtypes.ArrayType(wtypes.StringType(max_length=255)))

    class L7RuleRootPOST(types.BaseType):
        rule = wtypes.wsattr(L7RulePOST)

    class L7RulePUT(BaseL7Type):
        """Defines attributes that are acceptable of a PUT request."""
        type = wtypes.wsattr(
            wtypes.Enum(str,
                        *constants.SUPPORTED_L7RULE_TYPES))
        compare_type = wtypes.wsattr(
            wtypes.Enum(str,
                        *constants.SUPPORTED_L7RULE_COMPARE_TYPES))
        key = wtypes.wsattr(wtypes.StringType(max_length=255,
                                              pattern=r'^[^\r\n]*$'))
        value = wtypes.wsattr(wtypes.StringType(max_length=255,
                                                pattern=r'^[^\r\n]*$'))
        invert = wtypes.wsattr(bool)
        admin_state_up = wtypes.wsattr(bool)
        tags = wtypes.wsattr(wtypes.ArrayType(wtypes.StringType(max_length=255)))

    class L7RuleRootPUT(types.BaseType):
        rule = wtypes.wsattr(L7RulePUT)

    class L7RuleSingleCreate(BaseL7Type):
        """Defines mandatory and optional attributes of a POST request."""
        type = wtypes.wsattr(
            wtypes.Enum(str, *constants.SUPPORTED_L7RULE_TYPES),
            mandatory=True)
        compare_type = wtypes.wsattr(
            wtypes.Enum(str, *constants.SUPPORTED_L7RULE_COMPARE_TYPES),
            mandatory=True)
        key = wtypes.wsattr(wtypes.StringType(max_length=255))
        value = wtypes.wsattr(wtypes.StringType(max_length=255), mandatory=True)
        invert = wtypes.wsattr(bool, default=False)
        admin_state_up = wtypes.wsattr(bool, default=True)
        tags = wtypes.wsattr(wtypes.ArrayType(wtypes.StringType(max_length=255)))

this page last updated: 2026-04-13 15:26:39

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

found an error? report a bug