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

Class ProxyProtocol.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ProxyProtocolOrBuilder, Cloneable
    Enclosing class:
    ProxyProtocol
    public static final class ProxyProtocol.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ProxyProtocol.Builder>
implements ProxyProtocolOrBuilder
    Protobuf type envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol

    • Method Detail

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ProxyProtocol.Builder>

      • clear

        public ProxyProtocol.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<ProxyProtocol.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ProxyProtocol.Builder>

      • getDefaultInstanceForType

        public ProxyProtocol getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public ProxyProtocol build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public ProxyProtocol buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public ProxyProtocol.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<ProxyProtocol.Builder>

      • setField

        public ProxyProtocol.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                      Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<ProxyProtocol.Builder>

      • clearField

        public ProxyProtocol.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ProxyProtocol.Builder>

      • clearOneof

        public ProxyProtocol.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ProxyProtocol.Builder>

      • setRepeatedField

        public ProxyProtocol.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              int index,
                                              Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ProxyProtocol.Builder>

      • addRepeatedField

        public ProxyProtocol.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ProxyProtocol.Builder>

      • mergeFrom

        public ProxyProtocol.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ProxyProtocol.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ProxyProtocol.Builder>

      • mergeFrom

        public ProxyProtocol.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ProxyProtocol.Builder>
        Throws:
        IOException

      • getRulesCount

        public int getRulesCount()
         The list of rules to apply to requests.
        repeated .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule rules = 1;
        Specified by:
        getRulesCount in interface ProxyProtocolOrBuilder

      • getRules

        public 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;
        Specified by:
        getRules in interface ProxyProtocolOrBuilder

      • setRules

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

      • setRules

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

      • addRules

        public ProxyProtocol.Builder addRules​(ProxyProtocol.Rule value)
         The list of rules to apply to requests.
        repeated .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule rules = 1;

      • addRules

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

      • addRules

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

      • addAllRules

        public ProxyProtocol.Builder addAllRules​(Iterable<? extends ProxyProtocol.Rule> values)
         The list of rules to apply to requests.
        repeated .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule rules = 1;

      • clearRules

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

      • removeRules

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

      • getRulesBuilder

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

      • addRulesBuilder

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

      • addRulesBuilder

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

      • getRulesBuilderList

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

      • getAllowRequestsWithoutProxyProtocol

        public 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;
        Specified by:
        getAllowRequestsWithoutProxyProtocol in interface ProxyProtocolOrBuilder
        Returns:
        The allowRequestsWithoutProxyProtocol.

      • setAllowRequestsWithoutProxyProtocol

        public ProxyProtocol.Builder setAllowRequestsWithoutProxyProtocol​(boolean value)
         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;
        Parameters:
        value - The allowRequestsWithoutProxyProtocol to set.
        Returns:
        This builder for chaining.

      • clearAllowRequestsWithoutProxyProtocol

        public ProxyProtocol.Builder clearAllowRequestsWithoutProxyProtocol()
         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:
        This builder for chaining.

      • hasPassThroughTlvs

        public 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;
        Specified by:
        hasPassThroughTlvs in interface ProxyProtocolOrBuilder
        Returns:
        Whether the passThroughTlvs field is set.

      • getPassThroughTlvs

        public 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;
        Specified by:
        getPassThroughTlvs in interface ProxyProtocolOrBuilder
        Returns:
        The passThroughTlvs.

      • setPassThroughTlvs

        public ProxyProtocol.Builder setPassThroughTlvs​(ProxyProtocolPassThroughTLVs value)
         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;

      • setPassThroughTlvs

        public ProxyProtocol.Builder setPassThroughTlvs​(ProxyProtocolPassThroughTLVs.Builder builderForValue)
         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;

      • mergePassThroughTlvs

        public ProxyProtocol.Builder mergePassThroughTlvs​(ProxyProtocolPassThroughTLVs value)
         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;

      • clearPassThroughTlvs

        public ProxyProtocol.Builder clearPassThroughTlvs()
         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;

      • getPassThroughTlvsBuilder

        public ProxyProtocolPassThroughTLVs.Builder getPassThroughTlvsBuilder()
         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;

      • getPassThroughTlvsOrBuilder

        public 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;
        Specified by:
        getPassThroughTlvsOrBuilder in interface ProxyProtocolOrBuilder

      • setUnknownFields

        public final ProxyProtocol.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ProxyProtocol.Builder>

      • mergeUnknownFields

        public final ProxyProtocol.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ProxyProtocol.Builder>