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

Class HeaderForwardingRules.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, HeaderForwardingRulesOrBuilder, Cloneable
    Enclosing class:
    HeaderForwardingRules
    public static final class HeaderForwardingRules.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<HeaderForwardingRules.Builder>
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

    • Method Detail

      • 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.Builder<HeaderForwardingRules.Builder>

      • clear

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

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<HeaderForwardingRules.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

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

      • clearField

        public HeaderForwardingRules.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<HeaderForwardingRules.Builder>

      • clearOneof

        public HeaderForwardingRules.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<HeaderForwardingRules.Builder>

      • setRepeatedField

        public HeaderForwardingRules.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      int index,
                                                      Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<HeaderForwardingRules.Builder>

      • addRepeatedField

        public HeaderForwardingRules.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<HeaderForwardingRules.Builder>

      • isInitialized

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

      • mergeFrom

        public HeaderForwardingRules.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<HeaderForwardingRules.Builder>
        Throws:
        IOException

      • 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.

      • setAllowedHeaders

        public HeaderForwardingRules.Builder setAllowedHeaders​(ListStringMatcher value)
         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;

      • setAllowedHeaders

        public HeaderForwardingRules.Builder setAllowedHeaders​(ListStringMatcher.Builder builderForValue)
         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;

      • mergeAllowedHeaders

        public HeaderForwardingRules.Builder mergeAllowedHeaders​(ListStringMatcher value)
         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;

      • clearAllowedHeaders

        public HeaderForwardingRules.Builder clearAllowedHeaders()
         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;

      • getAllowedHeadersBuilder

        public ListStringMatcher.Builder getAllowedHeadersBuilder()
         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;

      • 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.

      • setDisallowedHeaders

        public HeaderForwardingRules.Builder setDisallowedHeaders​(ListStringMatcher value)
         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;

      • setDisallowedHeaders

        public HeaderForwardingRules.Builder setDisallowedHeaders​(ListStringMatcher.Builder builderForValue)
         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;

      • mergeDisallowedHeaders

        public HeaderForwardingRules.Builder mergeDisallowedHeaders​(ListStringMatcher value)
         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;

      • clearDisallowedHeaders

        public HeaderForwardingRules.Builder clearDisallowedHeaders()
         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;

      • getDisallowedHeadersBuilder

        public ListStringMatcher.Builder getDisallowedHeadersBuilder()
         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;

      • 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

      • setUnknownFields

        public final HeaderForwardingRules.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<HeaderForwardingRules.Builder>

      • mergeUnknownFields

        public final HeaderForwardingRules.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<HeaderForwardingRules.Builder>