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
@Generated
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 enumChoose between allow all and deny all.static final classProtobuf typeenvoy.type.v3.RateLimitStrategystatic final classBest-effort limit of the number of requests per time unit.static interfacestatic enumNested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intprivate static final RateLimitStrategyprivate byteprivate static final com.google.protobuf.Parser<RateLimitStrategy> static final intprivate static final longprivate Objectprivate intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivateprivateRateLimitStrategy(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionbooleanAllow or Deny the requests.intAllow or Deny the requests.static RateLimitStrategystatic final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.Descriptorcom.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.intLimit the requests by consuming tokens from the Token Bucket.Limit the requests by consuming tokens from the Token Bucket.booleanAllow or Deny the requests.inthashCode()booleanBest-effort limit of the number of requests per time unit, f.e.booleanLimit the requests by consuming tokens from the Token Bucket.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanstatic RateLimitStrategy.Builderstatic RateLimitStrategy.BuildernewBuilder(RateLimitStrategy prototype) protected RateLimitStrategy.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static RateLimitStrategyparseDelimitedFrom(InputStream input) static RateLimitStrategyparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static RateLimitStrategyparseFrom(byte[] data) static RateLimitStrategyparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static RateLimitStrategyparseFrom(com.google.protobuf.ByteString data) static RateLimitStrategyparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static RateLimitStrategyparseFrom(com.google.protobuf.CodedInputStream input) static RateLimitStrategyparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static RateLimitStrategyparseFrom(InputStream input) static RateLimitStrategyparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static RateLimitStrategyparseFrom(ByteBuffer data) static RateLimitStrategyparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<RateLimitStrategy> parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, 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() -
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessage
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
getStrategyCase
- Specified by:
getStrategyCasein 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:
hasBlanketRulein 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:
getBlanketRuleValuein 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:
getBlanketRulein 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:
hasRequestsPerTimeUnitin 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:
getRequestsPerTimeUnitin 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:
getRequestsPerTimeUnitOrBuilderin 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:
hasTokenBucketin 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:
getTokenBucketin 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:
getTokenBucketOrBuilderin interfaceRateLimitStrategyOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein 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:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected RateLimitStrategy.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-