Package io.envoyproxy.envoy.extensions.rbac.matchers.upstream_ip_port.v3

Class UpstreamIpPortMatcher

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.rbac.matchers.upstream_ip_port.v3.UpstreamIpPortMatcher
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, UpstreamIpPortMatcherOrBuilder, Serializable
public final class UpstreamIpPortMatcher extends com.google.protobuf.GeneratedMessageV3 implements UpstreamIpPortMatcherOrBuilder
 This is configuration for matching upstream ip and port.
 Note that although both fields are optional, at least one of IP or port must be supplied. If only
 one is supplied the other is a wildcard match.
 This matcher requires a filter in the chain to have saved the upstream address in the
 filter state before the matcher is executed by RBAC filter. The state should be saved with key
 ``envoy.stream.upstream_address`` (See
 :repo:`upstream_address.h<source/common/stream_info/upstream_address.h>`).
 Also, See :repo:`proxy_filter.cc<source/extensions/filters/http/dynamic_forward_proxy/proxy_filter.cc>`
 for an example of a filter which populates the FilterState.
Protobuf type envoy.extensions.rbac.matchers.upstream_ip_port.v3.UpstreamIpPortMatcher
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    UpstreamIpPortMatcher.Builder
    This is configuration for matching upstream ip and port.

    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
    UPSTREAM_IP_FIELD_NUMBER
     
    static final int
    UPSTREAM_PORT_RANGE_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 UpstreamIpPortMatcher
    getDefaultInstance()
     
    UpstreamIpPortMatcher
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<UpstreamIpPortMatcher>
    getParserForType()
     
    int
    getSerializedSize()
     
    CidrRange
    getUpstreamIp()
    A CIDR block that will be used to match the upstream IP.
    CidrRangeOrBuilder
    getUpstreamIpOrBuilder()
    A CIDR block that will be used to match the upstream IP.
    Int64Range
    getUpstreamPortRange()
    A port range that will be used to match the upstream port.
    Int64RangeOrBuilder
    getUpstreamPortRangeOrBuilder()
    A port range that will be used to match the upstream port.
    int
    hashCode()
     
    boolean
    hasUpstreamIp()
    A CIDR block that will be used to match the upstream IP.
    boolean
    hasUpstreamPortRange()
    A port range that will be used to match the upstream port.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static UpstreamIpPortMatcher.Builder
    newBuilder()
     
    static UpstreamIpPortMatcher.Builder
    newBuilder(UpstreamIpPortMatcher prototype)
     
    UpstreamIpPortMatcher.Builder
    newBuilderForType()
     
    protected UpstreamIpPortMatcher.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static UpstreamIpPortMatcher
    parseDelimitedFrom(InputStream input)
     
    static UpstreamIpPortMatcher
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static UpstreamIpPortMatcher
    parseFrom(byte[] data)
     
    static UpstreamIpPortMatcher
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static UpstreamIpPortMatcher
    parseFrom(com.google.protobuf.ByteString data)
     
    static UpstreamIpPortMatcher
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static UpstreamIpPortMatcher
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static UpstreamIpPortMatcher
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static UpstreamIpPortMatcher
    parseFrom(InputStream input)
     
    static UpstreamIpPortMatcher
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static UpstreamIpPortMatcher
    parseFrom(ByteBuffer data)
     
    static UpstreamIpPortMatcher
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<UpstreamIpPortMatcher>
    parser()
     
    UpstreamIpPortMatcher.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

    • UPSTREAM_IP_FIELD_NUMBER

      public static final int UPSTREAM_IP_FIELD_NUMBER
      See Also:

    • UPSTREAM_PORT_RANGE_FIELD_NUMBER

      public static final int UPSTREAM_PORT_RANGE_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

    • hasUpstreamIp

      public boolean hasUpstreamIp()
       A CIDR block that will be used to match the upstream IP.
 Both Ipv4 and Ipv6 ranges can be matched.
      .envoy.config.core.v3.CidrRange upstream_ip = 1;
      Specified by:
      hasUpstreamIp in interface UpstreamIpPortMatcherOrBuilder
      Returns:
      Whether the upstreamIp field is set.

    • getUpstreamIp

      public CidrRange getUpstreamIp()
       A CIDR block that will be used to match the upstream IP.
 Both Ipv4 and Ipv6 ranges can be matched.
      .envoy.config.core.v3.CidrRange upstream_ip = 1;
      Specified by:
      getUpstreamIp in interface UpstreamIpPortMatcherOrBuilder
      Returns:
      The upstreamIp.

    • getUpstreamIpOrBuilder

      public CidrRangeOrBuilder getUpstreamIpOrBuilder()
       A CIDR block that will be used to match the upstream IP.
 Both Ipv4 and Ipv6 ranges can be matched.
      .envoy.config.core.v3.CidrRange upstream_ip = 1;
      Specified by:
      getUpstreamIpOrBuilder in interface UpstreamIpPortMatcherOrBuilder

    • hasUpstreamPortRange

      public boolean hasUpstreamPortRange()
       A port range that will be used to match the upstream port.
      .envoy.type.v3.Int64Range upstream_port_range = 2;
      Specified by:
      hasUpstreamPortRange in interface UpstreamIpPortMatcherOrBuilder
      Returns:
      Whether the upstreamPortRange field is set.

    • getUpstreamPortRange

      public Int64Range getUpstreamPortRange()
       A port range that will be used to match the upstream port.
      .envoy.type.v3.Int64Range upstream_port_range = 2;
      Specified by:
      getUpstreamPortRange in interface UpstreamIpPortMatcherOrBuilder
      Returns:
      The upstreamPortRange.

    • getUpstreamPortRangeOrBuilder

      public Int64RangeOrBuilder getUpstreamPortRangeOrBuilder()
       A port range that will be used to match the upstream port.
      .envoy.type.v3.Int64Range upstream_port_range = 2;
      Specified by:
      getUpstreamPortRangeOrBuilder in interface UpstreamIpPortMatcherOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static UpstreamIpPortMatcher.Builder newBuilder()

    • newBuilder

      public static UpstreamIpPortMatcher.Builder newBuilder(UpstreamIpPortMatcher prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static UpstreamIpPortMatcher getDefaultInstance()

    • parser

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

    • getParserForType

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