Class RateLimitPerRoute

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimitPerRouteOrBuilder, java.io.Serializable

    public final class RateLimitPerRoute
    extends com.google.protobuf.GeneratedMessageV3
    implements RateLimitPerRouteOrBuilder
    Protobuf type envoy.extensions.filters.http.ratelimit.v3.RateLimitPerRoute
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  RateLimitPerRoute.Builder
      Protobuf type envoy.extensions.filters.http.ratelimit.v3.RateLimitPerRoute
      static class  RateLimitPerRoute.OverrideOptions
      The override option determines how the filter handles the cases where there is an override config at a more specific level than this one (from least to most specific: virtual host, route, cluster weight).
      static class  RateLimitPerRoute.VhRateLimitsOptions
      [#next-major-version: unify with local ratelimit, should use common.ratelimit.v3.VhRateLimitsOptions instead.]
      • 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 OVERRIDE_OPTION_FIELD_NUMBER  
      static int RATE_LIMITS_FIELD_NUMBER  
      static int VH_RATE_LIMITS_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
    • Field Detail

      • VH_RATE_LIMITS_FIELD_NUMBER

        public static final int VH_RATE_LIMITS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • OVERRIDE_OPTION_FIELD_NUMBER

        public static final int OVERRIDE_OPTION_FIELD_NUMBER
        See Also:
        Constant Field Values
      • RATE_LIMITS_FIELD_NUMBER

        public static final int RATE_LIMITS_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • newInstance

        protected java.lang.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
      • getVhRateLimitsValue

        public int getVhRateLimitsValue()
         Specifies if the rate limit filter should include the virtual host rate limits.
         [#next-major-version: unify with local ratelimit, should use common.ratelimit.v3.VhRateLimitsOptions instead.]
         
        .envoy.extensions.filters.http.ratelimit.v3.RateLimitPerRoute.VhRateLimitsOptions vh_rate_limits = 1 [(.validate.rules) = { ... }
        Specified by:
        getVhRateLimitsValue in interface RateLimitPerRouteOrBuilder
        Returns:
        The enum numeric value on the wire for vhRateLimits.
      • getVhRateLimits

        public RateLimitPerRoute.VhRateLimitsOptions getVhRateLimits()
         Specifies if the rate limit filter should include the virtual host rate limits.
         [#next-major-version: unify with local ratelimit, should use common.ratelimit.v3.VhRateLimitsOptions instead.]
         
        .envoy.extensions.filters.http.ratelimit.v3.RateLimitPerRoute.VhRateLimitsOptions vh_rate_limits = 1 [(.validate.rules) = { ... }
        Specified by:
        getVhRateLimits in interface RateLimitPerRouteOrBuilder
        Returns:
        The vhRateLimits.
      • getOverrideOptionValue

        public int getOverrideOptionValue()
         Specifies if the rate limit filter should include the lower levels (route level, virtual host level or cluster weight level) rate limits override options.
         [#not-implemented-hide:]
         
        .envoy.extensions.filters.http.ratelimit.v3.RateLimitPerRoute.OverrideOptions override_option = 2 [(.validate.rules) = { ... }
        Specified by:
        getOverrideOptionValue in interface RateLimitPerRouteOrBuilder
        Returns:
        The enum numeric value on the wire for overrideOption.
      • getOverrideOption

        public RateLimitPerRoute.OverrideOptions getOverrideOption()
         Specifies if the rate limit filter should include the lower levels (route level, virtual host level or cluster weight level) rate limits override options.
         [#not-implemented-hide:]
         
        .envoy.extensions.filters.http.ratelimit.v3.RateLimitPerRoute.OverrideOptions override_option = 2 [(.validate.rules) = { ... }
        Specified by:
        getOverrideOption in interface RateLimitPerRouteOrBuilder
        Returns:
        The overrideOption.
      • getRateLimitsList

        public java.util.List<RateLimitConfig> getRateLimitsList()
         Rate limit configuration. If not set, uses the
         :ref:`VirtualHost.rate_limits<envoy_v3_api_field_config.route.v3.VirtualHost.rate_limits>` or
         :ref:`RouteAction.rate_limits<envoy_v3_api_field_config.route.v3.RouteAction.rate_limits>` fields instead.
         [#not-implemented-hide:]
         
        repeated .envoy.extensions.filters.http.ratelimit.v3.RateLimitConfig rate_limits = 3;
        Specified by:
        getRateLimitsList in interface RateLimitPerRouteOrBuilder
      • getRateLimitsOrBuilderList

        public java.util.List<? extends RateLimitConfigOrBuilder> getRateLimitsOrBuilderList()
         Rate limit configuration. If not set, uses the
         :ref:`VirtualHost.rate_limits<envoy_v3_api_field_config.route.v3.VirtualHost.rate_limits>` or
         :ref:`RouteAction.rate_limits<envoy_v3_api_field_config.route.v3.RouteAction.rate_limits>` fields instead.
         [#not-implemented-hide:]
         
        repeated .envoy.extensions.filters.http.ratelimit.v3.RateLimitConfig rate_limits = 3;
        Specified by:
        getRateLimitsOrBuilderList in interface RateLimitPerRouteOrBuilder
      • getRateLimitsCount

        public int getRateLimitsCount()
         Rate limit configuration. If not set, uses the
         :ref:`VirtualHost.rate_limits<envoy_v3_api_field_config.route.v3.VirtualHost.rate_limits>` or
         :ref:`RouteAction.rate_limits<envoy_v3_api_field_config.route.v3.RouteAction.rate_limits>` fields instead.
         [#not-implemented-hide:]
         
        repeated .envoy.extensions.filters.http.ratelimit.v3.RateLimitConfig rate_limits = 3;
        Specified by:
        getRateLimitsCount in interface RateLimitPerRouteOrBuilder
      • getRateLimits

        public RateLimitConfig getRateLimits​(int index)
         Rate limit configuration. If not set, uses the
         :ref:`VirtualHost.rate_limits<envoy_v3_api_field_config.route.v3.VirtualHost.rate_limits>` or
         :ref:`RouteAction.rate_limits<envoy_v3_api_field_config.route.v3.RouteAction.rate_limits>` fields instead.
         [#not-implemented-hide:]
         
        repeated .envoy.extensions.filters.http.ratelimit.v3.RateLimitConfig rate_limits = 3;
        Specified by:
        getRateLimits in interface RateLimitPerRouteOrBuilder
      • getRateLimitsOrBuilder

        public RateLimitConfigOrBuilder getRateLimitsOrBuilder​(int index)
         Rate limit configuration. If not set, uses the
         :ref:`VirtualHost.rate_limits<envoy_v3_api_field_config.route.v3.VirtualHost.rate_limits>` or
         :ref:`RouteAction.rate_limits<envoy_v3_api_field_config.route.v3.RouteAction.rate_limits>` fields instead.
         [#not-implemented-hide:]
         
        repeated .envoy.extensions.filters.http.ratelimit.v3.RateLimitConfig rate_limits = 3;
        Specified by:
        getRateLimitsOrBuilder in interface RateLimitPerRouteOrBuilder
      • 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 java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.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​(java.lang.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 RateLimitPerRoute parseFrom​(java.nio.ByteBuffer data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static RateLimitPerRoute parseFrom​(java.nio.ByteBuffer data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

        public static RateLimitPerRoute parseFrom​(java.io.InputStream input)
                                           throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static RateLimitPerRoute parseFrom​(java.io.InputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static RateLimitPerRoute parseDelimitedFrom​(java.io.InputStream input)
                                                    throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static RateLimitPerRoute parseDelimitedFrom​(java.io.InputStream input,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static RateLimitPerRoute parseFrom​(com.google.protobuf.CodedInputStream input)
                                           throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static RateLimitPerRoute parseFrom​(com.google.protobuf.CodedInputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws java.io.IOException
        Throws:
        java.io.IOException
      • newBuilderForType

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

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

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

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