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

Class HeaderForwardingRules

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.http.ext_proc.v3.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:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    HeaderForwardingRules.Builder
    The HeaderForwardingRules structure specifies what headers are allowed to be forwarded to the external processing server.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ALLOWED_HEADERS_FIELD_NUMBER
     
    static final int
    DISALLOWED_HEADERS_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    ListStringMatcher
    getAllowedHeaders()
    If set, specifically allow any header in this list to be forwarded to the external processing server.
    ListStringMatcherOrBuilder
    getAllowedHeadersOrBuilder()
    If set, specifically allow any header in this list to be forwarded to the external processing server.
    static HeaderForwardingRules
    getDefaultInstance()
     
    HeaderForwardingRules
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    ListStringMatcher
    getDisallowedHeaders()
    If set, specifically disallow any header in this list to be forwarded to the external processing server.
    ListStringMatcherOrBuilder
    getDisallowedHeadersOrBuilder()
    If set, specifically disallow any header in this list to be forwarded to the external processing server.
    com.google.protobuf.Parser<HeaderForwardingRules>
    getParserForType()
     
    int
    getSerializedSize()
     
    boolean
    hasAllowedHeaders()
    If set, specifically allow any header in this list to be forwarded to the external processing server.
    boolean
    hasDisallowedHeaders()
    If set, specifically disallow any header in this list to be forwarded to the external processing server.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static HeaderForwardingRules.Builder
    newBuilder()
     
    static HeaderForwardingRules.Builder
    newBuilder(HeaderForwardingRules prototype)
     
    HeaderForwardingRules.Builder
    newBuilderForType()
     
    protected HeaderForwardingRules.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static HeaderForwardingRules
    parseDelimitedFrom(InputStream input)
     
    static HeaderForwardingRules
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static HeaderForwardingRules
    parseFrom(byte[] data)
     
    static HeaderForwardingRules
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static HeaderForwardingRules
    parseFrom(com.google.protobuf.ByteString data)
     
    static HeaderForwardingRules
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static HeaderForwardingRules
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static HeaderForwardingRules
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static HeaderForwardingRules
    parseFrom(InputStream input)
     
    static HeaderForwardingRules
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static HeaderForwardingRules
    parseFrom(ByteBuffer data)
     
    static HeaderForwardingRules
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<HeaderForwardingRules>
    parser()
     
    HeaderForwardingRules.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • ALLOWED_HEADERS_FIELD_NUMBER

      public static final int ALLOWED_HEADERS_FIELD_NUMBER
      See Also:

    • DISALLOWED_HEADERS_FIELD_NUMBER

      public static final int DISALLOWED_HEADERS_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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.

    • getAllowedHeadersOrBuilder

      public ListStringMatcherOrBuilder getAllowedHeadersOrBuilder()
       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:
      getAllowedHeadersOrBuilder in interface HeaderForwardingRulesOrBuilder

    • 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

    • parseFrom

      public static HeaderForwardingRules parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static HeaderForwardingRules parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static HeaderForwardingRules parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static HeaderForwardingRules parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static HeaderForwardingRules parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static HeaderForwardingRules parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static HeaderForwardingRules.Builder newBuilder()

    • newBuilder

      public static HeaderForwardingRules.Builder newBuilder(HeaderForwardingRules prototype)

    • 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

    • getDefaultInstance

      public static HeaderForwardingRules getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<HeaderForwardingRules> parser()

    • 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