Package io.envoyproxy.envoy.config.core.v3

Interface ProxyProtocolConfigOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    TlvEntry
    getAddedTlvs(int index)
    This config allows additional TLVs to be included in the upstream PROXY protocol V2 header.
    int
    getAddedTlvsCount()
    This config allows additional TLVs to be included in the upstream PROXY protocol V2 header.
    List<TlvEntry>
    getAddedTlvsList()
    This config allows additional TLVs to be included in the upstream PROXY protocol V2 header.
    TlvEntryOrBuilder
    getAddedTlvsOrBuilder(int index)
    This config allows additional TLVs to be included in the upstream PROXY protocol V2 header.
    List<? extends TlvEntryOrBuilder>
    getAddedTlvsOrBuilderList()
    This config allows additional TLVs to be included in the upstream PROXY protocol V2 header.
    ProxyProtocolPassThroughTLVs
    getPassThroughTlvs()
    This config controls which TLVs can be passed to upstream if it is Proxy Protocol V2 header.
    ProxyProtocolPassThroughTLVsOrBuilder
    getPassThroughTlvsOrBuilder()
    This config controls which TLVs can be passed to upstream if it is Proxy Protocol V2 header.
    ProxyProtocolConfig.Version
    getVersion()
    The PROXY protocol version to use.
    int
    getVersionValue()
    The PROXY protocol version to use.
    boolean
    hasPassThroughTlvs()
    This config controls which TLVs can be passed to upstream if it is Proxy Protocol V2 header.

    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

    • getVersionValue

      int getVersionValue()
       The PROXY protocol version to use. See https://www.haproxy.org/download/2.1/doc/proxy-protocol.txt for details
      .envoy.config.core.v3.ProxyProtocolConfig.Version version = 1;
      Returns:
      The enum numeric value on the wire for version.

    • getVersion

      ProxyProtocolConfig.Version getVersion()
       The PROXY protocol version to use. See https://www.haproxy.org/download/2.1/doc/proxy-protocol.txt for details
      .envoy.config.core.v3.ProxyProtocolConfig.Version version = 1;
      Returns:
      The version.

    • hasPassThroughTlvs

      boolean hasPassThroughTlvs()
       This config controls which TLVs can be passed to upstream if it is Proxy Protocol
 V2 header. If there is no setting for this field, no TLVs will be passed through.
      .envoy.config.core.v3.ProxyProtocolPassThroughTLVs pass_through_tlvs = 2;
      Returns:
      Whether the passThroughTlvs field is set.

    • getPassThroughTlvs

      ProxyProtocolPassThroughTLVs getPassThroughTlvs()
       This config controls which TLVs can be passed to upstream if it is Proxy Protocol
 V2 header. If there is no setting for this field, no TLVs will be passed through.
      .envoy.config.core.v3.ProxyProtocolPassThroughTLVs pass_through_tlvs = 2;
      Returns:
      The passThroughTlvs.

    • getPassThroughTlvsOrBuilder

      ProxyProtocolPassThroughTLVsOrBuilder getPassThroughTlvsOrBuilder()
       This config controls which TLVs can be passed to upstream if it is Proxy Protocol
 V2 header. If there is no setting for this field, no TLVs will be passed through.
      .envoy.config.core.v3.ProxyProtocolPassThroughTLVs pass_through_tlvs = 2;

    • getAddedTlvsList

      List<TlvEntry> getAddedTlvsList()
       This config allows additional TLVs to be included in the upstream PROXY protocol
 V2 header. Unlike ``pass_through_tlvs``, which passes TLVs from the downstream request,
 ``added_tlvs`` provides an extension mechanism for defining new TLVs that are included
 with the upstream request. These TLVs may not be present in the downstream request and
 can be defined at either the transport socket level or the host level to provide more
 granular control over the TLVs that are included in the upstream request.

 Host-level TLVs are specified in the ``metadata.typed_filter_metadata`` field under the
 ``envoy.transport_sockets.proxy_protocol`` namespace.

 .. literalinclude:: /_configs/repo/proxy_protocol.yaml
    :language: yaml
    :lines: 49-57
    :linenos:
    :lineno-start: 49
    :caption: :download:`proxy_protocol.yaml </_configs/repo/proxy_protocol.yaml>`

 **Precedence behavior**:

 - When a TLV is defined at both the host level and the transport socket level, the value
   from the host level configuration takes precedence. This allows users to define default TLVs
   at the transport socket level and override them at the host level.
 - Any TLV defined in the ``pass_through_tlvs`` field will be overridden by either the host-level
   or transport socket-level TLV.

 If there are multiple TLVs with the same type, only the TLVs from the highest precedence level
 will be used.
      repeated .envoy.config.core.v3.TlvEntry added_tlvs = 3;

    • getAddedTlvs

      TlvEntry getAddedTlvs(int index)
       This config allows additional TLVs to be included in the upstream PROXY protocol
 V2 header. Unlike ``pass_through_tlvs``, which passes TLVs from the downstream request,
 ``added_tlvs`` provides an extension mechanism for defining new TLVs that are included
 with the upstream request. These TLVs may not be present in the downstream request and
 can be defined at either the transport socket level or the host level to provide more
 granular control over the TLVs that are included in the upstream request.

 Host-level TLVs are specified in the ``metadata.typed_filter_metadata`` field under the
 ``envoy.transport_sockets.proxy_protocol`` namespace.

 .. literalinclude:: /_configs/repo/proxy_protocol.yaml
    :language: yaml
    :lines: 49-57
    :linenos:
    :lineno-start: 49
    :caption: :download:`proxy_protocol.yaml </_configs/repo/proxy_protocol.yaml>`

 **Precedence behavior**:

 - When a TLV is defined at both the host level and the transport socket level, the value
   from the host level configuration takes precedence. This allows users to define default TLVs
   at the transport socket level and override them at the host level.
 - Any TLV defined in the ``pass_through_tlvs`` field will be overridden by either the host-level
   or transport socket-level TLV.

 If there are multiple TLVs with the same type, only the TLVs from the highest precedence level
 will be used.
      repeated .envoy.config.core.v3.TlvEntry added_tlvs = 3;

    • getAddedTlvsCount

      int getAddedTlvsCount()
       This config allows additional TLVs to be included in the upstream PROXY protocol
 V2 header. Unlike ``pass_through_tlvs``, which passes TLVs from the downstream request,
 ``added_tlvs`` provides an extension mechanism for defining new TLVs that are included
 with the upstream request. These TLVs may not be present in the downstream request and
 can be defined at either the transport socket level or the host level to provide more
 granular control over the TLVs that are included in the upstream request.

 Host-level TLVs are specified in the ``metadata.typed_filter_metadata`` field under the
 ``envoy.transport_sockets.proxy_protocol`` namespace.

 .. literalinclude:: /_configs/repo/proxy_protocol.yaml
    :language: yaml
    :lines: 49-57
    :linenos:
    :lineno-start: 49
    :caption: :download:`proxy_protocol.yaml </_configs/repo/proxy_protocol.yaml>`

 **Precedence behavior**:

 - When a TLV is defined at both the host level and the transport socket level, the value
   from the host level configuration takes precedence. This allows users to define default TLVs
   at the transport socket level and override them at the host level.
 - Any TLV defined in the ``pass_through_tlvs`` field will be overridden by either the host-level
   or transport socket-level TLV.

 If there are multiple TLVs with the same type, only the TLVs from the highest precedence level
 will be used.
      repeated .envoy.config.core.v3.TlvEntry added_tlvs = 3;

    • getAddedTlvsOrBuilderList

      List<? extends TlvEntryOrBuilder> getAddedTlvsOrBuilderList()
       This config allows additional TLVs to be included in the upstream PROXY protocol
 V2 header. Unlike ``pass_through_tlvs``, which passes TLVs from the downstream request,
 ``added_tlvs`` provides an extension mechanism for defining new TLVs that are included
 with the upstream request. These TLVs may not be present in the downstream request and
 can be defined at either the transport socket level or the host level to provide more
 granular control over the TLVs that are included in the upstream request.

 Host-level TLVs are specified in the ``metadata.typed_filter_metadata`` field under the
 ``envoy.transport_sockets.proxy_protocol`` namespace.

 .. literalinclude:: /_configs/repo/proxy_protocol.yaml
    :language: yaml
    :lines: 49-57
    :linenos:
    :lineno-start: 49
    :caption: :download:`proxy_protocol.yaml </_configs/repo/proxy_protocol.yaml>`

 **Precedence behavior**:

 - When a TLV is defined at both the host level and the transport socket level, the value
   from the host level configuration takes precedence. This allows users to define default TLVs
   at the transport socket level and override them at the host level.
 - Any TLV defined in the ``pass_through_tlvs`` field will be overridden by either the host-level
   or transport socket-level TLV.

 If there are multiple TLVs with the same type, only the TLVs from the highest precedence level
 will be used.
      repeated .envoy.config.core.v3.TlvEntry added_tlvs = 3;

    • getAddedTlvsOrBuilder

      TlvEntryOrBuilder getAddedTlvsOrBuilder(int index)
       This config allows additional TLVs to be included in the upstream PROXY protocol
 V2 header. Unlike ``pass_through_tlvs``, which passes TLVs from the downstream request,
 ``added_tlvs`` provides an extension mechanism for defining new TLVs that are included
 with the upstream request. These TLVs may not be present in the downstream request and
 can be defined at either the transport socket level or the host level to provide more
 granular control over the TLVs that are included in the upstream request.

 Host-level TLVs are specified in the ``metadata.typed_filter_metadata`` field under the
 ``envoy.transport_sockets.proxy_protocol`` namespace.

 .. literalinclude:: /_configs/repo/proxy_protocol.yaml
    :language: yaml
    :lines: 49-57
    :linenos:
    :lineno-start: 49
    :caption: :download:`proxy_protocol.yaml </_configs/repo/proxy_protocol.yaml>`

 **Precedence behavior**:

 - When a TLV is defined at both the host level and the transport socket level, the value
   from the host level configuration takes precedence. This allows users to define default TLVs
   at the transport socket level and override them at the host level.
 - Any TLV defined in the ``pass_through_tlvs`` field will be overridden by either the host-level
   or transport socket-level TLV.

 If there are multiple TLVs with the same type, only the TLVs from the highest precedence level
 will be used.
      repeated .envoy.config.core.v3.TlvEntry added_tlvs = 3;