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

Interface Config.RuleOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    boolean
    getRemove()
    Whether or not to remove the header after a rule is applied.
    boolean
    hasOnHeaderMissing()
    If the header is not present, apply this metadata KeyValuePair.
    boolean
    hasOnHeaderPresent()
    If the header is present, apply this metadata KeyValuePair.

    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

    • getHeader

      String getHeader()
       The header that triggers this rule — required.
      string header = 1 [(.validate.rules) = { ... }
      Returns:
      The header.

    • getHeaderBytes

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

    • hasOnHeaderPresent

      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;
      Returns:
      Whether the onHeaderPresent field is set.

    • getOnHeaderPresent

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

    • getOnHeaderPresentOrBuilder

      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;

    • hasOnHeaderMissing

      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;
      Returns:
      Whether the onHeaderMissing field is set.

    • getOnHeaderMissing

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

    • getOnHeaderMissingOrBuilder

      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;

    • getRemove

      boolean getRemove()
       Whether or not to remove the header after a rule is applied.

 This prevents headers from leaking.
      bool remove = 4;
      Returns:
      The remove.