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

Class Config.KeyValuePair

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Config.KeyValuePairOrBuilder, Serializable
    Enclosing class:
    Config
    public static final class Config.KeyValuePair
extends com.google.protobuf.GeneratedMessageV3
implements Config.KeyValuePairOrBuilder
     [#next-free-field: 7]
    Protobuf type envoy.extensions.filters.http.header_to_metadata.v3.Config.KeyValuePair
    See Also:
    Serialized Form

    • 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

      • getMetadataNamespace

        public String getMetadataNamespace()
         The namespace — if this is empty, the filter's namespace will be used.
        string metadata_namespace = 1;
        Specified by:
        getMetadataNamespace in interface Config.KeyValuePairOrBuilder
        Returns:
        The metadataNamespace.

      • getMetadataNamespaceBytes

        public com.google.protobuf.ByteString getMetadataNamespaceBytes()
         The namespace — if this is empty, the filter's namespace will be used.
        string metadata_namespace = 1;
        Specified by:
        getMetadataNamespaceBytes in interface Config.KeyValuePairOrBuilder
        Returns:
        The bytes for metadataNamespace.

      • getKeyBytes

        public com.google.protobuf.ByteString getKeyBytes()
         The key to use within the namespace.
        string key = 2 [(.validate.rules) = { ... }
        Specified by:
        getKeyBytes in interface Config.KeyValuePairOrBuilder
        Returns:
        The bytes for key.

      • getValue

        public String getValue()
         The value to pair with the given key.
 When used for a
 :ref:`on_header_present <envoy_v3_api_field_extensions.filters.http.header_to_metadata.v3.Config.Rule.on_header_present>`
 case, if value is non-empty it'll be used instead of the header value. If both are empty, no metadata is added.
 When used for a :ref:`on_header_missing <envoy_v3_api_field_extensions.filters.http.header_to_metadata.v3.Config.Rule.on_header_missing>`
 case, a non-empty value must be provided otherwise no metadata is added.
        string value = 3 [(.udpa.annotations.field_migrate) = { ... }
        Specified by:
        getValue in interface Config.KeyValuePairOrBuilder
        Returns:
        The value.

      • getValueBytes

        public com.google.protobuf.ByteString getValueBytes()
         The value to pair with the given key.
 When used for a
 :ref:`on_header_present <envoy_v3_api_field_extensions.filters.http.header_to_metadata.v3.Config.Rule.on_header_present>`
 case, if value is non-empty it'll be used instead of the header value. If both are empty, no metadata is added.
 When used for a :ref:`on_header_missing <envoy_v3_api_field_extensions.filters.http.header_to_metadata.v3.Config.Rule.on_header_missing>`
 case, a non-empty value must be provided otherwise no metadata is added.
        string value = 3 [(.udpa.annotations.field_migrate) = { ... }
        Specified by:
        getValueBytes in interface Config.KeyValuePairOrBuilder
        Returns:
        The bytes for value.

      • hasRegexValueRewrite

        public boolean hasRegexValueRewrite()
         If present, the header's value will be matched and substituted with this. If there is no match or substitution, the header value
 is used as-is.
 This is only used for :ref:`on_header_present <envoy_v3_api_field_extensions.filters.http.header_to_metadata.v3.Config.Rule.on_header_present>`.
 Note: if the ``value`` field is non-empty this field should be empty.
        .envoy.type.matcher.v3.RegexMatchAndSubstitute regex_value_rewrite = 6 [(.udpa.annotations.field_migrate) = { ... }
        Specified by:
        hasRegexValueRewrite in interface Config.KeyValuePairOrBuilder
        Returns:
        Whether the regexValueRewrite field is set.

      • getRegexValueRewrite

        public RegexMatchAndSubstitute getRegexValueRewrite()
         If present, the header's value will be matched and substituted with this. If there is no match or substitution, the header value
 is used as-is.
 This is only used for :ref:`on_header_present <envoy_v3_api_field_extensions.filters.http.header_to_metadata.v3.Config.Rule.on_header_present>`.
 Note: if the ``value`` field is non-empty this field should be empty.
        .envoy.type.matcher.v3.RegexMatchAndSubstitute regex_value_rewrite = 6 [(.udpa.annotations.field_migrate) = { ... }
        Specified by:
        getRegexValueRewrite in interface Config.KeyValuePairOrBuilder
        Returns:
        The regexValueRewrite.

      • getRegexValueRewriteOrBuilder

        public RegexMatchAndSubstituteOrBuilder getRegexValueRewriteOrBuilder()
         If present, the header's value will be matched and substituted with this. If there is no match or substitution, the header value
 is used as-is.
 This is only used for :ref:`on_header_present <envoy_v3_api_field_extensions.filters.http.header_to_metadata.v3.Config.Rule.on_header_present>`.
 Note: if the ``value`` field is non-empty this field should be empty.
        .envoy.type.matcher.v3.RegexMatchAndSubstitute regex_value_rewrite = 6 [(.udpa.annotations.field_migrate) = { ... }
        Specified by:
        getRegexValueRewriteOrBuilder in interface Config.KeyValuePairOrBuilder

      • getTypeValue

        public int getTypeValue()
         The value's type — defaults to string.
        .envoy.extensions.filters.http.header_to_metadata.v3.Config.ValueType type = 4 [(.validate.rules) = { ... }
        Specified by:
        getTypeValue in interface Config.KeyValuePairOrBuilder
        Returns:
        The enum numeric value on the wire for type.

      • getType

        public Config.ValueType getType()
         The value's type — defaults to string.
        .envoy.extensions.filters.http.header_to_metadata.v3.Config.ValueType type = 4 [(.validate.rules) = { ... }
        Specified by:
        getType in interface Config.KeyValuePairOrBuilder
        Returns:
        The type.

      • getEncodeValue

        public int getEncodeValue()
         How is the value encoded, default is NONE (not encoded).
 The value will be decoded accordingly before storing to metadata.
        .envoy.extensions.filters.http.header_to_metadata.v3.Config.ValueEncode encode = 5;
        Specified by:
        getEncodeValue in interface Config.KeyValuePairOrBuilder
        Returns:
        The enum numeric value on the wire for encode.

      • getEncode

        public Config.ValueEncode getEncode()
         How is the value encoded, default is NONE (not encoded).
 The value will be decoded accordingly before storing to metadata.
        .envoy.extensions.filters.http.header_to_metadata.v3.Config.ValueEncode encode = 5;
        Specified by:
        getEncode in interface Config.KeyValuePairOrBuilder
        Returns:
        The encode.

      • 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.KeyValuePair parseFrom​(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static Config.KeyValuePair 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.KeyValuePair parseFrom​(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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