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

Class Config.Rule

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Config.RuleOrBuilder, 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.
 [#next-free-field: 6]
    Protobuf type envoy.extensions.filters.http.header_to_metadata.v3.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 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

      • getHeader

        public String getHeader()
         Specifies that a match will be performed on the value of a header or a cookie.
 The header to be extracted.
        string header = 1 [(.validate.rules) = { ... }
        Specified by:
        getHeader in interface Config.RuleOrBuilder
        Returns:
        The header.

      • getHeaderBytes

        public com.google.protobuf.ByteString getHeaderBytes()
         Specifies that a match will be performed on the value of a header or a cookie.
 The header to be extracted.
        string header = 1 [(.validate.rules) = { ... }
        Specified by:
        getHeaderBytes in interface Config.RuleOrBuilder
        Returns:
        The bytes for header.

      • getCookie

        public String getCookie()
         The cookie to be extracted.
        string cookie = 5 [(.validate.rules) = { ... }
        Specified by:
        getCookie in interface Config.RuleOrBuilder
        Returns:
        The cookie.

      • getCookieBytes

        public com.google.protobuf.ByteString getCookieBytes()
         The cookie to be extracted.
        string cookie = 5 [(.validate.rules) = { ... }
        Specified by:
        getCookieBytes in interface Config.RuleOrBuilder
        Returns:
        The bytes for cookie.

      • hasOnHeaderPresent

        public boolean hasOnHeaderPresent()
         If the header or cookie is present, apply this metadata KeyValuePair.
 If the value in the KeyValuePair is non-empty, it'll be used instead
 of the header or cookie value.
        .envoy.extensions.filters.http.header_to_metadata.v3.Config.KeyValuePair on_header_present = 2 [(.udpa.annotations.field_migrate) = { ... }
        Specified by:
        hasOnHeaderPresent in interface Config.RuleOrBuilder
        Returns:
        Whether the onHeaderPresent field is set.

      • getOnHeaderPresent

        public Config.KeyValuePair getOnHeaderPresent()
         If the header or cookie is present, apply this metadata KeyValuePair.
 If the value in the KeyValuePair is non-empty, it'll be used instead
 of the header or cookie value.
        .envoy.extensions.filters.http.header_to_metadata.v3.Config.KeyValuePair on_header_present = 2 [(.udpa.annotations.field_migrate) = { ... }
        Specified by:
        getOnHeaderPresent in interface Config.RuleOrBuilder
        Returns:
        The onHeaderPresent.

      • getOnHeaderPresentOrBuilder

        public Config.KeyValuePairOrBuilder getOnHeaderPresentOrBuilder()
         If the header or cookie is present, apply this metadata KeyValuePair.
 If the value in the KeyValuePair is non-empty, it'll be used instead
 of the header or cookie value.
        .envoy.extensions.filters.http.header_to_metadata.v3.Config.KeyValuePair on_header_present = 2 [(.udpa.annotations.field_migrate) = { ... }
        Specified by:
        getOnHeaderPresentOrBuilder in interface Config.RuleOrBuilder

      • hasOnHeaderMissing

        public boolean hasOnHeaderMissing()
         If the header or cookie 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 or cookie value.
        .envoy.extensions.filters.http.header_to_metadata.v3.Config.KeyValuePair on_header_missing = 3 [(.udpa.annotations.field_migrate) = { ... }
        Specified by:
        hasOnHeaderMissing in interface Config.RuleOrBuilder
        Returns:
        Whether the onHeaderMissing field is set.

      • getOnHeaderMissing

        public Config.KeyValuePair getOnHeaderMissing()
         If the header or cookie 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 or cookie value.
        .envoy.extensions.filters.http.header_to_metadata.v3.Config.KeyValuePair on_header_missing = 3 [(.udpa.annotations.field_migrate) = { ... }
        Specified by:
        getOnHeaderMissing in interface Config.RuleOrBuilder
        Returns:
        The onHeaderMissing.

      • getOnHeaderMissingOrBuilder

        public Config.KeyValuePairOrBuilder getOnHeaderMissingOrBuilder()
         If the header or cookie 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 or cookie value.
        .envoy.extensions.filters.http.header_to_metadata.v3.Config.KeyValuePair on_header_missing = 3 [(.udpa.annotations.field_migrate) = { ... }
        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.
 This field is not supported in case of a cookie.
        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 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 Config.Rule parseFrom​(ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Config.Rule parseFrom​(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​(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException
        Throws:
        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