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

Class XffConfig.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, XffConfigOrBuilder, Cloneable
    Enclosing class:
    XffConfig
    public static final class XffConfig.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<XffConfig.Builder>
implements XffConfigOrBuilder
     This extension allows for the original downstream remote IP to be detected
 by reading the :ref:`config_http_conn_man_headers_x-forwarded-for` header.
 [#extension: envoy.http.original_ip_detection.xff]
    Protobuf type envoy.extensions.http.original_ip_detection.xff.v3.XffConfig

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      XffConfig.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)  
      XffConfig build()  
      XffConfig buildPartial()  
      XffConfig.Builder clear()  
      XffConfig.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)  
      XffConfig.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)  
      XffConfig.Builder clearXffNumTrustedHops()
      The number of additional ingress proxy hops from the right side of the :ref:`config_http_conn_man_headers_x-forwarded-for` HTTP header to trust when determining the origin client's IP address.
      XffConfig.Builder clone()  
      XffConfig getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Descriptors.Descriptor getDescriptorForType()  
      int getXffNumTrustedHops()
      The number of additional ingress proxy hops from the right side of the :ref:`config_http_conn_man_headers_x-forwarded-for` HTTP header to trust when determining the origin client's IP address.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      XffConfig.Builder mergeFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      XffConfig.Builder mergeFrom​(com.google.protobuf.Message other)  
      XffConfig.Builder mergeFrom​(XffConfig other)  
      XffConfig.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)  
      XffConfig.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)  
      XffConfig.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)  
      XffConfig.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)  
      XffConfig.Builder setXffNumTrustedHops​(int value)
      The number of additional ingress proxy hops from the right side of the :ref:`config_http_conn_man_headers_x-forwarded-for` HTTP header to trust when determining the origin client's IP address.

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

        getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

      • Methods inherited from class com.google.protobuf.AbstractMessage.Builder

        findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

        addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

      • Methods inherited from interface com.google.protobuf.Message.Builder

        mergeDelimitedFrom, mergeDelimitedFrom

      • Methods inherited from interface com.google.protobuf.MessageLite.Builder

        mergeFrom

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • 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<XffConfig.Builder>

      • clear

        public XffConfig.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<XffConfig.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<XffConfig.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public XffConfig.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<XffConfig.Builder>

      • setField

        public XffConfig.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<XffConfig.Builder>

      • clearField

        public XffConfig.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<XffConfig.Builder>

      • clearOneof

        public XffConfig.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<XffConfig.Builder>

      • setRepeatedField

        public XffConfig.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<XffConfig.Builder>

      • addRepeatedField

        public XffConfig.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<XffConfig.Builder>

      • mergeFrom

        public XffConfig.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<XffConfig.Builder>

      • isInitialized

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

      • mergeFrom

        public XffConfig.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<XffConfig.Builder>
        Throws:
        IOException

      • getXffNumTrustedHops

        public int getXffNumTrustedHops()
         The number of additional ingress proxy hops from the right side of the
 :ref:`config_http_conn_man_headers_x-forwarded-for` HTTP header to trust when
 determining the origin client's IP address. The default is zero if this option
 is not specified. See the documentation for
 :ref:`config_http_conn_man_headers_x-forwarded-for` for more information.
        uint32 xff_num_trusted_hops = 1;
        Specified by:
        getXffNumTrustedHops in interface XffConfigOrBuilder
        Returns:
        The xffNumTrustedHops.

      • setXffNumTrustedHops

        public XffConfig.Builder setXffNumTrustedHops​(int value)
         The number of additional ingress proxy hops from the right side of the
 :ref:`config_http_conn_man_headers_x-forwarded-for` HTTP header to trust when
 determining the origin client's IP address. The default is zero if this option
 is not specified. See the documentation for
 :ref:`config_http_conn_man_headers_x-forwarded-for` for more information.
        uint32 xff_num_trusted_hops = 1;
        Parameters:
        value - The xffNumTrustedHops to set.
        Returns:
        This builder for chaining.

      • clearXffNumTrustedHops

        public XffConfig.Builder clearXffNumTrustedHops()
         The number of additional ingress proxy hops from the right side of the
 :ref:`config_http_conn_man_headers_x-forwarded-for` HTTP header to trust when
 determining the origin client's IP address. The default is zero if this option
 is not specified. See the documentation for
 :ref:`config_http_conn_man_headers_x-forwarded-for` for more information.
        uint32 xff_num_trusted_hops = 1;
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final XffConfig.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<XffConfig.Builder>

      • mergeUnknownFields

        public final XffConfig.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<XffConfig.Builder>