Package io.envoyproxy.envoy.extensions.filters.listener.proxy_protocol.v3

Interface ProxyProtocolOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ProxyProtocol, ProxyProtocol.Builder
    public interface ProxyProtocolOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getRulesList

        List<ProxyProtocol.Rule> getRulesList()
         The list of rules to apply to requests.
        repeated .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule rules = 1;

      • getRules

        ProxyProtocol.Rule getRules​(int index)
         The list of rules to apply to requests.
        repeated .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule rules = 1;

      • getRulesCount

        int getRulesCount()
         The list of rules to apply to requests.
        repeated .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule rules = 1;

      • getRulesOrBuilderList

        List<? extends ProxyProtocol.RuleOrBuilder> getRulesOrBuilderList()
         The list of rules to apply to requests.
        repeated .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule rules = 1;

      • getRulesOrBuilder

        ProxyProtocol.RuleOrBuilder getRulesOrBuilder​(int index)
         The list of rules to apply to requests.
        repeated .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule rules = 1;

      • getAllowRequestsWithoutProxyProtocol

        boolean getAllowRequestsWithoutProxyProtocol()
         Allow requests through that don't use proxy protocol. Defaults to false.
 .. attention::
   This breaks conformance with the specification.
   Only enable if ALL traffic to the listener comes from a trusted source.
   For more information on the security implications of this feature, see
   https://www.haproxy.org/download/2.1/doc/proxy-protocol.txt
 .. attention::
   Requests of 12 or fewer bytes that match the proxy protocol v2 signature
   and requests of 6 or fewer bytes that match the proxy protocol v1
   signature will timeout (Envoy is unable to differentiate these requests
   from incomplete proxy protocol requests).
        bool allow_requests_without_proxy_protocol = 2;
        Returns:
        The allowRequestsWithoutProxyProtocol.

      • hasPassThroughTlvs

        boolean hasPassThroughTlvs()
         This config controls which TLVs can be passed to filter state if it is Proxy Protocol
 V2 header. If there is no setting for this field, no TLVs will be passed through.
 .. note::
   If this is configured, you likely also want to set
   :ref:`core.v3.ProxyProtocolConfig.pass_through_tlvs <envoy_v3_api_field_config.core.v3.ProxyProtocolConfig.pass_through_tlvs>`,
   which controls pass-through for the upstream.
        .envoy.config.core.v3.ProxyProtocolPassThroughTLVs pass_through_tlvs = 3;
        Returns:
        Whether the passThroughTlvs field is set.

      • getPassThroughTlvs

        ProxyProtocolPassThroughTLVs getPassThroughTlvs()
         This config controls which TLVs can be passed to filter state if it is Proxy Protocol
 V2 header. If there is no setting for this field, no TLVs will be passed through.
 .. note::
   If this is configured, you likely also want to set
   :ref:`core.v3.ProxyProtocolConfig.pass_through_tlvs <envoy_v3_api_field_config.core.v3.ProxyProtocolConfig.pass_through_tlvs>`,
   which controls pass-through for the upstream.
        .envoy.config.core.v3.ProxyProtocolPassThroughTLVs pass_through_tlvs = 3;
        Returns:
        The passThroughTlvs.

      • getPassThroughTlvsOrBuilder

        ProxyProtocolPassThroughTLVsOrBuilder getPassThroughTlvsOrBuilder()
         This config controls which TLVs can be passed to filter state if it is Proxy Protocol
 V2 header. If there is no setting for this field, no TLVs will be passed through.
 .. note::
   If this is configured, you likely also want to set
   :ref:`core.v3.ProxyProtocolConfig.pass_through_tlvs <envoy_v3_api_field_config.core.v3.ProxyProtocolConfig.pass_through_tlvs>`,
   which controls pass-through for the upstream.
        .envoy.config.core.v3.ProxyProtocolPassThroughTLVs pass_through_tlvs = 3;