Class ProxyProtocol.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<ProxyProtocol.Builder>
io.envoyproxy.envoy.extensions.filters.listener.proxy_protocol.v3.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
[#next-free-field: 7]Protobuf type
envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol-
Method Summary
Modifier and TypeMethodDescriptionaddAllDisallowedVersions(Iterable<? extends ProxyProtocolConfig.Version> values) The PROXY protocol versions that won't be matched.addAllDisallowedVersionsValue(Iterable<Integer> values) The PROXY protocol versions that won't be matched.addAllRules(Iterable<? extends ProxyProtocol.Rule> values) The list of rules to apply to requests.The PROXY protocol versions that won't be matched.addDisallowedVersionsValue(int value) The PROXY protocol versions that won't be matched.addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) addRules(int index, ProxyProtocol.Rule value) The list of rules to apply to requests.addRules(int index, ProxyProtocol.Rule.Builder builderForValue) The list of rules to apply to requests.addRules(ProxyProtocol.Rule value) The list of rules to apply to requests.addRules(ProxyProtocol.Rule.Builder builderForValue) The list of rules to apply to requests.The list of rules to apply to requests.addRulesBuilder(int index) The list of rules to apply to requests.build()clear()Allow requests through that don't use proxy protocol.The PROXY protocol versions that won't be matched.clearField(com.google.protobuf.Descriptors.FieldDescriptor field) clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) This config controls which TLVs can be passed to filter state if it is Proxy Protocol V2 header.The list of rules to apply to requests.The human readable prefix to use when emitting statistics for the filter.Controls where TLV values are stored when rules match.clone()booleanAllow requests through that don't use proxy protocol.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorgetDisallowedVersions(int index) The PROXY protocol versions that won't be matched.intThe PROXY protocol versions that won't be matched.The PROXY protocol versions that won't be matched.intgetDisallowedVersionsValue(int index) The PROXY protocol versions that won't be matched.The PROXY protocol versions that won't be matched.This config controls which TLVs can be passed to filter state if it is Proxy Protocol V2 header.This config controls which TLVs can be passed to filter state if it is Proxy Protocol V2 header.This config controls which TLVs can be passed to filter state if it is Proxy Protocol V2 header.getRules(int index) The list of rules to apply to requests.getRulesBuilder(int index) The list of rules to apply to requests.The list of rules to apply to requests.intThe list of rules to apply to requests.The list of rules to apply to requests.getRulesOrBuilder(int index) The list of rules to apply to requests.List<? extends ProxyProtocol.RuleOrBuilder>The list of rules to apply to requests.The human readable prefix to use when emitting statistics for the filter.com.google.protobuf.ByteStringThe human readable prefix to use when emitting statistics for the filter.Controls where TLV values are stored when rules match.intControls where TLV values are stored when rules match.booleanThis config controls which TLVs can be passed to filter state if it is Proxy Protocol V2 header.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanmergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) mergeFrom(ProxyProtocol other) This config controls which TLVs can be passed to filter state if it is Proxy Protocol V2 header.final ProxyProtocol.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) removeRules(int index) The list of rules to apply to requests.setAllowRequestsWithoutProxyProtocol(boolean value) Allow requests through that don't use proxy protocol.setDisallowedVersions(int index, ProxyProtocolConfig.Version value) The PROXY protocol versions that won't be matched.setDisallowedVersionsValue(int index, int value) The PROXY protocol versions that won't be matched.This config controls which TLVs can be passed to filter state if it is Proxy Protocol V2 header.setPassThroughTlvs(ProxyProtocolPassThroughTLVs.Builder builderForValue) This config controls which TLVs can be passed to filter state if it is Proxy Protocol V2 header.setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) setRules(int index, ProxyProtocol.Rule value) The list of rules to apply to requests.setRules(int index, ProxyProtocol.Rule.Builder builderForValue) The list of rules to apply to requests.setStatPrefix(String value) The human readable prefix to use when emitting statistics for the filter.setStatPrefixBytes(com.google.protobuf.ByteString value) The human readable prefix to use when emitting statistics for the filter.Controls where TLV values are stored when rules match.setTlvLocationValue(int value) Controls where TLV values are stored when rules match.final ProxyProtocol.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<ProxyProtocol.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<ProxyProtocol.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<ProxyProtocol.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<ProxyProtocol.Builder>
-
setField
public ProxyProtocol.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<ProxyProtocol.Builder>
-
clearField
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<ProxyProtocol.Builder>
-
clearOneof
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<ProxyProtocol.Builder>
-
setRepeatedField
public ProxyProtocol.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) - Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<ProxyProtocol.Builder>
-
addRepeatedField
public ProxyProtocol.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<ProxyProtocol.Builder>
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<ProxyProtocol.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.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:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<ProxyProtocol.Builder>- Throws:
IOException
-
getRulesList
The list of rules to apply to requests.
repeated .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule rules = 1;- Specified by:
getRulesListin interfaceProxyProtocolOrBuilder
-
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:
getRulesCountin interfaceProxyProtocolOrBuilder
-
getRules
The list of rules to apply to requests.
repeated .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule rules = 1;- Specified by:
getRulesin interfaceProxyProtocolOrBuilder
-
setRules
The list of rules to apply to requests.
repeated .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule rules = 1; -
setRules
The list of rules to apply to requests.
repeated .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule rules = 1; -
addRules
The list of rules to apply to requests.
repeated .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule rules = 1; -
addRules
The list of rules to apply to requests.
repeated .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule rules = 1; -
addRules
The list of rules to apply to requests.
repeated .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule rules = 1; -
addRules
The list of rules to apply to requests.
repeated .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule rules = 1; -
addAllRules
The list of rules to apply to requests.
repeated .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule rules = 1; -
clearRules
The list of rules to apply to requests.
repeated .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule rules = 1; -
removeRules
The list of rules to apply to requests.
repeated .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule rules = 1; -
getRulesBuilder
The list of rules to apply to requests.
repeated .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule rules = 1; -
getRulesOrBuilder
The list of rules to apply to requests.
repeated .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule rules = 1;- Specified by:
getRulesOrBuilderin interfaceProxyProtocolOrBuilder
-
getRulesOrBuilderList
The list of rules to apply to requests.
repeated .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule rules = 1;- Specified by:
getRulesOrBuilderListin interfaceProxyProtocolOrBuilder
-
addRulesBuilder
The list of rules to apply to requests.
repeated .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule rules = 1; -
addRulesBuilder
The list of rules to apply to requests.
repeated .envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.Rule rules = 1; -
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:
getAllowRequestsWithoutProxyProtocolin interfaceProxyProtocolOrBuilder- Returns:
- The allowRequestsWithoutProxyProtocol.
-
setAllowRequestsWithoutProxyProtocol
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
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:
hasPassThroughTlvsin interfaceProxyProtocolOrBuilder- Returns:
- Whether the passThroughTlvs field is set.
-
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:
getPassThroughTlvsin interfaceProxyProtocolOrBuilder- Returns:
- The passThroughTlvs.
-
setPassThroughTlvs
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
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
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
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
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:
getPassThroughTlvsOrBuilderin interfaceProxyProtocolOrBuilder
-
getDisallowedVersionsList
The PROXY protocol versions that won't be matched. Useful to limit the scope and attack surface of the filter. When the filter receives PROXY protocol data that is disallowed, it will reject the connection. By default, the filter will match all PROXY protocol versions. See https://www.haproxy.org/download/2.1/doc/proxy-protocol.txt for details. .. attention:: When used in conjunction with the :ref:`allow_requests_without_proxy_protocol <envoy_v3_api_field_extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.allow_requests_without_proxy_protocol>`, the filter will not attempt to match signatures for the disallowed versions. For example, when ``disallowed_versions=V2``, ``allow_requests_without_proxy_protocol=true``, and an incoming request matches the V2 signature, the filter will allow the request through without any modification. The filter treats this request as if it did not have any PROXY protocol information.
repeated .envoy.config.core.v3.ProxyProtocolConfig.Version disallowed_versions = 4;- Specified by:
getDisallowedVersionsListin interfaceProxyProtocolOrBuilder- Returns:
- A list containing the disallowedVersions.
-
getDisallowedVersionsCount
public int getDisallowedVersionsCount()The PROXY protocol versions that won't be matched. Useful to limit the scope and attack surface of the filter. When the filter receives PROXY protocol data that is disallowed, it will reject the connection. By default, the filter will match all PROXY protocol versions. See https://www.haproxy.org/download/2.1/doc/proxy-protocol.txt for details. .. attention:: When used in conjunction with the :ref:`allow_requests_without_proxy_protocol <envoy_v3_api_field_extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.allow_requests_without_proxy_protocol>`, the filter will not attempt to match signatures for the disallowed versions. For example, when ``disallowed_versions=V2``, ``allow_requests_without_proxy_protocol=true``, and an incoming request matches the V2 signature, the filter will allow the request through without any modification. The filter treats this request as if it did not have any PROXY protocol information.
repeated .envoy.config.core.v3.ProxyProtocolConfig.Version disallowed_versions = 4;- Specified by:
getDisallowedVersionsCountin interfaceProxyProtocolOrBuilder- Returns:
- The count of disallowedVersions.
-
getDisallowedVersions
The PROXY protocol versions that won't be matched. Useful to limit the scope and attack surface of the filter. When the filter receives PROXY protocol data that is disallowed, it will reject the connection. By default, the filter will match all PROXY protocol versions. See https://www.haproxy.org/download/2.1/doc/proxy-protocol.txt for details. .. attention:: When used in conjunction with the :ref:`allow_requests_without_proxy_protocol <envoy_v3_api_field_extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.allow_requests_without_proxy_protocol>`, the filter will not attempt to match signatures for the disallowed versions. For example, when ``disallowed_versions=V2``, ``allow_requests_without_proxy_protocol=true``, and an incoming request matches the V2 signature, the filter will allow the request through without any modification. The filter treats this request as if it did not have any PROXY protocol information.
repeated .envoy.config.core.v3.ProxyProtocolConfig.Version disallowed_versions = 4;- Specified by:
getDisallowedVersionsin interfaceProxyProtocolOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The disallowedVersions at the given index.
-
setDisallowedVersions
The PROXY protocol versions that won't be matched. Useful to limit the scope and attack surface of the filter. When the filter receives PROXY protocol data that is disallowed, it will reject the connection. By default, the filter will match all PROXY protocol versions. See https://www.haproxy.org/download/2.1/doc/proxy-protocol.txt for details. .. attention:: When used in conjunction with the :ref:`allow_requests_without_proxy_protocol <envoy_v3_api_field_extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.allow_requests_without_proxy_protocol>`, the filter will not attempt to match signatures for the disallowed versions. For example, when ``disallowed_versions=V2``, ``allow_requests_without_proxy_protocol=true``, and an incoming request matches the V2 signature, the filter will allow the request through without any modification. The filter treats this request as if it did not have any PROXY protocol information.
repeated .envoy.config.core.v3.ProxyProtocolConfig.Version disallowed_versions = 4;- Parameters:
index- The index to set the value at.value- The disallowedVersions to set.- Returns:
- This builder for chaining.
-
addDisallowedVersions
The PROXY protocol versions that won't be matched. Useful to limit the scope and attack surface of the filter. When the filter receives PROXY protocol data that is disallowed, it will reject the connection. By default, the filter will match all PROXY protocol versions. See https://www.haproxy.org/download/2.1/doc/proxy-protocol.txt for details. .. attention:: When used in conjunction with the :ref:`allow_requests_without_proxy_protocol <envoy_v3_api_field_extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.allow_requests_without_proxy_protocol>`, the filter will not attempt to match signatures for the disallowed versions. For example, when ``disallowed_versions=V2``, ``allow_requests_without_proxy_protocol=true``, and an incoming request matches the V2 signature, the filter will allow the request through without any modification. The filter treats this request as if it did not have any PROXY protocol information.
repeated .envoy.config.core.v3.ProxyProtocolConfig.Version disallowed_versions = 4;- Parameters:
value- The disallowedVersions to add.- Returns:
- This builder for chaining.
-
addAllDisallowedVersions
public ProxyProtocol.Builder addAllDisallowedVersions(Iterable<? extends ProxyProtocolConfig.Version> values) The PROXY protocol versions that won't be matched. Useful to limit the scope and attack surface of the filter. When the filter receives PROXY protocol data that is disallowed, it will reject the connection. By default, the filter will match all PROXY protocol versions. See https://www.haproxy.org/download/2.1/doc/proxy-protocol.txt for details. .. attention:: When used in conjunction with the :ref:`allow_requests_without_proxy_protocol <envoy_v3_api_field_extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.allow_requests_without_proxy_protocol>`, the filter will not attempt to match signatures for the disallowed versions. For example, when ``disallowed_versions=V2``, ``allow_requests_without_proxy_protocol=true``, and an incoming request matches the V2 signature, the filter will allow the request through without any modification. The filter treats this request as if it did not have any PROXY protocol information.
repeated .envoy.config.core.v3.ProxyProtocolConfig.Version disallowed_versions = 4;- Parameters:
values- The disallowedVersions to add.- Returns:
- This builder for chaining.
-
clearDisallowedVersions
The PROXY protocol versions that won't be matched. Useful to limit the scope and attack surface of the filter. When the filter receives PROXY protocol data that is disallowed, it will reject the connection. By default, the filter will match all PROXY protocol versions. See https://www.haproxy.org/download/2.1/doc/proxy-protocol.txt for details. .. attention:: When used in conjunction with the :ref:`allow_requests_without_proxy_protocol <envoy_v3_api_field_extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.allow_requests_without_proxy_protocol>`, the filter will not attempt to match signatures for the disallowed versions. For example, when ``disallowed_versions=V2``, ``allow_requests_without_proxy_protocol=true``, and an incoming request matches the V2 signature, the filter will allow the request through without any modification. The filter treats this request as if it did not have any PROXY protocol information.
repeated .envoy.config.core.v3.ProxyProtocolConfig.Version disallowed_versions = 4;- Returns:
- This builder for chaining.
-
getDisallowedVersionsValueList
The PROXY protocol versions that won't be matched. Useful to limit the scope and attack surface of the filter. When the filter receives PROXY protocol data that is disallowed, it will reject the connection. By default, the filter will match all PROXY protocol versions. See https://www.haproxy.org/download/2.1/doc/proxy-protocol.txt for details. .. attention:: When used in conjunction with the :ref:`allow_requests_without_proxy_protocol <envoy_v3_api_field_extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.allow_requests_without_proxy_protocol>`, the filter will not attempt to match signatures for the disallowed versions. For example, when ``disallowed_versions=V2``, ``allow_requests_without_proxy_protocol=true``, and an incoming request matches the V2 signature, the filter will allow the request through without any modification. The filter treats this request as if it did not have any PROXY protocol information.
repeated .envoy.config.core.v3.ProxyProtocolConfig.Version disallowed_versions = 4;- Specified by:
getDisallowedVersionsValueListin interfaceProxyProtocolOrBuilder- Returns:
- A list containing the enum numeric values on the wire for disallowedVersions.
-
getDisallowedVersionsValue
public int getDisallowedVersionsValue(int index) The PROXY protocol versions that won't be matched. Useful to limit the scope and attack surface of the filter. When the filter receives PROXY protocol data that is disallowed, it will reject the connection. By default, the filter will match all PROXY protocol versions. See https://www.haproxy.org/download/2.1/doc/proxy-protocol.txt for details. .. attention:: When used in conjunction with the :ref:`allow_requests_without_proxy_protocol <envoy_v3_api_field_extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.allow_requests_without_proxy_protocol>`, the filter will not attempt to match signatures for the disallowed versions. For example, when ``disallowed_versions=V2``, ``allow_requests_without_proxy_protocol=true``, and an incoming request matches the V2 signature, the filter will allow the request through without any modification. The filter treats this request as if it did not have any PROXY protocol information.
repeated .envoy.config.core.v3.ProxyProtocolConfig.Version disallowed_versions = 4;- Specified by:
getDisallowedVersionsValuein interfaceProxyProtocolOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The enum numeric value on the wire of disallowedVersions at the given index.
-
setDisallowedVersionsValue
The PROXY protocol versions that won't be matched. Useful to limit the scope and attack surface of the filter. When the filter receives PROXY protocol data that is disallowed, it will reject the connection. By default, the filter will match all PROXY protocol versions. See https://www.haproxy.org/download/2.1/doc/proxy-protocol.txt for details. .. attention:: When used in conjunction with the :ref:`allow_requests_without_proxy_protocol <envoy_v3_api_field_extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.allow_requests_without_proxy_protocol>`, the filter will not attempt to match signatures for the disallowed versions. For example, when ``disallowed_versions=V2``, ``allow_requests_without_proxy_protocol=true``, and an incoming request matches the V2 signature, the filter will allow the request through without any modification. The filter treats this request as if it did not have any PROXY protocol information.
repeated .envoy.config.core.v3.ProxyProtocolConfig.Version disallowed_versions = 4;- Parameters:
index- The index to set the value at.value- The enum numeric value on the wire for disallowedVersions to set.- Returns:
- This builder for chaining.
-
addDisallowedVersionsValue
The PROXY protocol versions that won't be matched. Useful to limit the scope and attack surface of the filter. When the filter receives PROXY protocol data that is disallowed, it will reject the connection. By default, the filter will match all PROXY protocol versions. See https://www.haproxy.org/download/2.1/doc/proxy-protocol.txt for details. .. attention:: When used in conjunction with the :ref:`allow_requests_without_proxy_protocol <envoy_v3_api_field_extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.allow_requests_without_proxy_protocol>`, the filter will not attempt to match signatures for the disallowed versions. For example, when ``disallowed_versions=V2``, ``allow_requests_without_proxy_protocol=true``, and an incoming request matches the V2 signature, the filter will allow the request through without any modification. The filter treats this request as if it did not have any PROXY protocol information.
repeated .envoy.config.core.v3.ProxyProtocolConfig.Version disallowed_versions = 4;- Parameters:
value- The enum numeric value on the wire for disallowedVersions to add.- Returns:
- This builder for chaining.
-
addAllDisallowedVersionsValue
The PROXY protocol versions that won't be matched. Useful to limit the scope and attack surface of the filter. When the filter receives PROXY protocol data that is disallowed, it will reject the connection. By default, the filter will match all PROXY protocol versions. See https://www.haproxy.org/download/2.1/doc/proxy-protocol.txt for details. .. attention:: When used in conjunction with the :ref:`allow_requests_without_proxy_protocol <envoy_v3_api_field_extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.allow_requests_without_proxy_protocol>`, the filter will not attempt to match signatures for the disallowed versions. For example, when ``disallowed_versions=V2``, ``allow_requests_without_proxy_protocol=true``, and an incoming request matches the V2 signature, the filter will allow the request through without any modification. The filter treats this request as if it did not have any PROXY protocol information.
repeated .envoy.config.core.v3.ProxyProtocolConfig.Version disallowed_versions = 4;- Parameters:
values- The enum numeric values on the wire for disallowedVersions to add.- Returns:
- This builder for chaining.
-
getStatPrefix
The human readable prefix to use when emitting statistics for the filter. If not configured, statistics will be emitted without the prefix segment. See the :ref:`filter's statistics documentation <config_listener_filters_proxy_protocol>` for more information.
string stat_prefix = 5;- Specified by:
getStatPrefixin interfaceProxyProtocolOrBuilder- Returns:
- The statPrefix.
-
getStatPrefixBytes
public com.google.protobuf.ByteString getStatPrefixBytes()The human readable prefix to use when emitting statistics for the filter. If not configured, statistics will be emitted without the prefix segment. See the :ref:`filter's statistics documentation <config_listener_filters_proxy_protocol>` for more information.
string stat_prefix = 5;- Specified by:
getStatPrefixBytesin interfaceProxyProtocolOrBuilder- Returns:
- The bytes for statPrefix.
-
setStatPrefix
The human readable prefix to use when emitting statistics for the filter. If not configured, statistics will be emitted without the prefix segment. See the :ref:`filter's statistics documentation <config_listener_filters_proxy_protocol>` for more information.
string stat_prefix = 5;- Parameters:
value- The statPrefix to set.- Returns:
- This builder for chaining.
-
clearStatPrefix
The human readable prefix to use when emitting statistics for the filter. If not configured, statistics will be emitted without the prefix segment. See the :ref:`filter's statistics documentation <config_listener_filters_proxy_protocol>` for more information.
string stat_prefix = 5;- Returns:
- This builder for chaining.
-
setStatPrefixBytes
The human readable prefix to use when emitting statistics for the filter. If not configured, statistics will be emitted without the prefix segment. See the :ref:`filter's statistics documentation <config_listener_filters_proxy_protocol>` for more information.
string stat_prefix = 5;- Parameters:
value- The bytes for statPrefix to set.- Returns:
- This builder for chaining.
-
getTlvLocationValue
public int getTlvLocationValue()Controls where TLV values are stored when rules match. Defaults to DYNAMIC_METADATA.
.envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.TlvLocation tlv_location = 6;- Specified by:
getTlvLocationValuein interfaceProxyProtocolOrBuilder- Returns:
- The enum numeric value on the wire for tlvLocation.
-
setTlvLocationValue
Controls where TLV values are stored when rules match. Defaults to DYNAMIC_METADATA.
.envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.TlvLocation tlv_location = 6;- Parameters:
value- The enum numeric value on the wire for tlvLocation to set.- Returns:
- This builder for chaining.
-
getTlvLocation
Controls where TLV values are stored when rules match. Defaults to DYNAMIC_METADATA.
.envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.TlvLocation tlv_location = 6;- Specified by:
getTlvLocationin interfaceProxyProtocolOrBuilder- Returns:
- The tlvLocation.
-
setTlvLocation
Controls where TLV values are stored when rules match. Defaults to DYNAMIC_METADATA.
.envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.TlvLocation tlv_location = 6;- Parameters:
value- The tlvLocation to set.- Returns:
- This builder for chaining.
-
clearTlvLocation
Controls where TLV values are stored when rules match. Defaults to DYNAMIC_METADATA.
.envoy.extensions.filters.listener.proxy_protocol.v3.ProxyProtocol.TlvLocation tlv_location = 6;- Returns:
- This builder for chaining.
-
setUnknownFields
public final ProxyProtocol.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<ProxyProtocol.Builder>
-
mergeUnknownFields
public final ProxyProtocol.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<ProxyProtocol.Builder>
-