Package io.envoyproxy.envoy.config.filter.http.header_to_metadata.v2

Class Config.Rule

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Config.RuleOrBuilder, java.io.Serializable
    Enclosing class:
    Config
    public static final class Config.Rule
extends com.google.protobuf.GeneratedMessageV3
implements Config.RuleOrBuilder
     A Rule defines what metadata to apply when a header is present or missing.
    Protobuf type envoy.config.filter.http.header_to_metadata.v2.Config.Rule
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Config.Rule.Builder
      A Rule defines what metadata to apply when a header is present or missing.

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

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      static Config.Rule getDefaultInstance()  
      Config.Rule getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      java.lang.String getHeader()
      The header that triggers this rule — required.
      com.google.protobuf.ByteString getHeaderBytes()
      The header that triggers this rule — required.
      Config.KeyValuePair getOnHeaderMissing()
      If the header is not present, apply this metadata KeyValuePair.
      Config.KeyValuePairOrBuilder getOnHeaderMissingOrBuilder()
      If the header is not present, apply this metadata KeyValuePair.
      Config.KeyValuePair getOnHeaderPresent()
      If the header is present, apply this metadata KeyValuePair.
      Config.KeyValuePairOrBuilder getOnHeaderPresentOrBuilder()
      If the header is present, apply this metadata KeyValuePair.
      com.google.protobuf.Parser<Config.Rule> getParserForType()  
      boolean getRemove()
      Whether or not to remove the header after a rule is applied.
      int getSerializedSize()  
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      int hashCode()  
      boolean hasOnHeaderMissing()
      If the header is not present, apply this metadata KeyValuePair.
      boolean hasOnHeaderPresent()
      If the header is present, apply this metadata KeyValuePair.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static Config.Rule.Builder newBuilder()  
      static Config.Rule.Builder newBuilder​(Config.Rule prototype)  
      Config.Rule.Builder newBuilderForType()  
      protected Config.Rule.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static Config.Rule parseDelimitedFrom​(java.io.InputStream input)  
      static Config.Rule parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Config.Rule parseFrom​(byte[] data)  
      static Config.Rule parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Config.Rule parseFrom​(com.google.protobuf.ByteString data)  
      static Config.Rule parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Config.Rule parseFrom​(com.google.protobuf.CodedInputStream input)  
      static Config.Rule parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Config.Rule parseFrom​(java.io.InputStream input)  
      static Config.Rule parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Config.Rule parseFrom​(java.nio.ByteBuffer data)  
      static Config.Rule parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<Config.Rule> parser()  
      Config.Rule.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, 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, hasField, hasOneof

    • Field Detail

      • ON_HEADER_PRESENT_FIELD_NUMBER

        public static final int ON_HEADER_PRESENT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ON_HEADER_MISSING_FIELD_NUMBER

        public static final int ON_HEADER_MISSING_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.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

      • getHeader

        public java.lang.String getHeader()
         The header that triggers this rule — required.
        string header = 1 [(.validate.rules) = { ... }
        Specified by:
        getHeader in interface Config.RuleOrBuilder
        Returns:
        The header.

      • getHeaderBytes

        public com.google.protobuf.ByteString getHeaderBytes()
         The header that triggers this rule — required.
        string header = 1 [(.validate.rules) = { ... }
        Specified by:
        getHeaderBytes in interface Config.RuleOrBuilder
        Returns:
        The bytes for header.

      • hasOnHeaderPresent

        public boolean hasOnHeaderPresent()
         If the header is present, apply this metadata KeyValuePair.
 If the value in the KeyValuePair is non-empty, it'll be used instead
 of the header value.
        .envoy.config.filter.http.header_to_metadata.v2.Config.KeyValuePair on_header_present = 2;
        Specified by:
        hasOnHeaderPresent in interface Config.RuleOrBuilder
        Returns:
        Whether the onHeaderPresent field is set.

      • getOnHeaderPresent

        public Config.KeyValuePair getOnHeaderPresent()
         If the header is present, apply this metadata KeyValuePair.
 If the value in the KeyValuePair is non-empty, it'll be used instead
 of the header value.
        .envoy.config.filter.http.header_to_metadata.v2.Config.KeyValuePair on_header_present = 2;
        Specified by:
        getOnHeaderPresent in interface Config.RuleOrBuilder
        Returns:
        The onHeaderPresent.

      • getOnHeaderPresentOrBuilder

        public Config.KeyValuePairOrBuilder getOnHeaderPresentOrBuilder()
         If the header is present, apply this metadata KeyValuePair.
 If the value in the KeyValuePair is non-empty, it'll be used instead
 of the header value.
        .envoy.config.filter.http.header_to_metadata.v2.Config.KeyValuePair on_header_present = 2;
        Specified by:
        getOnHeaderPresentOrBuilder in interface Config.RuleOrBuilder

      • hasOnHeaderMissing

        public boolean hasOnHeaderMissing()
         If the header is not present, apply this metadata KeyValuePair.
 The value in the KeyValuePair must be set, since it'll be used in lieu
 of the missing header value.
        .envoy.config.filter.http.header_to_metadata.v2.Config.KeyValuePair on_header_missing = 3;
        Specified by:
        hasOnHeaderMissing in interface Config.RuleOrBuilder
        Returns:
        Whether the onHeaderMissing field is set.

      • getOnHeaderMissing

        public Config.KeyValuePair getOnHeaderMissing()
         If the header is not present, apply this metadata KeyValuePair.
 The value in the KeyValuePair must be set, since it'll be used in lieu
 of the missing header value.
        .envoy.config.filter.http.header_to_metadata.v2.Config.KeyValuePair on_header_missing = 3;
        Specified by:
        getOnHeaderMissing in interface Config.RuleOrBuilder
        Returns:
        The onHeaderMissing.

      • getOnHeaderMissingOrBuilder

        public Config.KeyValuePairOrBuilder getOnHeaderMissingOrBuilder()
         If the header is not present, apply this metadata KeyValuePair.
 The value in the KeyValuePair must be set, since it'll be used in lieu
 of the missing header value.
        .envoy.config.filter.http.header_to_metadata.v2.Config.KeyValuePair on_header_missing = 3;
        Specified by:
        getOnHeaderMissingOrBuilder in interface Config.RuleOrBuilder

      • getRemove

        public boolean getRemove()
         Whether or not to remove the header after a rule is applied.
 This prevents headers from leaking.
        bool remove = 4;
        Specified by:
        getRemove in interface Config.RuleOrBuilder
        Returns:
        The remove.

      • 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 java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.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​(java.lang.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 Config.Rule parseFrom​(java.nio.ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Config.Rule parseFrom​(java.nio.ByteBuffer data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static Config.Rule parseFrom​(java.io.InputStream input)
                             throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Config.Rule parseFrom​(java.io.InputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static Config.Rule parseDelimitedFrom​(java.io.InputStream input)
                                      throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static Config.Rule parseDelimitedFrom​(java.io.InputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Config.Rule parseFrom​(com.google.protobuf.CodedInputStream input)
                             throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Config.Rule parseFrom​(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Config.Rule getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<Config.Rule> 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 Config.Rule getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder