Package io.envoyproxy.envoy.config.route.v3

Class RateLimit

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.config.route.v3.RateLimit
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimitOrBuilder, Serializable
public final class RateLimit extends com.google.protobuf.GeneratedMessageV3 implements RateLimitOrBuilder
 Global rate limiting :ref:`architecture overview <arch_overview_global_rate_limit>`.
 Also applies to Local rate limiting :ref:`using descriptors <config_http_filters_local_rate_limit_descriptors>`.
 [#next-free-field: 7]
Protobuf type envoy.config.route.v3.RateLimit
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    RateLimit.Action
    [#next-free-field: 13]
    static interface 
    RateLimit.ActionOrBuilder
     
    static final class 
    RateLimit.Builder
    Global rate limiting :ref:`architecture overview <arch_overview_global_rate_limit>`.
    static final class 
    RateLimit.HitsAddend
    Protobuf type envoy.config.route.v3.RateLimit.HitsAddend
    static interface 
    RateLimit.HitsAddendOrBuilder
     
    static final class 
    RateLimit.Override
    Protobuf type envoy.config.route.v3.RateLimit.Override
    static interface 
    RateLimit.OverrideOrBuilder
     

    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
    ACTIONS_FIELD_NUMBER
     
    static final int
    APPLY_ON_STREAM_DONE_FIELD_NUMBER
     
    static final int
    DISABLE_KEY_FIELD_NUMBER
     
    static final int
    HITS_ADDEND_FIELD_NUMBER
     
    static final int
    LIMIT_FIELD_NUMBER
     
    static final int
    STAGE_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)
     
    RateLimit.Action
    getActions(int index)
    A list of actions that are to be applied for this rate limit configuration.
    int
    getActionsCount()
    A list of actions that are to be applied for this rate limit configuration.
    List<RateLimit.Action>
    getActionsList()
    A list of actions that are to be applied for this rate limit configuration.
    RateLimit.ActionOrBuilder
    getActionsOrBuilder(int index)
    A list of actions that are to be applied for this rate limit configuration.
    List<? extends RateLimit.ActionOrBuilder>
    getActionsOrBuilderList()
    A list of actions that are to be applied for this rate limit configuration.
    boolean
    getApplyOnStreamDone()
    If true, the rate limit request will be applied when the stream completes.
    static RateLimit
    getDefaultInstance()
     
    RateLimit
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getDisableKey()
    The key to be set in runtime to disable this rate limit configuration. .. note:: This is not supported if the rate limit action is configured in the ``typed_per_filter_config`` like :ref:`VirtualHost.typed_per_filter_config<envoy_v3_api_field_config.route.v3.VirtualHost.typed_per_filter_config>` or :ref:`Route.typed_per_filter_config<envoy_v3_api_field_config.route.v3.Route.typed_per_filter_config>`, etc.
    com.google.protobuf.ByteString
    getDisableKeyBytes()
    The key to be set in runtime to disable this rate limit configuration. .. note:: This is not supported if the rate limit action is configured in the ``typed_per_filter_config`` like :ref:`VirtualHost.typed_per_filter_config<envoy_v3_api_field_config.route.v3.VirtualHost.typed_per_filter_config>` or :ref:`Route.typed_per_filter_config<envoy_v3_api_field_config.route.v3.Route.typed_per_filter_config>`, etc.
    RateLimit.HitsAddend
    getHitsAddend()
    An optional hits addend to be appended to the descriptor produced by this rate limit configuration. .. note:: This is only supported if the rate limit action is configured in the ``typed_per_filter_config`` like :ref:`VirtualHost.typed_per_filter_config<envoy_v3_api_field_config.route.v3.VirtualHost.typed_per_filter_config>` or :ref:`Route.typed_per_filter_config<envoy_v3_api_field_config.route.v3.Route.typed_per_filter_config>`, etc.
    RateLimit.HitsAddendOrBuilder
    getHitsAddendOrBuilder()
    An optional hits addend to be appended to the descriptor produced by this rate limit configuration. .. note:: This is only supported if the rate limit action is configured in the ``typed_per_filter_config`` like :ref:`VirtualHost.typed_per_filter_config<envoy_v3_api_field_config.route.v3.VirtualHost.typed_per_filter_config>` or :ref:`Route.typed_per_filter_config<envoy_v3_api_field_config.route.v3.Route.typed_per_filter_config>`, etc.
    RateLimit.Override
    getLimit()
    An optional limit override to be appended to the descriptor produced by this rate limit configuration.
    RateLimit.OverrideOrBuilder
    getLimitOrBuilder()
    An optional limit override to be appended to the descriptor produced by this rate limit configuration.
    com.google.protobuf.Parser<RateLimit>
    getParserForType()
     
    int
    getSerializedSize()
     
    com.google.protobuf.UInt32Value
    getStage()
    Refers to the stage set in the filter.
    com.google.protobuf.UInt32ValueOrBuilder
    getStageOrBuilder()
    Refers to the stage set in the filter.
    int
    hashCode()
     
    boolean
    hasHitsAddend()
    An optional hits addend to be appended to the descriptor produced by this rate limit configuration. .. note:: This is only supported if the rate limit action is configured in the ``typed_per_filter_config`` like :ref:`VirtualHost.typed_per_filter_config<envoy_v3_api_field_config.route.v3.VirtualHost.typed_per_filter_config>` or :ref:`Route.typed_per_filter_config<envoy_v3_api_field_config.route.v3.Route.typed_per_filter_config>`, etc.
    boolean
    hasLimit()
    An optional limit override to be appended to the descriptor produced by this rate limit configuration.
    boolean
    hasStage()
    Refers to the stage set in the filter.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static RateLimit.Builder
    newBuilder()
     
    static RateLimit.Builder
    newBuilder(RateLimit prototype)
     
    RateLimit.Builder
    newBuilderForType()
     
    protected RateLimit.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static RateLimit
    parseDelimitedFrom(InputStream input)
     
    static RateLimit
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RateLimit
    parseFrom(byte[] data)
     
    static RateLimit
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RateLimit
    parseFrom(com.google.protobuf.ByteString data)
     
    static RateLimit
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RateLimit
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static RateLimit
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RateLimit
    parseFrom(InputStream input)
     
    static RateLimit
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RateLimit
    parseFrom(ByteBuffer data)
     
    static RateLimit
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<RateLimit>
    parser()
     
    RateLimit.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

    • STAGE_FIELD_NUMBER

      public static final int STAGE_FIELD_NUMBER
      See Also:

    • DISABLE_KEY_FIELD_NUMBER

      public static final int DISABLE_KEY_FIELD_NUMBER
      See Also:

    • ACTIONS_FIELD_NUMBER

      public static final int ACTIONS_FIELD_NUMBER
      See Also:

    • LIMIT_FIELD_NUMBER

      public static final int LIMIT_FIELD_NUMBER
      See Also:

    • HITS_ADDEND_FIELD_NUMBER

      public static final int HITS_ADDEND_FIELD_NUMBER
      See Also:

    • APPLY_ON_STREAM_DONE_FIELD_NUMBER

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

    • hasStage

      public boolean hasStage()
       Refers to the stage set in the filter. The rate limit configuration only
 applies to filters with the same stage number. The default stage number is
 0.

 .. note::

   The filter supports a range of 0 - 10 inclusively for stage numbers.

 .. note::
   This is not supported if the rate limit action is configured in the ``typed_per_filter_config`` like
   :ref:`VirtualHost.typed_per_filter_config<envoy_v3_api_field_config.route.v3.VirtualHost.typed_per_filter_config>` or
   :ref:`Route.typed_per_filter_config<envoy_v3_api_field_config.route.v3.Route.typed_per_filter_config>`, etc.
      .google.protobuf.UInt32Value stage = 1 [(.validate.rules) = { ... }
      Specified by:
      hasStage in interface RateLimitOrBuilder
      Returns:
      Whether the stage field is set.

    • getStage

      public com.google.protobuf.UInt32Value getStage()
       Refers to the stage set in the filter. The rate limit configuration only
 applies to filters with the same stage number. The default stage number is
 0.

 .. note::

   The filter supports a range of 0 - 10 inclusively for stage numbers.

 .. note::
   This is not supported if the rate limit action is configured in the ``typed_per_filter_config`` like
   :ref:`VirtualHost.typed_per_filter_config<envoy_v3_api_field_config.route.v3.VirtualHost.typed_per_filter_config>` or
   :ref:`Route.typed_per_filter_config<envoy_v3_api_field_config.route.v3.Route.typed_per_filter_config>`, etc.
      .google.protobuf.UInt32Value stage = 1 [(.validate.rules) = { ... }
      Specified by:
      getStage in interface RateLimitOrBuilder
      Returns:
      The stage.

    • getStageOrBuilder

      public com.google.protobuf.UInt32ValueOrBuilder getStageOrBuilder()
       Refers to the stage set in the filter. The rate limit configuration only
 applies to filters with the same stage number. The default stage number is
 0.

 .. note::

   The filter supports a range of 0 - 10 inclusively for stage numbers.

 .. note::
   This is not supported if the rate limit action is configured in the ``typed_per_filter_config`` like
   :ref:`VirtualHost.typed_per_filter_config<envoy_v3_api_field_config.route.v3.VirtualHost.typed_per_filter_config>` or
   :ref:`Route.typed_per_filter_config<envoy_v3_api_field_config.route.v3.Route.typed_per_filter_config>`, etc.
      .google.protobuf.UInt32Value stage = 1 [(.validate.rules) = { ... }
      Specified by:
      getStageOrBuilder in interface RateLimitOrBuilder

    • getDisableKey

      public String getDisableKey()
       The key to be set in runtime to disable this rate limit configuration.

 .. note::
   This is not supported if the rate limit action is configured in the ``typed_per_filter_config`` like
   :ref:`VirtualHost.typed_per_filter_config<envoy_v3_api_field_config.route.v3.VirtualHost.typed_per_filter_config>` or
   :ref:`Route.typed_per_filter_config<envoy_v3_api_field_config.route.v3.Route.typed_per_filter_config>`, etc.
      string disable_key = 2;
      Specified by:
      getDisableKey in interface RateLimitOrBuilder
      Returns:
      The disableKey.

    • getDisableKeyBytes

      public com.google.protobuf.ByteString getDisableKeyBytes()
       The key to be set in runtime to disable this rate limit configuration.

 .. note::
   This is not supported if the rate limit action is configured in the ``typed_per_filter_config`` like
   :ref:`VirtualHost.typed_per_filter_config<envoy_v3_api_field_config.route.v3.VirtualHost.typed_per_filter_config>` or
   :ref:`Route.typed_per_filter_config<envoy_v3_api_field_config.route.v3.Route.typed_per_filter_config>`, etc.
      string disable_key = 2;
      Specified by:
      getDisableKeyBytes in interface RateLimitOrBuilder
      Returns:
      The bytes for disableKey.

    • getActionsList

      public List<RateLimit.Action> getActionsList()
       A list of actions that are to be applied for this rate limit configuration.
 Order matters as the actions are processed sequentially and the descriptor
 is composed by appending descriptor entries in that sequence. If an action
 cannot append a descriptor entry, no descriptor is generated for the
 configuration. See :ref:`composing actions
 <config_http_filters_rate_limit_composing_actions>` for additional documentation.
      repeated .envoy.config.route.v3.RateLimit.Action actions = 3 [(.validate.rules) = { ... }
      Specified by:
      getActionsList in interface RateLimitOrBuilder

    • getActionsOrBuilderList

      public List<? extends RateLimit.ActionOrBuilder> getActionsOrBuilderList()
       A list of actions that are to be applied for this rate limit configuration.
 Order matters as the actions are processed sequentially and the descriptor
 is composed by appending descriptor entries in that sequence. If an action
 cannot append a descriptor entry, no descriptor is generated for the
 configuration. See :ref:`composing actions
 <config_http_filters_rate_limit_composing_actions>` for additional documentation.
      repeated .envoy.config.route.v3.RateLimit.Action actions = 3 [(.validate.rules) = { ... }
      Specified by:
      getActionsOrBuilderList in interface RateLimitOrBuilder

    • getActionsCount

      public int getActionsCount()
       A list of actions that are to be applied for this rate limit configuration.
 Order matters as the actions are processed sequentially and the descriptor
 is composed by appending descriptor entries in that sequence. If an action
 cannot append a descriptor entry, no descriptor is generated for the
 configuration. See :ref:`composing actions
 <config_http_filters_rate_limit_composing_actions>` for additional documentation.
      repeated .envoy.config.route.v3.RateLimit.Action actions = 3 [(.validate.rules) = { ... }
      Specified by:
      getActionsCount in interface RateLimitOrBuilder

    • getActions

      public RateLimit.Action getActions(int index)
       A list of actions that are to be applied for this rate limit configuration.
 Order matters as the actions are processed sequentially and the descriptor
 is composed by appending descriptor entries in that sequence. If an action
 cannot append a descriptor entry, no descriptor is generated for the
 configuration. See :ref:`composing actions
 <config_http_filters_rate_limit_composing_actions>` for additional documentation.
      repeated .envoy.config.route.v3.RateLimit.Action actions = 3 [(.validate.rules) = { ... }
      Specified by:
      getActions in interface RateLimitOrBuilder

    • getActionsOrBuilder

      public RateLimit.ActionOrBuilder getActionsOrBuilder(int index)
       A list of actions that are to be applied for this rate limit configuration.
 Order matters as the actions are processed sequentially and the descriptor
 is composed by appending descriptor entries in that sequence. If an action
 cannot append a descriptor entry, no descriptor is generated for the
 configuration. See :ref:`composing actions
 <config_http_filters_rate_limit_composing_actions>` for additional documentation.
      repeated .envoy.config.route.v3.RateLimit.Action actions = 3 [(.validate.rules) = { ... }
      Specified by:
      getActionsOrBuilder in interface RateLimitOrBuilder

    • hasLimit

      public boolean hasLimit()
       An optional limit override to be appended to the descriptor produced by this
 rate limit configuration. If the override value is invalid or cannot be resolved
 from metadata, no override is provided. See :ref:`rate limit override
 <config_http_filters_rate_limit_rate_limit_override>` for more information.

 .. note::
   This is not supported if the rate limit action is configured in the ``typed_per_filter_config`` like
   :ref:`VirtualHost.typed_per_filter_config<envoy_v3_api_field_config.route.v3.VirtualHost.typed_per_filter_config>` or
   :ref:`Route.typed_per_filter_config<envoy_v3_api_field_config.route.v3.Route.typed_per_filter_config>`, etc.
      .envoy.config.route.v3.RateLimit.Override limit = 4;
      Specified by:
      hasLimit in interface RateLimitOrBuilder
      Returns:
      Whether the limit field is set.

    • getLimit

      public RateLimit.Override getLimit()
       An optional limit override to be appended to the descriptor produced by this
 rate limit configuration. If the override value is invalid or cannot be resolved
 from metadata, no override is provided. See :ref:`rate limit override
 <config_http_filters_rate_limit_rate_limit_override>` for more information.

 .. note::
   This is not supported if the rate limit action is configured in the ``typed_per_filter_config`` like
   :ref:`VirtualHost.typed_per_filter_config<envoy_v3_api_field_config.route.v3.VirtualHost.typed_per_filter_config>` or
   :ref:`Route.typed_per_filter_config<envoy_v3_api_field_config.route.v3.Route.typed_per_filter_config>`, etc.
      .envoy.config.route.v3.RateLimit.Override limit = 4;
      Specified by:
      getLimit in interface RateLimitOrBuilder
      Returns:
      The limit.

    • getLimitOrBuilder

      public RateLimit.OverrideOrBuilder getLimitOrBuilder()
       An optional limit override to be appended to the descriptor produced by this
 rate limit configuration. If the override value is invalid or cannot be resolved
 from metadata, no override is provided. See :ref:`rate limit override
 <config_http_filters_rate_limit_rate_limit_override>` for more information.

 .. note::
   This is not supported if the rate limit action is configured in the ``typed_per_filter_config`` like
   :ref:`VirtualHost.typed_per_filter_config<envoy_v3_api_field_config.route.v3.VirtualHost.typed_per_filter_config>` or
   :ref:`Route.typed_per_filter_config<envoy_v3_api_field_config.route.v3.Route.typed_per_filter_config>`, etc.
      .envoy.config.route.v3.RateLimit.Override limit = 4;
      Specified by:
      getLimitOrBuilder in interface RateLimitOrBuilder

    • hasHitsAddend

      public boolean hasHitsAddend()
       An optional hits addend to be appended to the descriptor produced by this rate limit
 configuration.

 .. note::
   This is only supported if the rate limit action is configured in the ``typed_per_filter_config`` like
   :ref:`VirtualHost.typed_per_filter_config<envoy_v3_api_field_config.route.v3.VirtualHost.typed_per_filter_config>` or
   :ref:`Route.typed_per_filter_config<envoy_v3_api_field_config.route.v3.Route.typed_per_filter_config>`, etc.
      .envoy.config.route.v3.RateLimit.HitsAddend hits_addend = 5;
      Specified by:
      hasHitsAddend in interface RateLimitOrBuilder
      Returns:
      Whether the hitsAddend field is set.

    • getHitsAddend

      public RateLimit.HitsAddend getHitsAddend()
       An optional hits addend to be appended to the descriptor produced by this rate limit
 configuration.

 .. note::
   This is only supported if the rate limit action is configured in the ``typed_per_filter_config`` like
   :ref:`VirtualHost.typed_per_filter_config<envoy_v3_api_field_config.route.v3.VirtualHost.typed_per_filter_config>` or
   :ref:`Route.typed_per_filter_config<envoy_v3_api_field_config.route.v3.Route.typed_per_filter_config>`, etc.
      .envoy.config.route.v3.RateLimit.HitsAddend hits_addend = 5;
      Specified by:
      getHitsAddend in interface RateLimitOrBuilder
      Returns:
      The hitsAddend.

    • getHitsAddendOrBuilder

      public RateLimit.HitsAddendOrBuilder getHitsAddendOrBuilder()
       An optional hits addend to be appended to the descriptor produced by this rate limit
 configuration.

 .. note::
   This is only supported if the rate limit action is configured in the ``typed_per_filter_config`` like
   :ref:`VirtualHost.typed_per_filter_config<envoy_v3_api_field_config.route.v3.VirtualHost.typed_per_filter_config>` or
   :ref:`Route.typed_per_filter_config<envoy_v3_api_field_config.route.v3.Route.typed_per_filter_config>`, etc.
      .envoy.config.route.v3.RateLimit.HitsAddend hits_addend = 5;
      Specified by:
      getHitsAddendOrBuilder in interface RateLimitOrBuilder

    • getApplyOnStreamDone

      public boolean getApplyOnStreamDone()
       If true, the rate limit request will be applied when the stream completes. The default value is false.
 This is useful when the rate limit budget needs to reflect the response context that is not available
 on the request path.

 For example, let's say the upstream service calculates the usage statistics and returns them in the response body
 and we want to utilize these numbers to apply the rate limit action for the subsequent requests.
 Combined with another filter that can set the desired addend based on the response (e.g. Lua filter),
 this can be used to subtract the usage statistics from the rate limit budget.

 A rate limit applied on the stream completion is "fire-and-forget" by nature, and rate limit is not enforced by this config.
 In other words, the current request won't be blocked when this is true, but the budget will be updated for the subsequent
 requests based on the action with this field set to true. Users should ensure that the rate limit is enforced by the actions
 applied on the request path, i.e. the ones with this field set to false.

 Currently, this is only supported by the HTTP global rate filter.
      bool apply_on_stream_done = 6;
      Specified by:
      getApplyOnStreamDone in interface RateLimitOrBuilder
      Returns:
      The applyOnStreamDone.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static RateLimit.Builder newBuilder()

    • newBuilder

      public static RateLimit.Builder newBuilder(RateLimit prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static RateLimit getDefaultInstance()

    • parser

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

    • getParserForType

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