Package io.envoyproxy.envoy.config.filter.network.local_rate_limit.v2alpha

Class LocalRateLimit

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.config.filter.network.local_rate_limit.v2alpha.LocalRateLimit
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, LocalRateLimitOrBuilder, Serializable
public final class LocalRateLimit extends com.google.protobuf.GeneratedMessageV3 implements LocalRateLimitOrBuilder
Protobuf type envoy.config.filter.network.local_rate_limit.v2alpha.LocalRateLimit
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    LocalRateLimit.Builder
    Protobuf type envoy.config.filter.network.local_rate_limit.v2alpha.LocalRateLimit

    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
    RUNTIME_ENABLED_FIELD_NUMBER
     
    static final int
    STAT_PREFIX_FIELD_NUMBER
     
    static final int
    TOKEN_BUCKET_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 LocalRateLimit
    getDefaultInstance()
     
    LocalRateLimit
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<LocalRateLimit>
    getParserForType()
     
    RuntimeFeatureFlag
    getRuntimeEnabled()
    Runtime flag that controls whether the filter is enabled or not.
    RuntimeFeatureFlagOrBuilder
    getRuntimeEnabledOrBuilder()
    Runtime flag that controls whether the filter is enabled or not.
    int
    getSerializedSize()
     
    String
    getStatPrefix()
    The prefix to use when emitting :ref:`statistics <config_network_filters_local_rate_limit_stats>`.
    com.google.protobuf.ByteString
    getStatPrefixBytes()
    The prefix to use when emitting :ref:`statistics <config_network_filters_local_rate_limit_stats>`.
    TokenBucket
    getTokenBucket()
    The token bucket configuration to use for rate limiting connections that are processed by the filter's filter chain.
    TokenBucketOrBuilder
    getTokenBucketOrBuilder()
    The token bucket configuration to use for rate limiting connections that are processed by the filter's filter chain.
    int
    hashCode()
     
    boolean
    hasRuntimeEnabled()
    Runtime flag that controls whether the filter is enabled or not.
    boolean
    hasTokenBucket()
    The token bucket configuration to use for rate limiting connections that are processed by the filter's filter chain.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static LocalRateLimit.Builder
    newBuilder()
     
    static LocalRateLimit.Builder
    newBuilder(LocalRateLimit prototype)
     
    LocalRateLimit.Builder
    newBuilderForType()
     
    protected LocalRateLimit.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static LocalRateLimit
    parseDelimitedFrom(InputStream input)
     
    static LocalRateLimit
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static LocalRateLimit
    parseFrom(byte[] data)
     
    static LocalRateLimit
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static LocalRateLimit
    parseFrom(com.google.protobuf.ByteString data)
     
    static LocalRateLimit
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static LocalRateLimit
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static LocalRateLimit
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static LocalRateLimit
    parseFrom(InputStream input)
     
    static LocalRateLimit
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static LocalRateLimit
    parseFrom(ByteBuffer data)
     
    static LocalRateLimit
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<LocalRateLimit>
    parser()
     
    LocalRateLimit.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

    • STAT_PREFIX_FIELD_NUMBER

      public static final int STAT_PREFIX_FIELD_NUMBER
      See Also:

    • TOKEN_BUCKET_FIELD_NUMBER

      public static final int TOKEN_BUCKET_FIELD_NUMBER
      See Also:

    • RUNTIME_ENABLED_FIELD_NUMBER

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

    • getStatPrefix

      public String getStatPrefix()
       The prefix to use when emitting :ref:`statistics
 <config_network_filters_local_rate_limit_stats>`.
      string stat_prefix = 1 [(.validate.rules) = { ... }
      Specified by:
      getStatPrefix in interface LocalRateLimitOrBuilder
      Returns:
      The statPrefix.

    • getStatPrefixBytes

      public com.google.protobuf.ByteString getStatPrefixBytes()
       The prefix to use when emitting :ref:`statistics
 <config_network_filters_local_rate_limit_stats>`.
      string stat_prefix = 1 [(.validate.rules) = { ... }
      Specified by:
      getStatPrefixBytes in interface LocalRateLimitOrBuilder
      Returns:
      The bytes for statPrefix.

    • hasTokenBucket

      public boolean hasTokenBucket()
       The token bucket configuration to use for rate limiting connections that are processed by the
 filter's filter chain. Each incoming connection processed by the filter consumes a single
 token. If the token is available, the connection will be allowed. If no tokens are available,
 the connection will be immediately closed.

 .. note::
   In the current implementation each filter and filter chain has an independent rate limit.

 .. note::
   In the current implementation the token bucket's :ref:`fill_interval
   <envoy_api_field_type.TokenBucket.fill_interval>` must be >= 50ms to avoid too aggressive
   refills.
      .envoy.type.TokenBucket token_bucket = 2 [(.validate.rules) = { ... }
      Specified by:
      hasTokenBucket in interface LocalRateLimitOrBuilder
      Returns:
      Whether the tokenBucket field is set.

    • getTokenBucket

      public TokenBucket getTokenBucket()
       The token bucket configuration to use for rate limiting connections that are processed by the
 filter's filter chain. Each incoming connection processed by the filter consumes a single
 token. If the token is available, the connection will be allowed. If no tokens are available,
 the connection will be immediately closed.

 .. note::
   In the current implementation each filter and filter chain has an independent rate limit.

 .. note::
   In the current implementation the token bucket's :ref:`fill_interval
   <envoy_api_field_type.TokenBucket.fill_interval>` must be >= 50ms to avoid too aggressive
   refills.
      .envoy.type.TokenBucket token_bucket = 2 [(.validate.rules) = { ... }
      Specified by:
      getTokenBucket in interface LocalRateLimitOrBuilder
      Returns:
      The tokenBucket.

    • getTokenBucketOrBuilder

      public TokenBucketOrBuilder getTokenBucketOrBuilder()
       The token bucket configuration to use for rate limiting connections that are processed by the
 filter's filter chain. Each incoming connection processed by the filter consumes a single
 token. If the token is available, the connection will be allowed. If no tokens are available,
 the connection will be immediately closed.

 .. note::
   In the current implementation each filter and filter chain has an independent rate limit.

 .. note::
   In the current implementation the token bucket's :ref:`fill_interval
   <envoy_api_field_type.TokenBucket.fill_interval>` must be >= 50ms to avoid too aggressive
   refills.
      .envoy.type.TokenBucket token_bucket = 2 [(.validate.rules) = { ... }
      Specified by:
      getTokenBucketOrBuilder in interface LocalRateLimitOrBuilder

    • hasRuntimeEnabled

      public boolean hasRuntimeEnabled()
       Runtime flag that controls whether the filter is enabled or not. If not specified, defaults
 to enabled.
      .envoy.api.v2.core.RuntimeFeatureFlag runtime_enabled = 3;
      Specified by:
      hasRuntimeEnabled in interface LocalRateLimitOrBuilder
      Returns:
      Whether the runtimeEnabled field is set.

    • getRuntimeEnabled

      public RuntimeFeatureFlag getRuntimeEnabled()
       Runtime flag that controls whether the filter is enabled or not. If not specified, defaults
 to enabled.
      .envoy.api.v2.core.RuntimeFeatureFlag runtime_enabled = 3;
      Specified by:
      getRuntimeEnabled in interface LocalRateLimitOrBuilder
      Returns:
      The runtimeEnabled.

    • getRuntimeEnabledOrBuilder

      public RuntimeFeatureFlagOrBuilder getRuntimeEnabledOrBuilder()
       Runtime flag that controls whether the filter is enabled or not. If not specified, defaults
 to enabled.
      .envoy.api.v2.core.RuntimeFeatureFlag runtime_enabled = 3;
      Specified by:
      getRuntimeEnabledOrBuilder in interface LocalRateLimitOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static LocalRateLimit.Builder newBuilder()

    • newBuilder

      public static LocalRateLimit.Builder newBuilder(LocalRateLimit prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static LocalRateLimit getDefaultInstance()

    • parser

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

    • getParserForType

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