Package io.envoyproxy.envoy.type.v3
Interface RateLimitStrategyOrBuilder
-
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
RateLimitStrategy
,RateLimitStrategy.Builder
public interface RateLimitStrategyOrBuilder extends com.google.protobuf.MessageOrBuilder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description RateLimitStrategy.BlanketRule
getBlanketRule()
Allow or Deny the requests.int
getBlanketRuleValue()
Allow or Deny the requests.RateLimitStrategy.RequestsPerTimeUnit
getRequestsPerTimeUnit()
Best-effort limit of the number of requests per time unit, f.e.RateLimitStrategy.RequestsPerTimeUnitOrBuilder
getRequestsPerTimeUnitOrBuilder()
Best-effort limit of the number of requests per time unit, f.e.RateLimitStrategy.StrategyCase
getStrategyCase()
TokenBucket
getTokenBucket()
Limit the requests by consuming tokens from the Token Bucket.TokenBucketOrBuilder
getTokenBucketOrBuilder()
Limit the requests by consuming tokens from the Token Bucket.boolean
hasBlanketRule()
Allow or Deny the requests.boolean
hasRequestsPerTimeUnit()
Best-effort limit of the number of requests per time unit, f.e.boolean
hasTokenBucket()
Limit the requests by consuming tokens from the Token Bucket.-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
hasBlanketRule
boolean hasBlanketRule()
Allow or Deny the requests. If unset, allow all.
.envoy.type.v3.RateLimitStrategy.BlanketRule blanket_rule = 1 [(.validate.rules) = { ... }
- Returns:
- Whether the blanketRule field is set.
-
getBlanketRuleValue
int getBlanketRuleValue()
Allow or Deny the requests. If unset, allow all.
.envoy.type.v3.RateLimitStrategy.BlanketRule blanket_rule = 1 [(.validate.rules) = { ... }
- Returns:
- The enum numeric value on the wire for blanketRule.
-
getBlanketRule
RateLimitStrategy.BlanketRule getBlanketRule()
Allow or Deny the requests. If unset, allow all.
.envoy.type.v3.RateLimitStrategy.BlanketRule blanket_rule = 1 [(.validate.rules) = { ... }
- Returns:
- The blanketRule.
-
hasRequestsPerTimeUnit
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;
- Returns:
- Whether the requestsPerTimeUnit field is set.
-
getRequestsPerTimeUnit
RateLimitStrategy.RequestsPerTimeUnit 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;
- Returns:
- The requestsPerTimeUnit.
-
getRequestsPerTimeUnitOrBuilder
RateLimitStrategy.RequestsPerTimeUnitOrBuilder 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;
-
hasTokenBucket
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;
- Returns:
- Whether the tokenBucket field is set.
-
getTokenBucket
TokenBucket 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;
- Returns:
- The tokenBucket.
-
getTokenBucketOrBuilder
TokenBucketOrBuilder 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;
-
getStrategyCase
RateLimitStrategy.StrategyCase getStrategyCase()
-
-