Package io.envoyproxy.envoy.extensions.filters.http.geoip.v3

Class Geoip

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, GeoipOrBuilder, Serializable
    public final class Geoip
extends com.google.protobuf.GeneratedMessageV3
implements GeoipOrBuilder
    Protobuf type envoy.extensions.filters.http.geoip.v3.Geoip
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Geoip.Builder
      Protobuf type envoy.extensions.filters.http.geoip.v3.Geoip
      static class  Geoip.XffConfig
      Protobuf type envoy.extensions.filters.http.geoip.v3.Geoip.XffConfig
      static interface  Geoip.XffConfigOrBuilder  

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int PROVIDER_FIELD_NUMBER  
      static int XFF_CONFIG_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      static Geoip getDefaultInstance()  
      Geoip getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Parser<Geoip> getParserForType()  
      TypedExtensionConfig getProvider()
      Geoip driver specific configuration which depends on the driver being instantiated.
      TypedExtensionConfigOrBuilder getProviderOrBuilder()
      Geoip driver specific configuration which depends on the driver being instantiated.
      int getSerializedSize()  
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      Geoip.XffConfig getXffConfig()
      If set, the :ref:`xff_num_trusted_hops <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.XffConfig.xff_num_trusted_hops>` field will be used to determine trusted client address from ``x-forwarded-for`` header.
      Geoip.XffConfigOrBuilder getXffConfigOrBuilder()
      If set, the :ref:`xff_num_trusted_hops <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.XffConfig.xff_num_trusted_hops>` field will be used to determine trusted client address from ``x-forwarded-for`` header.
      int hashCode()  
      boolean hasProvider()
      Geoip driver specific configuration which depends on the driver being instantiated.
      boolean hasXffConfig()
      If set, the :ref:`xff_num_trusted_hops <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.XffConfig.xff_num_trusted_hops>` field will be used to determine trusted client address from ``x-forwarded-for`` header.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static Geoip.Builder newBuilder()  
      static Geoip.Builder newBuilder​(Geoip prototype)  
      Geoip.Builder newBuilderForType()  
      protected Geoip.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static Geoip parseDelimitedFrom​(InputStream input)  
      static Geoip parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Geoip parseFrom​(byte[] data)  
      static Geoip parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Geoip parseFrom​(com.google.protobuf.ByteString data)  
      static Geoip parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Geoip parseFrom​(com.google.protobuf.CodedInputStream input)  
      static Geoip parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Geoip parseFrom​(InputStream input)  
      static Geoip parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Geoip parseFrom​(ByteBuffer data)  
      static Geoip parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<Geoip> parser()  
      Geoip.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

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

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

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

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

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

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

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

        toByteArray, toByteString, writeDelimitedTo, writeTo

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

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

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • 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

      • hasXffConfig

        public boolean hasXffConfig()
         If set, the :ref:`xff_num_trusted_hops <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.XffConfig.xff_num_trusted_hops>` field will be used to determine
 trusted client address from ``x-forwarded-for`` header.
 Otherwise, the immediate downstream connection source address will be used.
 [#next-free-field: 2]
        .envoy.extensions.filters.http.geoip.v3.Geoip.XffConfig xff_config = 1;
        Specified by:
        hasXffConfig in interface GeoipOrBuilder
        Returns:
        Whether the xffConfig field is set.

      • getXffConfig

        public Geoip.XffConfig getXffConfig()
         If set, the :ref:`xff_num_trusted_hops <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.XffConfig.xff_num_trusted_hops>` field will be used to determine
 trusted client address from ``x-forwarded-for`` header.
 Otherwise, the immediate downstream connection source address will be used.
 [#next-free-field: 2]
        .envoy.extensions.filters.http.geoip.v3.Geoip.XffConfig xff_config = 1;
        Specified by:
        getXffConfig in interface GeoipOrBuilder
        Returns:
        The xffConfig.

      • getXffConfigOrBuilder

        public Geoip.XffConfigOrBuilder getXffConfigOrBuilder()
         If set, the :ref:`xff_num_trusted_hops <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.XffConfig.xff_num_trusted_hops>` field will be used to determine
 trusted client address from ``x-forwarded-for`` header.
 Otherwise, the immediate downstream connection source address will be used.
 [#next-free-field: 2]
        .envoy.extensions.filters.http.geoip.v3.Geoip.XffConfig xff_config = 1;
        Specified by:
        getXffConfigOrBuilder in interface GeoipOrBuilder

      • hasProvider

        public boolean hasProvider()
         Geoip driver specific configuration which depends on the driver being instantiated.
 See the geoip drivers for examples:
 - :ref:`MaxMindConfig <envoy_v3_api_msg_extensions.geoip_providers.maxmind.v3.MaxMindConfig>`
 [#extension-category: envoy.geoip_providers]
        .envoy.config.core.v3.TypedExtensionConfig provider = 3 [(.validate.rules) = { ... }
        Specified by:
        hasProvider in interface GeoipOrBuilder
        Returns:
        Whether the provider field is set.

      • getProvider

        public TypedExtensionConfig getProvider()
         Geoip driver specific configuration which depends on the driver being instantiated.
 See the geoip drivers for examples:
 - :ref:`MaxMindConfig <envoy_v3_api_msg_extensions.geoip_providers.maxmind.v3.MaxMindConfig>`
 [#extension-category: envoy.geoip_providers]
        .envoy.config.core.v3.TypedExtensionConfig provider = 3 [(.validate.rules) = { ... }
        Specified by:
        getProvider in interface GeoipOrBuilder
        Returns:
        The provider.

      • getProviderOrBuilder

        public TypedExtensionConfigOrBuilder getProviderOrBuilder()
         Geoip driver specific configuration which depends on the driver being instantiated.
 See the geoip drivers for examples:
 - :ref:`MaxMindConfig <envoy_v3_api_msg_extensions.geoip_providers.maxmind.v3.MaxMindConfig>`
 [#extension-category: envoy.geoip_providers]
        .envoy.config.core.v3.TypedExtensionConfig provider = 3 [(.validate.rules) = { ... }
        Specified by:
        getProviderOrBuilder in interface GeoipOrBuilder

      • isInitialized

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

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Geoip parseFrom​(ByteBuffer data)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Geoip parseFrom​(ByteBuffer data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Geoip parseFrom​(com.google.protobuf.ByteString data)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Geoip parseFrom​(com.google.protobuf.ByteString data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Geoip parseFrom​(byte[] data)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Geoip parseFrom​(byte[] data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Geoip parseFrom​(com.google.protobuf.CodedInputStream input,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Geoip.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Geoip.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Geoip.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Geoip getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Geoip> parser()

      • getParserForType

        public com.google.protobuf.Parser<Geoip> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

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