Package io.envoyproxy.envoy.type.v3
Class RateLimitStrategy
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.type.v3.RateLimitStrategy
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,RateLimitStrategyOrBuilder
,Serializable
public final class RateLimitStrategy
extends com.google.protobuf.GeneratedMessage
implements RateLimitStrategyOrBuilder
Protobuf type
envoy.type.v3.RateLimitStrategy
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
Choose between allow all and deny all.static final class
Protobuf typeenvoy.type.v3.RateLimitStrategy
static final class
Best-effort limit of the number of requests per time unit.static interface
static enum
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>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParent
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
private static final RateLimitStrategy
private byte
private static final com.google.protobuf.Parser
<RateLimitStrategy> static final int
private static final long
private Object
private int
static final int
Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
private
RateLimitStrategy
(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
Allow or Deny the requests.int
Allow or Deny the requests.static RateLimitStrategy
static final com.google.protobuf.Descriptors.Descriptor
com.google.protobuf.Parser
<RateLimitStrategy> Best-effort limit of the number of requests per time unit, f.e.Best-effort limit of the number of requests per time unit, f.e.int
Limit the requests by consuming tokens from the Token Bucket.Limit the requests by consuming tokens from the Token Bucket.boolean
Allow or Deny the requests.int
hashCode()
boolean
Best-effort limit of the number of requests per time unit, f.e.boolean
Limit the requests by consuming tokens from the Token Bucket.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
static RateLimitStrategy.Builder
static RateLimitStrategy.Builder
newBuilder
(RateLimitStrategy prototype) protected RateLimitStrategy.Builder
newBuilderForType
(com.google.protobuf.AbstractMessage.BuilderParent parent) static RateLimitStrategy
parseDelimitedFrom
(InputStream input) static RateLimitStrategy
parseDelimitedFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static RateLimitStrategy
parseFrom
(byte[] data) static RateLimitStrategy
parseFrom
(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static RateLimitStrategy
parseFrom
(com.google.protobuf.ByteString data) static RateLimitStrategy
parseFrom
(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static RateLimitStrategy
parseFrom
(com.google.protobuf.CodedInputStream input) static RateLimitStrategy
parseFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static RateLimitStrategy
parseFrom
(InputStream input) static RateLimitStrategy
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static RateLimitStrategy
parseFrom
(ByteBuffer data) static RateLimitStrategy
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser
<RateLimitStrategy> parser()
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
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
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
strategyCase_
private int strategyCase_ -
strategy_
-
BLANKET_RULE_FIELD_NUMBER
public static final int BLANKET_RULE_FIELD_NUMBER- See Also:
-
REQUESTS_PER_TIME_UNIT_FIELD_NUMBER
public static final int REQUESTS_PER_TIME_UNIT_FIELD_NUMBER- See Also:
-
TOKEN_BUCKET_FIELD_NUMBER
public static final int TOKEN_BUCKET_FIELD_NUMBER- See Also:
-
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
RateLimitStrategy
private RateLimitStrategy(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
RateLimitStrategy
private RateLimitStrategy()
-
-
Method Details
-
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
-
getStrategyCase
- Specified by:
getStrategyCase
in interfaceRateLimitStrategyOrBuilder
-
hasBlanketRule
public boolean hasBlanketRule()Allow or Deny the requests. If unset, allow all.
.envoy.type.v3.RateLimitStrategy.BlanketRule blanket_rule = 1 [(.validate.rules) = { ... }
- Specified by:
hasBlanketRule
in interfaceRateLimitStrategyOrBuilder
- Returns:
- Whether the blanketRule field is set.
-
getBlanketRuleValue
public int getBlanketRuleValue()Allow or Deny the requests. If unset, allow all.
.envoy.type.v3.RateLimitStrategy.BlanketRule blanket_rule = 1 [(.validate.rules) = { ... }
- Specified by:
getBlanketRuleValue
in interfaceRateLimitStrategyOrBuilder
- Returns:
- The enum numeric value on the wire for blanketRule.
-
getBlanketRule
Allow or Deny the requests. If unset, allow all.
.envoy.type.v3.RateLimitStrategy.BlanketRule blanket_rule = 1 [(.validate.rules) = { ... }
- Specified by:
getBlanketRule
in interfaceRateLimitStrategyOrBuilder
- Returns:
- The blanketRule.
-
hasRequestsPerTimeUnit
public boolean hasRequestsPerTimeUnit()Best-effort limit of the number of requests per time unit, f.e. requests per second. Does not prescribe any specific rate limiting algorithm, see :ref:`RequestsPerTimeUnit <envoy_v3_api_msg_type.v3.RateLimitStrategy.RequestsPerTimeUnit>` for details.
.envoy.type.v3.RateLimitStrategy.RequestsPerTimeUnit requests_per_time_unit = 2;
- Specified by:
hasRequestsPerTimeUnit
in interfaceRateLimitStrategyOrBuilder
- Returns:
- Whether the requestsPerTimeUnit field is set.
-
getRequestsPerTimeUnit
Best-effort limit of the number of requests per time unit, f.e. requests per second. Does not prescribe any specific rate limiting algorithm, see :ref:`RequestsPerTimeUnit <envoy_v3_api_msg_type.v3.RateLimitStrategy.RequestsPerTimeUnit>` for details.
.envoy.type.v3.RateLimitStrategy.RequestsPerTimeUnit requests_per_time_unit = 2;
- Specified by:
getRequestsPerTimeUnit
in interfaceRateLimitStrategyOrBuilder
- Returns:
- The requestsPerTimeUnit.
-
getRequestsPerTimeUnitOrBuilder
Best-effort limit of the number of requests per time unit, f.e. requests per second. Does not prescribe any specific rate limiting algorithm, see :ref:`RequestsPerTimeUnit <envoy_v3_api_msg_type.v3.RateLimitStrategy.RequestsPerTimeUnit>` for details.
.envoy.type.v3.RateLimitStrategy.RequestsPerTimeUnit requests_per_time_unit = 2;
- Specified by:
getRequestsPerTimeUnitOrBuilder
in interfaceRateLimitStrategyOrBuilder
-
hasTokenBucket
public boolean hasTokenBucket()Limit the requests by consuming tokens from the Token Bucket. Allow the same number of requests as the number of tokens available in the token bucket.
.envoy.type.v3.TokenBucket token_bucket = 3;
- Specified by:
hasTokenBucket
in interfaceRateLimitStrategyOrBuilder
- Returns:
- Whether the tokenBucket field is set.
-
getTokenBucket
Limit the requests by consuming tokens from the Token Bucket. Allow the same number of requests as the number of tokens available in the token bucket.
.envoy.type.v3.TokenBucket token_bucket = 3;
- Specified by:
getTokenBucket
in interfaceRateLimitStrategyOrBuilder
- Returns:
- The tokenBucket.
-
getTokenBucketOrBuilder
Limit the requests by consuming tokens from the Token Bucket. Allow the same number of requests as the number of tokens available in the token bucket.
.envoy.type.v3.TokenBucket token_bucket = 3;
- Specified by:
getTokenBucketOrBuilder
in interfaceRateLimitStrategyOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
- 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 parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RateLimitStrategy parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RateLimitStrategy parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RateLimitStrategy 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 parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RateLimitStrategy parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static RateLimitStrategy parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static RateLimitStrategy parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static RateLimitStrategy parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static RateLimitStrategy parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected RateLimitStrategy.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
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
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-