Package io.envoyproxy.envoy.config.common.mutation_rules.v3

Interface HeaderMutationRulesOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    HeaderMutationRules, HeaderMutationRules.Builder
    public interface HeaderMutationRulesOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.google.protobuf.BoolValue getAllowAllRouting()
      By default, certain headers that could affect processing of subsequent filters or request routing cannot be modified.
      com.google.protobuf.BoolValueOrBuilder getAllowAllRoutingOrBuilder()
      By default, certain headers that could affect processing of subsequent filters or request routing cannot be modified.
      com.google.protobuf.BoolValue getAllowEnvoy()
      If true, allow modification of envoy internal headers.
      com.google.protobuf.BoolValueOrBuilder getAllowEnvoyOrBuilder()
      If true, allow modification of envoy internal headers.
      RegexMatcher getAllowExpression()
      If set, specifically allow any header that matches this regular expression.
      RegexMatcherOrBuilder getAllowExpressionOrBuilder()
      If set, specifically allow any header that matches this regular expression.
      com.google.protobuf.BoolValue getDisallowAll()
      If true, prevent modifications of all header values, regardless of any other settings.
      com.google.protobuf.BoolValueOrBuilder getDisallowAllOrBuilder()
      If true, prevent modifications of all header values, regardless of any other settings.
      RegexMatcher getDisallowExpression()
      If set, specifically disallow any header that matches this regular expression regardless of any other settings.
      RegexMatcherOrBuilder getDisallowExpressionOrBuilder()
      If set, specifically disallow any header that matches this regular expression regardless of any other settings.
      com.google.protobuf.BoolValue getDisallowIsError()
      If true, and if the rules in this list cause a header mutation to be disallowed, then the filter using this configuration will terminate the request with a 500 error.
      com.google.protobuf.BoolValueOrBuilder getDisallowIsErrorOrBuilder()
      If true, and if the rules in this list cause a header mutation to be disallowed, then the filter using this configuration will terminate the request with a 500 error.
      com.google.protobuf.BoolValue getDisallowSystem()
      If true, prevent modification of any system header, defined as a header that starts with a ``:`` character, regardless of any other settings.
      com.google.protobuf.BoolValueOrBuilder getDisallowSystemOrBuilder()
      If true, prevent modification of any system header, defined as a header that starts with a ``:`` character, regardless of any other settings.
      boolean hasAllowAllRouting()
      By default, certain headers that could affect processing of subsequent filters or request routing cannot be modified.
      boolean hasAllowEnvoy()
      If true, allow modification of envoy internal headers.
      boolean hasAllowExpression()
      If set, specifically allow any header that matches this regular expression.
      boolean hasDisallowAll()
      If true, prevent modifications of all header values, regardless of any other settings.
      boolean hasDisallowExpression()
      If set, specifically disallow any header that matches this regular expression regardless of any other settings.
      boolean hasDisallowIsError()
      If true, and if the rules in this list cause a header mutation to be disallowed, then the filter using this configuration will terminate the request with a 500 error.
      boolean hasDisallowSystem()
      If true, prevent modification of any system header, defined as a header that starts with a ``:`` character, regardless of any other settings.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • hasAllowAllRouting

        boolean hasAllowAllRouting()
         By default, certain headers that could affect processing of subsequent
 filters or request routing cannot be modified. These headers are
 ``host``, ``:authority``, ``:scheme``, and ``:method``. Setting this parameter
 to true allows these headers to be modified as well.
        .google.protobuf.BoolValue allow_all_routing = 1;
        Returns:
        Whether the allowAllRouting field is set.

      • getAllowAllRouting

        com.google.protobuf.BoolValue getAllowAllRouting()
         By default, certain headers that could affect processing of subsequent
 filters or request routing cannot be modified. These headers are
 ``host``, ``:authority``, ``:scheme``, and ``:method``. Setting this parameter
 to true allows these headers to be modified as well.
        .google.protobuf.BoolValue allow_all_routing = 1;
        Returns:
        The allowAllRouting.

      • getAllowAllRoutingOrBuilder

        com.google.protobuf.BoolValueOrBuilder getAllowAllRoutingOrBuilder()
         By default, certain headers that could affect processing of subsequent
 filters or request routing cannot be modified. These headers are
 ``host``, ``:authority``, ``:scheme``, and ``:method``. Setting this parameter
 to true allows these headers to be modified as well.
        .google.protobuf.BoolValue allow_all_routing = 1;

      • hasAllowEnvoy

        boolean hasAllowEnvoy()
         If true, allow modification of envoy internal headers. By default, these
 start with ``x-envoy`` but this may be overridden in the ``Bootstrap``
 configuration using the
 :ref:`header_prefix <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.header_prefix>`
 field. Default is false.
        .google.protobuf.BoolValue allow_envoy = 2;
        Returns:
        Whether the allowEnvoy field is set.

      • getAllowEnvoy

        com.google.protobuf.BoolValue getAllowEnvoy()
         If true, allow modification of envoy internal headers. By default, these
 start with ``x-envoy`` but this may be overridden in the ``Bootstrap``
 configuration using the
 :ref:`header_prefix <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.header_prefix>`
 field. Default is false.
        .google.protobuf.BoolValue allow_envoy = 2;
        Returns:
        The allowEnvoy.

      • getAllowEnvoyOrBuilder

        com.google.protobuf.BoolValueOrBuilder getAllowEnvoyOrBuilder()
         If true, allow modification of envoy internal headers. By default, these
 start with ``x-envoy`` but this may be overridden in the ``Bootstrap``
 configuration using the
 :ref:`header_prefix <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.header_prefix>`
 field. Default is false.
        .google.protobuf.BoolValue allow_envoy = 2;

      • hasDisallowSystem

        boolean hasDisallowSystem()
         If true, prevent modification of any system header, defined as a header
 that starts with a ``:`` character, regardless of any other settings.
 A processing server may still override the ``:status`` of an HTTP response
 using an ``ImmediateResponse`` message. Default is false.
        .google.protobuf.BoolValue disallow_system = 3;
        Returns:
        Whether the disallowSystem field is set.

      • getDisallowSystem

        com.google.protobuf.BoolValue getDisallowSystem()
         If true, prevent modification of any system header, defined as a header
 that starts with a ``:`` character, regardless of any other settings.
 A processing server may still override the ``:status`` of an HTTP response
 using an ``ImmediateResponse`` message. Default is false.
        .google.protobuf.BoolValue disallow_system = 3;
        Returns:
        The disallowSystem.

      • getDisallowSystemOrBuilder

        com.google.protobuf.BoolValueOrBuilder getDisallowSystemOrBuilder()
         If true, prevent modification of any system header, defined as a header
 that starts with a ``:`` character, regardless of any other settings.
 A processing server may still override the ``:status`` of an HTTP response
 using an ``ImmediateResponse`` message. Default is false.
        .google.protobuf.BoolValue disallow_system = 3;

      • hasDisallowAll

        boolean hasDisallowAll()
         If true, prevent modifications of all header values, regardless of any
 other settings. A processing server may still override the ``:status``
 of an HTTP response using an ``ImmediateResponse`` message. Default is false.
        .google.protobuf.BoolValue disallow_all = 4;
        Returns:
        Whether the disallowAll field is set.

      • getDisallowAll

        com.google.protobuf.BoolValue getDisallowAll()
         If true, prevent modifications of all header values, regardless of any
 other settings. A processing server may still override the ``:status``
 of an HTTP response using an ``ImmediateResponse`` message. Default is false.
        .google.protobuf.BoolValue disallow_all = 4;
        Returns:
        The disallowAll.

      • getDisallowAllOrBuilder

        com.google.protobuf.BoolValueOrBuilder getDisallowAllOrBuilder()
         If true, prevent modifications of all header values, regardless of any
 other settings. A processing server may still override the ``:status``
 of an HTTP response using an ``ImmediateResponse`` message. Default is false.
        .google.protobuf.BoolValue disallow_all = 4;

      • hasAllowExpression

        boolean hasAllowExpression()
         If set, specifically allow any header that matches this regular
 expression. This overrides all other settings except for
 ``disallow_expression``.
        .envoy.type.matcher.v3.RegexMatcher allow_expression = 5;
        Returns:
        Whether the allowExpression field is set.

      • getAllowExpression

        RegexMatcher getAllowExpression()
         If set, specifically allow any header that matches this regular
 expression. This overrides all other settings except for
 ``disallow_expression``.
        .envoy.type.matcher.v3.RegexMatcher allow_expression = 5;
        Returns:
        The allowExpression.

      • getAllowExpressionOrBuilder

        RegexMatcherOrBuilder getAllowExpressionOrBuilder()
         If set, specifically allow any header that matches this regular
 expression. This overrides all other settings except for
 ``disallow_expression``.
        .envoy.type.matcher.v3.RegexMatcher allow_expression = 5;

      • hasDisallowExpression

        boolean hasDisallowExpression()
         If set, specifically disallow any header that matches this regular
 expression regardless of any other settings.
        .envoy.type.matcher.v3.RegexMatcher disallow_expression = 6;
        Returns:
        Whether the disallowExpression field is set.

      • getDisallowExpression

        RegexMatcher getDisallowExpression()
         If set, specifically disallow any header that matches this regular
 expression regardless of any other settings.
        .envoy.type.matcher.v3.RegexMatcher disallow_expression = 6;
        Returns:
        The disallowExpression.

      • getDisallowExpressionOrBuilder

        RegexMatcherOrBuilder getDisallowExpressionOrBuilder()
         If set, specifically disallow any header that matches this regular
 expression regardless of any other settings.
        .envoy.type.matcher.v3.RegexMatcher disallow_expression = 6;

      • hasDisallowIsError

        boolean hasDisallowIsError()
         If true, and if the rules in this list cause a header mutation to be
 disallowed, then the filter using this configuration will terminate the
 request with a 500 error. In addition, regardless of the setting of this
 parameter, any attempt to set, add, or modify a disallowed header will
 cause the ``rejected_header_mutations`` counter to be incremented.
 Default is false.
        .google.protobuf.BoolValue disallow_is_error = 7;
        Returns:
        Whether the disallowIsError field is set.

      • getDisallowIsError

        com.google.protobuf.BoolValue getDisallowIsError()
         If true, and if the rules in this list cause a header mutation to be
 disallowed, then the filter using this configuration will terminate the
 request with a 500 error. In addition, regardless of the setting of this
 parameter, any attempt to set, add, or modify a disallowed header will
 cause the ``rejected_header_mutations`` counter to be incremented.
 Default is false.
        .google.protobuf.BoolValue disallow_is_error = 7;
        Returns:
        The disallowIsError.

      • getDisallowIsErrorOrBuilder

        com.google.protobuf.BoolValueOrBuilder getDisallowIsErrorOrBuilder()
         If true, and if the rules in this list cause a header mutation to be
 disallowed, then the filter using this configuration will terminate the
 request with a 500 error. In addition, regardless of the setting of this
 parameter, any attempt to set, add, or modify a disallowed header will
 cause the ``rejected_header_mutations`` counter to be incremented.
 Default is false.
        .google.protobuf.BoolValue disallow_is_error = 7;