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

Enum IPTagging.IpTagHeader.HeaderAction

java.lang.Object
java.lang.Enum<IPTagging.IpTagHeader.HeaderAction>
io.envoyproxy.envoy.extensions.filters.http.ip_tagging.v3.IPTagging.IpTagHeader.HeaderAction
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<IPTagging.IpTagHeader.HeaderAction>, java.lang.constant.Constable
Enclosing class:
IPTagging.IpTagHeader
public static enum IPTagging.IpTagHeader.HeaderAction extends Enum<IPTagging.IpTagHeader.HeaderAction> implements com.google.protobuf.ProtocolMessageEnum
 Describes how to apply the tags to the headers.
Protobuf enum envoy.extensions.filters.http.ip_tagging.v3.IPTagging.IpTagHeader.HeaderAction

  • Enum Constant Details

    • SANITIZE

      public static final IPTagging.IpTagHeader.HeaderAction SANITIZE
       (DEFAULT) The header specified in :ref:`ip_tag_header <envoy_v3_api_field_extensions.filters.http.ip_tagging.v3.IPTagging.ip_tag_header>`
 will be dropped, before the tags are applied. The incoming header will be "sanitized" regardless of whether the request is internal or external.

 Note that the header will be visible unsanitized to any filters that are invoked before the ip-tag-header filter, unless it has an *x-envoy* prefix.
      SANITIZE = 0;

    • APPEND_IF_EXISTS_OR_ADD

      public static final IPTagging.IpTagHeader.HeaderAction APPEND_IF_EXISTS_OR_ADD
       Tags will be appended to the header specified in
 :ref:`ip_tag_header <envoy_v3_api_field_extensions.filters.http.ip_tagging.v3.IPTagging.ip_tag_header>`.

 Please note that this could cause the header to retain values set by the http client regardless of whether the request is internal or external.
      APPEND_IF_EXISTS_OR_ADD = 1;

    • UNRECOGNIZED

      public static final IPTagging.IpTagHeader.HeaderAction UNRECOGNIZED

  • Field Details

    • SANITIZE_VALUE

      public static final int SANITIZE_VALUE
       (DEFAULT) The header specified in :ref:`ip_tag_header <envoy_v3_api_field_extensions.filters.http.ip_tagging.v3.IPTagging.ip_tag_header>`
 will be dropped, before the tags are applied. The incoming header will be "sanitized" regardless of whether the request is internal or external.

 Note that the header will be visible unsanitized to any filters that are invoked before the ip-tag-header filter, unless it has an *x-envoy* prefix.
      SANITIZE = 0;
      See Also:

    • APPEND_IF_EXISTS_OR_ADD_VALUE

      public static final int APPEND_IF_EXISTS_OR_ADD_VALUE
       Tags will be appended to the header specified in
 :ref:`ip_tag_header <envoy_v3_api_field_extensions.filters.http.ip_tagging.v3.IPTagging.ip_tag_header>`.

 Please note that this could cause the header to retain values set by the http client regardless of whether the request is internal or external.
      APPEND_IF_EXISTS_OR_ADD = 1;
      See Also:

  • Method Details

    • values

      public static IPTagging.IpTagHeader.HeaderAction[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static IPTagging.IpTagHeader.HeaderAction valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getNumber

      public final int getNumber()
      Specified by:
      getNumber in interface com.google.protobuf.Internal.EnumLite
      Specified by:
      getNumber in interface com.google.protobuf.ProtocolMessageEnum

    • valueOf

      @Deprecated public static IPTagging.IpTagHeader.HeaderAction valueOf(int value)
      Deprecated.
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      value - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • forNumber

      public static IPTagging.IpTagHeader.HeaderAction forNumber(int value)
      Parameters:
      value - The numeric wire value of the corresponding enum entry.
      Returns:
      The enum associated with the given numeric wire value.

    • internalGetValueMap

      public static com.google.protobuf.Internal.EnumLiteMap<IPTagging.IpTagHeader.HeaderAction> internalGetValueMap()

    • getValueDescriptor

      public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
      Specified by:
      getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptorForType

      public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptor

      public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

    • valueOf

      public static IPTagging.IpTagHeader.HeaderAction valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      desc - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null