Package io.envoyproxy.envoy.extensions.filters.network.thrift_proxy.filters.header_to_metadata.v3

Interface HeaderToMetadata.KeyValuePairOrBuilder

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

  • 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.

    • hasValue

      boolean hasValue()
       The value to pair with the given key.

 When used for on_present case, if value is non-empty it'll be used instead
 of the header value. If both are empty, the header value is used as-is.

 When used for on_missing case, a non-empty value must be provided.
      string value = 3;
      Returns:
      Whether the value field is set.

    • getValue

      String getValue()
       The value to pair with the given key.

 When used for on_present case, if value is non-empty it'll be used instead
 of the header value. If both are empty, the header value is used as-is.

 When used for on_missing case, a non-empty value must be provided.
      string value = 3;
      Returns:
      The value.

    • getValueBytes

      com.google.protobuf.ByteString getValueBytes()
       The value to pair with the given key.

 When used for on_present case, if value is non-empty it'll be used instead
 of the header value. If both are empty, the header value is used as-is.

 When used for on_missing case, a non-empty value must be provided.
      string value = 3;
      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 on_present.
      .envoy.type.matcher.v3.RegexMatchAndSubstitute regex_value_rewrite = 4;
      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 on_present.
      .envoy.type.matcher.v3.RegexMatchAndSubstitute regex_value_rewrite = 4;
      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 on_present.
      .envoy.type.matcher.v3.RegexMatchAndSubstitute regex_value_rewrite = 4;

    • getTypeValue

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

    • getType

      HeaderToMetadata.ValueType getType()
       The value's type — defaults to string.
      .envoy.extensions.filters.network.thrift_proxy.filters.header_to_metadata.v3.HeaderToMetadata.ValueType type = 5 [(.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.network.thrift_proxy.filters.header_to_metadata.v3.HeaderToMetadata.ValueEncode encode = 6;
      Returns:
      The enum numeric value on the wire for encode.

    • getEncode

      HeaderToMetadata.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.network.thrift_proxy.filters.header_to_metadata.v3.HeaderToMetadata.ValueEncode encode = 6;
      Returns:
      The encode.

    • getValueTypeCase

      HeaderToMetadata.KeyValuePair.ValueTypeCase getValueTypeCase()