Package io.envoyproxy.envoy.type.v3
Class RateLimitStrategy.RequestsPerTimeUnit
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessage
-
- io.envoyproxy.envoy.type.v3.RateLimitStrategy.RequestsPerTimeUnit
-
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,RateLimitStrategy.RequestsPerTimeUnitOrBuilder
,java.io.Serializable
- Enclosing class:
- RateLimitStrategy
public static final class RateLimitStrategy.RequestsPerTimeUnit extends com.google.protobuf.GeneratedMessage implements RateLimitStrategy.RequestsPerTimeUnitOrBuilder
Best-effort limit of the number of requests per time unit. Allows to specify the desired requests per second (RPS, QPS), requests per minute (QPM, RPM), etc., without specifying a rate limiting algorithm implementation. ``RequestsPerTimeUnit`` strategy does not demand any specific rate limiting algorithm to be used (in contrast to the :ref:`TokenBucket <envoy_v3_api_msg_type.v3.TokenBucket>`, for example). It implies that the implementation details of rate limiting algorithm are irrelevant as long as the configured number of "requests per time unit" is achieved. Note that the ``TokenBucket`` is still a valid implementation of the ``RequestsPerTimeUnit`` strategy, and may be chosen to enforce the rate limit. However, there's no guarantee it will be the ``TokenBucket`` in particular, and not the Leaky Bucket, the Sliding Window, or any other rate limiting algorithm that fulfills the requirements.
Protobuf typeenvoy.type.v3.RateLimitStrategy.RequestsPerTimeUnit
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RateLimitStrategy.RequestsPerTimeUnit.Builder
Best-effort limit of the number of requests per time unit.-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description private static RateLimitStrategy.RequestsPerTimeUnit
DEFAULT_INSTANCE
private byte
memoizedIsInitialized
private static com.google.protobuf.Parser<RateLimitStrategy.RequestsPerTimeUnit>
PARSER
static int
REQUESTS_PER_TIME_UNIT_FIELD_NUMBER
private long
requestsPerTimeUnit_
private static long
serialVersionUID
static int
TIME_UNIT_FIELD_NUMBER
private int
timeUnit_
-
Constructor Summary
Constructors Modifier Constructor Description private
RequestsPerTimeUnit()
private
RequestsPerTimeUnit(com.google.protobuf.GeneratedMessage.Builder<?> builder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
static RateLimitStrategy.RequestsPerTimeUnit
getDefaultInstance()
RateLimitStrategy.RequestsPerTimeUnit
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
com.google.protobuf.Parser<RateLimitStrategy.RequestsPerTimeUnit>
getParserForType()
long
getRequestsPerTimeUnit()
The desired number of requests per :ref:`time_unit <envoy_v3_api_field_type.v3.RateLimitStrategy.RequestsPerTimeUnit.time_unit>` to allow.int
getSerializedSize()
RateLimitUnit
getTimeUnit()
The unit of time.int
getTimeUnitValue()
The unit of time.int
hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
static RateLimitStrategy.RequestsPerTimeUnit.Builder
newBuilder()
static RateLimitStrategy.RequestsPerTimeUnit.Builder
newBuilder(RateLimitStrategy.RequestsPerTimeUnit prototype)
RateLimitStrategy.RequestsPerTimeUnit.Builder
newBuilderForType()
protected RateLimitStrategy.RequestsPerTimeUnit.Builder
newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static RateLimitStrategy.RequestsPerTimeUnit
parseDelimitedFrom(java.io.InputStream input)
static RateLimitStrategy.RequestsPerTimeUnit
parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimitStrategy.RequestsPerTimeUnit
parseFrom(byte[] data)
static RateLimitStrategy.RequestsPerTimeUnit
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimitStrategy.RequestsPerTimeUnit
parseFrom(com.google.protobuf.ByteString data)
static RateLimitStrategy.RequestsPerTimeUnit
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimitStrategy.RequestsPerTimeUnit
parseFrom(com.google.protobuf.CodedInputStream input)
static RateLimitStrategy.RequestsPerTimeUnit
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimitStrategy.RequestsPerTimeUnit
parseFrom(java.io.InputStream input)
static RateLimitStrategy.RequestsPerTimeUnit
parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RateLimitStrategy.RequestsPerTimeUnit
parseFrom(java.nio.ByteBuffer data)
static RateLimitStrategy.RequestsPerTimeUnit
parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RateLimitStrategy.RequestsPerTimeUnit>
parser()
RateLimitStrategy.RequestsPerTimeUnit.Builder
toBuilder()
void
writeTo(com.google.protobuf.CodedOutputStream output)
-
Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
REQUESTS_PER_TIME_UNIT_FIELD_NUMBER
public static final int REQUESTS_PER_TIME_UNIT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
requestsPerTimeUnit_
private long requestsPerTimeUnit_
-
TIME_UNIT_FIELD_NUMBER
public static final int TIME_UNIT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
timeUnit_
private int timeUnit_
-
memoizedIsInitialized
private byte memoizedIsInitialized
-
DEFAULT_INSTANCE
private static final RateLimitStrategy.RequestsPerTimeUnit DEFAULT_INSTANCE
-
PARSER
private static final com.google.protobuf.Parser<RateLimitStrategy.RequestsPerTimeUnit> PARSER
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage
-
getRequestsPerTimeUnit
public long getRequestsPerTimeUnit()
The desired number of requests per :ref:`time_unit <envoy_v3_api_field_type.v3.RateLimitStrategy.RequestsPerTimeUnit.time_unit>` to allow. If set to ``0``, deny all (equivalent to ``BlanketRule.DENY_ALL``). .. note:: Note that the algorithm implementation determines the course of action for the requests over the limit. As long as the ``requests_per_time_unit`` converges on the desired value, it's allowed to treat this field as a soft-limit: allow bursts, redistribute the allowance over time, etc.
uint64 requests_per_time_unit = 1;
- Specified by:
getRequestsPerTimeUnit
in interfaceRateLimitStrategy.RequestsPerTimeUnitOrBuilder
- Returns:
- The requestsPerTimeUnit.
-
getTimeUnitValue
public int getTimeUnitValue()
The unit of time. Ignored when :ref:`requests_per_time_unit <envoy_v3_api_field_type.v3.RateLimitStrategy.RequestsPerTimeUnit.requests_per_time_unit>` is ``0`` (deny all).
.envoy.type.v3.RateLimitUnit time_unit = 2 [(.validate.rules) = { ... }
- Specified by:
getTimeUnitValue
in interfaceRateLimitStrategy.RequestsPerTimeUnitOrBuilder
- Returns:
- The enum numeric value on the wire for timeUnit.
-
getTimeUnit
public RateLimitUnit getTimeUnit()
The unit of time. Ignored when :ref:`requests_per_time_unit <envoy_v3_api_field_type.v3.RateLimitStrategy.RequestsPerTimeUnit.requests_per_time_unit>` is ``0`` (deny all).
.envoy.type.v3.RateLimitUnit time_unit = 2 [(.validate.rules) = { ... }
- Specified by:
getTimeUnit
in interfaceRateLimitStrategy.RequestsPerTimeUnitOrBuilder
- Returns:
- The timeUnit.
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
java.io.IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
public boolean equals(java.lang.Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static RateLimitStrategy.RequestsPerTimeUnit parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RateLimitStrategy.RequestsPerTimeUnit parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RateLimitStrategy.RequestsPerTimeUnit parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RateLimitStrategy.RequestsPerTimeUnit parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RateLimitStrategy.RequestsPerTimeUnit parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RateLimitStrategy.RequestsPerTimeUnit parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RateLimitStrategy.RequestsPerTimeUnit parseFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static RateLimitStrategy.RequestsPerTimeUnit parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static RateLimitStrategy.RequestsPerTimeUnit parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static RateLimitStrategy.RequestsPerTimeUnit parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static RateLimitStrategy.RequestsPerTimeUnit parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static RateLimitStrategy.RequestsPerTimeUnit parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
newBuilderForType
public RateLimitStrategy.RequestsPerTimeUnit.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static RateLimitStrategy.RequestsPerTimeUnit.Builder newBuilder()
-
newBuilder
public static RateLimitStrategy.RequestsPerTimeUnit.Builder newBuilder(RateLimitStrategy.RequestsPerTimeUnit prototype)
-
toBuilder
public RateLimitStrategy.RequestsPerTimeUnit.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected RateLimitStrategy.RequestsPerTimeUnit.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
- Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
public static RateLimitStrategy.RequestsPerTimeUnit getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<RateLimitStrategy.RequestsPerTimeUnit> parser()
-
getParserForType
public com.google.protobuf.Parser<RateLimitStrategy.RequestsPerTimeUnit> getParserForType()
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
public RateLimitStrategy.RequestsPerTimeUnit getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-