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

Class 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:
    Serialized Form

    • Field Detail

      • UPSTREAM_IP_FIELD_NUMBER

        public static final int UPSTREAM_IP_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UPSTREAM_PORT_RANGE_FIELD_NUMBER

        public static final int UPSTREAM_PORT_RANGE_FIELD_NUMBER
        See Also:
        Constant Field Values

    • 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

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

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

      • 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

      • newBuilderForType

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

      • 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

      • 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