Package io.envoyproxy.envoy.extensions.filters.http.ext_proc.v3

Class HeaderForwardingRules

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, HeaderForwardingRulesOrBuilder, Serializable
    public final class HeaderForwardingRules
extends com.google.protobuf.GeneratedMessageV3
implements HeaderForwardingRulesOrBuilder
     The HeaderForwardingRules structure specifies what headers are
 allowed to be forwarded to the external processing server.
 This works as below:
   1. If neither ``allowed_headers`` nor ``disallowed_headers`` is set, all headers are forwarded.
   2. If both ``allowed_headers`` and ``disallowed_headers`` are set, only headers in the
      ``allowed_headers`` but not in the ``disallowed_headers`` are forwarded.
   3. If ``allowed_headers`` is set, and ``disallowed_headers`` is not set, only headers in
      the ``allowed_headers`` are forwarded.
   4. If ``disallowed_headers`` is set, and ``allowed_headers`` is not set, all headers except
      headers in the ``disallowed_headers`` are forwarded.
    Protobuf type envoy.extensions.filters.http.ext_proc.v3.HeaderForwardingRules
    See Also:
    Serialized Form

    • Field Detail

      • ALLOWED_HEADERS_FIELD_NUMBER

        public static final int ALLOWED_HEADERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DISALLOWED_HEADERS_FIELD_NUMBER

        public static final int DISALLOWED_HEADERS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasAllowedHeaders

        public boolean hasAllowedHeaders()
         If set, specifically allow any header in this list to be forwarded to the external
 processing server. This can be overridden by the below ``disallowed_headers``.
        .envoy.type.matcher.v3.ListStringMatcher allowed_headers = 1;
        Specified by:
        hasAllowedHeaders in interface HeaderForwardingRulesOrBuilder
        Returns:
        Whether the allowedHeaders field is set.

      • getAllowedHeaders

        public ListStringMatcher getAllowedHeaders()
         If set, specifically allow any header in this list to be forwarded to the external
 processing server. This can be overridden by the below ``disallowed_headers``.
        .envoy.type.matcher.v3.ListStringMatcher allowed_headers = 1;
        Specified by:
        getAllowedHeaders in interface HeaderForwardingRulesOrBuilder
        Returns:
        The allowedHeaders.

      • hasDisallowedHeaders

        public boolean hasDisallowedHeaders()
         If set, specifically disallow any header in this list to be forwarded to the external
 processing server. This overrides the above ``allowed_headers`` if a header matches both.
        .envoy.type.matcher.v3.ListStringMatcher disallowed_headers = 2;
        Specified by:
        hasDisallowedHeaders in interface HeaderForwardingRulesOrBuilder
        Returns:
        Whether the disallowedHeaders field is set.

      • getDisallowedHeaders

        public ListStringMatcher getDisallowedHeaders()
         If set, specifically disallow any header in this list to be forwarded to the external
 processing server. This overrides the above ``allowed_headers`` if a header matches both.
        .envoy.type.matcher.v3.ListStringMatcher disallowed_headers = 2;
        Specified by:
        getDisallowedHeaders in interface HeaderForwardingRulesOrBuilder
        Returns:
        The disallowedHeaders.

      • getDisallowedHeadersOrBuilder

        public ListStringMatcherOrBuilder getDisallowedHeadersOrBuilder()
         If set, specifically disallow any header in this list to be forwarded to the external
 processing server. This overrides the above ``allowed_headers`` if a header matches both.
        .envoy.type.matcher.v3.ListStringMatcher disallowed_headers = 2;
        Specified by:
        getDisallowedHeadersOrBuilder in interface HeaderForwardingRulesOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static HeaderForwardingRules parseFrom​(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HeaderForwardingRules parseFrom​(ByteBuffer data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HeaderForwardingRules parseFrom​(com.google.protobuf.ByteString data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HeaderForwardingRules parseFrom​(com.google.protobuf.ByteString data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HeaderForwardingRules parseFrom​(byte[] data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HeaderForwardingRules parseFrom​(byte[] data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public HeaderForwardingRules.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public HeaderForwardingRules.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected HeaderForwardingRules.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<HeaderForwardingRules> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public HeaderForwardingRules getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder