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

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
    getCookie()
    The cookie to be extracted.
    com.google.protobuf.ByteString
    getCookieBytes()
    The cookie to be extracted.
    String
    getHeader()
    Specifies that a match will be performed on the value of a header or a cookie.
    com.google.protobuf.ByteString
    getHeaderBytes()
    Specifies that a match will be performed on the value of a header or a cookie.
    Config.KeyValuePair
    getOnHeaderMissing()
    If the header or cookie is not present, apply this metadata ``KeyValuePair``.
    Config.KeyValuePairOrBuilder
    getOnHeaderMissingOrBuilder()
    If the header or cookie is not present, apply this metadata ``KeyValuePair``.
    Config.KeyValuePair
    getOnHeaderPresent()
    If the header or cookie is present, apply this metadata ``KeyValuePair``.
    Config.KeyValuePairOrBuilder
    getOnHeaderPresentOrBuilder()
    If the header or cookie 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 or cookie is not present, apply this metadata ``KeyValuePair``.
    boolean
    hasOnHeaderPresent()
    If the header or cookie 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()
       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) = { ... }
      Returns:
      The header.

    • getHeaderBytes

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

    • getCookie

      String getCookie()
       The cookie to be extracted.
      string cookie = 5 [(.validate.rules) = { ... }
      Returns:
      The cookie.

    • getCookieBytes

      com.google.protobuf.ByteString getCookieBytes()
       The cookie to be extracted.
      string cookie = 5 [(.validate.rules) = { ... }
      Returns:
      The bytes for cookie.

    • hasOnHeaderPresent

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

    • getOnHeaderPresent

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

    • getOnHeaderPresentOrBuilder

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

    • hasOnHeaderMissing

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

    • getOnHeaderMissing

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

    • getOnHeaderMissingOrBuilder

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

    • getRemove

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