Interface RateLimitOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
RateLimit
,RateLimit.Builder
public interface RateLimitOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptiongetActions
(int index) A list of actions that are to be applied for this rate limit configuration.int
A list of actions that are to be applied for this rate limit configuration.A list of actions that are to be applied for this rate limit configuration.getActionsOrBuilder
(int index) A list of actions that are to be applied for this rate limit configuration.List
<? extends RateLimit.ActionOrBuilder> A list of actions that are to be applied for this rate limit configuration.The key to be set in runtime to disable this rate limit configuration.com.google.protobuf.ByteString
The key to be set in runtime to disable this rate limit configuration.getLimit()
An optional limit override to be appended to the descriptor produced by this rate limit configuration.An optional limit override to be appended to the descriptor produced by this rate limit configuration.com.google.protobuf.UInt32Value
getStage()
Refers to the stage set in the filter.com.google.protobuf.UInt32ValueOrBuilder
Refers to the stage set in the filter.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.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
hasStage
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.
.google.protobuf.UInt32Value stage = 1 [(.validate.rules) = { ... }
- Returns:
- Whether the stage field is set.
-
getStage
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.
.google.protobuf.UInt32Value stage = 1 [(.validate.rules) = { ... }
- Returns:
- The stage.
-
getStageOrBuilder
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.
.google.protobuf.UInt32Value stage = 1 [(.validate.rules) = { ... }
-
getDisableKey
String getDisableKey()The key to be set in runtime to disable this rate limit configuration.
string disable_key = 2;
- Returns:
- The disableKey.
-
getDisableKeyBytes
com.google.protobuf.ByteString getDisableKeyBytes()The key to be set in runtime to disable this rate limit configuration.
string disable_key = 2;
- Returns:
- The bytes for disableKey.
-
getActionsList
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) = { ... }
-
getActions
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) = { ... }
-
getActionsCount
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) = { ... }
-
getActionsOrBuilderList
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) = { ... }
-
getActionsOrBuilder
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) = { ... }
-
hasLimit
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.
.envoy.config.route.v3.RateLimit.Override limit = 4;
- Returns:
- Whether the limit field is set.
-
getLimit
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.
.envoy.config.route.v3.RateLimit.Override limit = 4;
- Returns:
- The limit.
-
getLimitOrBuilder
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.
.envoy.config.route.v3.RateLimit.Override limit = 4;
-