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

Class IPTagging

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.http.ip_tagging.v3.IPTagging
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, IPTaggingOrBuilder, Serializable
public final class IPTagging extends com.google.protobuf.GeneratedMessageV3 implements IPTaggingOrBuilder
 [#next-free-field: 6]
Protobuf type envoy.extensions.filters.http.ip_tagging.v3.IPTagging
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    IPTagging.Builder
    [#next-free-field: 6]
    static final class 
    IPTagging.IPTag
    Supplies the IP tag name and the IP address subnets.
    static final class 
    IPTagging.IpTagHeader
    Specify to which header the tags will be written.
    static interface 
    IPTagging.IpTagHeaderOrBuilder
     
    static interface 
    IPTagging.IPTagOrBuilder
     
    static enum 
    IPTagging.RequestType
    The type of requests the filter should apply to.

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

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, 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 final int
    IP_TAG_HEADER_FIELD_NUMBER
     
    static final int
    IP_TAGS_FIELD_NUMBER
     
    static final int
    REQUEST_TYPE_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

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static IPTagging
    getDefaultInstance()
     
    IPTagging
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    IPTagging.IpTagHeader
    getIpTagHeader()
    Specify to which header the tags will be written.
    IPTagging.IpTagHeaderOrBuilder
    getIpTagHeaderOrBuilder()
    Specify to which header the tags will be written.
    IPTagging.IPTag
    getIpTags(int index)
    [#comment:TODO(ccaraman): Extend functionality to load IP tags from file system.
    int
    getIpTagsCount()
    [#comment:TODO(ccaraman): Extend functionality to load IP tags from file system.
    List<IPTagging.IPTag>
    getIpTagsList()
    [#comment:TODO(ccaraman): Extend functionality to load IP tags from file system.
    IPTagging.IPTagOrBuilder
    getIpTagsOrBuilder(int index)
    [#comment:TODO(ccaraman): Extend functionality to load IP tags from file system.
    List<? extends IPTagging.IPTagOrBuilder>
    getIpTagsOrBuilderList()
    [#comment:TODO(ccaraman): Extend functionality to load IP tags from file system.
    com.google.protobuf.Parser<IPTagging>
    getParserForType()
     
    IPTagging.RequestType
    getRequestType()
    The type of request the filter should apply to.
    int
    getRequestTypeValue()
    The type of request the filter should apply to.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasIpTagHeader()
    Specify to which header the tags will be written.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static IPTagging.Builder
    newBuilder()
     
    static IPTagging.Builder
    newBuilder(IPTagging prototype)
     
    IPTagging.Builder
    newBuilderForType()
     
    protected IPTagging.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static IPTagging
    parseDelimitedFrom(InputStream input)
     
    static IPTagging
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static IPTagging
    parseFrom(byte[] data)
     
    static IPTagging
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static IPTagging
    parseFrom(com.google.protobuf.ByteString data)
     
    static IPTagging
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static IPTagging
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static IPTagging
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static IPTagging
    parseFrom(InputStream input)
     
    static IPTagging
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static IPTagging
    parseFrom(ByteBuffer data)
     
    static IPTagging
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<IPTagging>
    parser()
     
    IPTagging.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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 class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    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, getUnknownFields, hasField, hasOneof

  • Field Details

    • REQUEST_TYPE_FIELD_NUMBER

      public static final int REQUEST_TYPE_FIELD_NUMBER
      See Also:

    • IP_TAGS_FIELD_NUMBER

      public static final int IP_TAGS_FIELD_NUMBER
      See Also:

    • IP_TAG_HEADER_FIELD_NUMBER

      public static final int IP_TAG_HEADER_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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

    • getRequestTypeValue

      public int getRequestTypeValue()
       The type of request the filter should apply to.
      .envoy.extensions.filters.http.ip_tagging.v3.IPTagging.RequestType request_type = 1 [(.validate.rules) = { ... }
      Specified by:
      getRequestTypeValue in interface IPTaggingOrBuilder
      Returns:
      The enum numeric value on the wire for requestType.

    • getRequestType

      public IPTagging.RequestType getRequestType()
       The type of request the filter should apply to.
      .envoy.extensions.filters.http.ip_tagging.v3.IPTagging.RequestType request_type = 1 [(.validate.rules) = { ... }
      Specified by:
      getRequestType in interface IPTaggingOrBuilder
      Returns:
      The requestType.

    • getIpTagsList

      public List<IPTagging.IPTag> getIpTagsList()
       [#comment:TODO(ccaraman): Extend functionality to load IP tags from file system.
 Tracked by issue https://github.com/envoyproxy/envoy/issues/2695]
 The set of IP tags for the filter.
      repeated .envoy.extensions.filters.http.ip_tagging.v3.IPTagging.IPTag ip_tags = 4 [(.validate.rules) = { ... }
      Specified by:
      getIpTagsList in interface IPTaggingOrBuilder

    • getIpTagsOrBuilderList

      public List<? extends IPTagging.IPTagOrBuilder> getIpTagsOrBuilderList()
       [#comment:TODO(ccaraman): Extend functionality to load IP tags from file system.
 Tracked by issue https://github.com/envoyproxy/envoy/issues/2695]
 The set of IP tags for the filter.
      repeated .envoy.extensions.filters.http.ip_tagging.v3.IPTagging.IPTag ip_tags = 4 [(.validate.rules) = { ... }
      Specified by:
      getIpTagsOrBuilderList in interface IPTaggingOrBuilder

    • getIpTagsCount

      public int getIpTagsCount()
       [#comment:TODO(ccaraman): Extend functionality to load IP tags from file system.
 Tracked by issue https://github.com/envoyproxy/envoy/issues/2695]
 The set of IP tags for the filter.
      repeated .envoy.extensions.filters.http.ip_tagging.v3.IPTagging.IPTag ip_tags = 4 [(.validate.rules) = { ... }
      Specified by:
      getIpTagsCount in interface IPTaggingOrBuilder

    • getIpTags

      public IPTagging.IPTag getIpTags(int index)
       [#comment:TODO(ccaraman): Extend functionality to load IP tags from file system.
 Tracked by issue https://github.com/envoyproxy/envoy/issues/2695]
 The set of IP tags for the filter.
      repeated .envoy.extensions.filters.http.ip_tagging.v3.IPTagging.IPTag ip_tags = 4 [(.validate.rules) = { ... }
      Specified by:
      getIpTags in interface IPTaggingOrBuilder

    • getIpTagsOrBuilder

      public IPTagging.IPTagOrBuilder getIpTagsOrBuilder(int index)
       [#comment:TODO(ccaraman): Extend functionality to load IP tags from file system.
 Tracked by issue https://github.com/envoyproxy/envoy/issues/2695]
 The set of IP tags for the filter.
      repeated .envoy.extensions.filters.http.ip_tagging.v3.IPTagging.IPTag ip_tags = 4 [(.validate.rules) = { ... }
      Specified by:
      getIpTagsOrBuilder in interface IPTaggingOrBuilder

    • hasIpTagHeader

      public boolean hasIpTagHeader()
       Specify to which header the tags will be written.

 If left unspecified, the tags will be appended to the ``x-envoy-ip-tags`` header.
      .envoy.extensions.filters.http.ip_tagging.v3.IPTagging.IpTagHeader ip_tag_header = 5;
      Specified by:
      hasIpTagHeader in interface IPTaggingOrBuilder
      Returns:
      Whether the ipTagHeader field is set.

    • getIpTagHeader

      public IPTagging.IpTagHeader getIpTagHeader()
       Specify to which header the tags will be written.

 If left unspecified, the tags will be appended to the ``x-envoy-ip-tags`` header.
      .envoy.extensions.filters.http.ip_tagging.v3.IPTagging.IpTagHeader ip_tag_header = 5;
      Specified by:
      getIpTagHeader in interface IPTaggingOrBuilder
      Returns:
      The ipTagHeader.

    • getIpTagHeaderOrBuilder

      public IPTagging.IpTagHeaderOrBuilder getIpTagHeaderOrBuilder()
       Specify to which header the tags will be written.

 If left unspecified, the tags will be appended to the ``x-envoy-ip-tags`` header.
      .envoy.extensions.filters.http.ip_tagging.v3.IPTagging.IpTagHeader ip_tag_header = 5;
      Specified by:
      getIpTagHeaderOrBuilder in interface IPTaggingOrBuilder

    • 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 IPTagging parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static IPTagging parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static IPTagging parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static IPTagging parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static IPTagging parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static IPTagging parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static IPTagging.Builder newBuilder()

    • newBuilder

      public static IPTagging.Builder newBuilder(IPTagging prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static IPTagging getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<IPTagging> 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 IPTagging getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder