Package io.envoyproxy.envoy.extensions.http.original_ip_detection.custom_header.v3

Interface CustomHeaderConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CustomHeaderConfig, CustomHeaderConfig.Builder
public interface CustomHeaderConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getAllowExtensionToSetAddressAsTrusted()
    If set to true, the extension could decide that the detected address should be treated as trusted by the HCM.
    String
    getHeaderName()
    The header name containing the original downstream remote address, if present.
    com.google.protobuf.ByteString
    getHeaderNameBytes()
    The header name containing the original downstream remote address, if present.
    HttpStatus
    getRejectWithStatus()
    If this is set, the request will be rejected when detection fails using it as the HTTP response status. .. note:: If this is set to < 400 or > 511, the default status 403 will be used instead.
    HttpStatusOrBuilder
    getRejectWithStatusOrBuilder()
    If this is set, the request will be rejected when detection fails using it as the HTTP response status. .. note:: If this is set to < 400 or > 511, the default status 403 will be used instead.
    boolean
    hasRejectWithStatus()
    If this is set, the request will be rejected when detection fails using it as the HTTP response status. .. note:: If this is set to < 400 or > 511, the default status 403 will be used instead.

    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

    • getHeaderName

      String getHeaderName()
       The header name containing the original downstream remote address, if present.

 Note: in the case of a multi-valued header, only the first value is tried and the rest are ignored.
      string header_name = 1 [(.validate.rules) = { ... }
      Returns:
      The headerName.

    • getHeaderNameBytes

      com.google.protobuf.ByteString getHeaderNameBytes()
       The header name containing the original downstream remote address, if present.

 Note: in the case of a multi-valued header, only the first value is tried and the rest are ignored.
      string header_name = 1 [(.validate.rules) = { ... }
      Returns:
      The bytes for headerName.

    • getAllowExtensionToSetAddressAsTrusted

      boolean getAllowExtensionToSetAddressAsTrusted()
       If set to true, the extension could decide that the detected address should be treated as
 trusted by the HCM. If the address is considered :ref:`trusted<config_http_conn_man_headers_x-forwarded-for_trusted_client_address>`,
 it might be used as input to determine if the request is internal (among other things).
      bool allow_extension_to_set_address_as_trusted = 2;
      Returns:
      The allowExtensionToSetAddressAsTrusted.

    • hasRejectWithStatus

      boolean hasRejectWithStatus()
       If this is set, the request will be rejected when detection fails using it as the HTTP response status.

 .. note::
   If this is set to < 400 or > 511, the default status 403 will be used instead.
      .envoy.type.v3.HttpStatus reject_with_status = 3;
      Returns:
      Whether the rejectWithStatus field is set.

    • getRejectWithStatus

      HttpStatus getRejectWithStatus()
       If this is set, the request will be rejected when detection fails using it as the HTTP response status.

 .. note::
   If this is set to < 400 or > 511, the default status 403 will be used instead.
      .envoy.type.v3.HttpStatus reject_with_status = 3;
      Returns:
      The rejectWithStatus.

    • getRejectWithStatusOrBuilder

      HttpStatusOrBuilder getRejectWithStatusOrBuilder()
       If this is set, the request will be rejected when detection fails using it as the HTTP response status.

 .. note::
   If this is set to < 400 or > 511, the default status 403 will be used instead.
      .envoy.type.v3.HttpStatus reject_with_status = 3;