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

Interface Config.KeyValuePairOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Config.KeyValuePair, Config.KeyValuePair.Builder
Enclosing class:
Config
public static interface Config.KeyValuePairOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    Config.ValueEncode
    getEncode()
    How is the value encoded, default is NONE (not encoded).
    int
    getEncodeValue()
    How is the value encoded, default is NONE (not encoded).
    String
    getKey()
    The key to use within the namespace.
    com.google.protobuf.ByteString
    getKeyBytes()
    The key to use within the namespace.
    String
    getMetadataNamespace()
    The namespace — if this is empty, the filter's namespace will be used.
    com.google.protobuf.ByteString
    getMetadataNamespaceBytes()
    The namespace — if this is empty, the filter's namespace will be used.
    RegexMatchAndSubstitute
    getRegexValueRewrite()
    If present, the header's value will be matched and substituted with this.
    RegexMatchAndSubstituteOrBuilder
    getRegexValueRewriteOrBuilder()
    If present, the header's value will be matched and substituted with this.
    Config.ValueType
    getType()
    The value's type — defaults to string.
    int
    getTypeValue()
    The value's type — defaults to string.
    String
    getValue()
    The value to pair with the given key.
    com.google.protobuf.ByteString
    getValueBytes()
    The value to pair with the given key.
    boolean
    hasRegexValueRewrite()
    If present, the header's value will be matched and substituted with this.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getMetadataNamespace

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

    • getMetadataNamespaceBytes

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

    • getKey

      String getKey()
       The key to use within the namespace.
      string key = 2 [(.validate.rules) = { ... }
      Returns:
      The key.

    • getKeyBytes

      com.google.protobuf.ByteString getKeyBytes()
       The key to use within the namespace.
      string key = 2 [(.validate.rules) = { ... }
      Returns:
      The bytes for key.

    • getValue

      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) = { ... }
      Returns:
      The value.

    • getValueBytes

      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) = { ... }
      Returns:
      The bytes for value.

    • hasRegexValueRewrite

      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) = { ... }
      Returns:
      Whether the regexValueRewrite field is set.

    • getRegexValueRewrite

      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) = { ... }
      Returns:
      The regexValueRewrite.

    • getRegexValueRewriteOrBuilder

      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) = { ... }

    • getTypeValue

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

    • getType

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

    • getEncodeValue

      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;
      Returns:
      The enum numeric value on the wire for encode.

    • getEncode

      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;
      Returns:
      The encode.