io.envoyproxy.envoy.extensions.filters.network.local_ratelimit.v3

Class LocalRateLimit.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>

io.envoyproxy.envoy.extensions.filters.network.local_ratelimit.v3.LocalRateLimit.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, LocalRateLimitOrBuilder, Cloneable

Enclosing class:

LocalRateLimit

public static final class LocalRateLimit.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>
implements LocalRateLimitOrBuilder

Protobuf type envoy.extensions.filters.network.local_ratelimit.v3.LocalRateLimit

Method Summary

Modifier and Type	Method and Description
LocalRateLimit.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
LocalRateLimit	build()
LocalRateLimit	buildPartial()
LocalRateLimit.Builder	clear()
LocalRateLimit.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
LocalRateLimit.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
LocalRateLimit.Builder	clearRuntimeEnabled() Runtime flag that controls whether the filter is enabled or not.
LocalRateLimit.Builder	clearStatPrefix() The prefix to use when emitting :ref:`statistics <config_network_filters_local_rate_limit_stats>`.
LocalRateLimit.Builder	clearTokenBucket() The token bucket configuration to use for rate limiting connections that are processed by the filter's filter chain.
LocalRateLimit.Builder	clone()
LocalRateLimit	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
RuntimeFeatureFlag	getRuntimeEnabled() Runtime flag that controls whether the filter is enabled or not.
RuntimeFeatureFlag.Builder	getRuntimeEnabledBuilder() Runtime flag that controls whether the filter is enabled or not.
RuntimeFeatureFlagOrBuilder	getRuntimeEnabledOrBuilder() Runtime flag that controls whether the filter is enabled or not.
String	getStatPrefix() The prefix to use when emitting :ref:`statistics <config_network_filters_local_rate_limit_stats>`.
com.google.protobuf.ByteString	getStatPrefixBytes() The prefix to use when emitting :ref:`statistics <config_network_filters_local_rate_limit_stats>`.
TokenBucket	getTokenBucket() The token bucket configuration to use for rate limiting connections that are processed by the filter's filter chain.
TokenBucket.Builder	getTokenBucketBuilder() The token bucket configuration to use for rate limiting connections that are processed by the filter's filter chain.
TokenBucketOrBuilder	getTokenBucketOrBuilder() The token bucket configuration to use for rate limiting connections that are processed by the filter's filter chain.
boolean	hasRuntimeEnabled() Runtime flag that controls whether the filter is enabled or not.
boolean	hasTokenBucket() The token bucket configuration to use for rate limiting connections that are processed by the filter's filter chain.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
LocalRateLimit.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
LocalRateLimit.Builder	mergeFrom(LocalRateLimit other)
LocalRateLimit.Builder	mergeFrom(com.google.protobuf.Message other)
LocalRateLimit.Builder	mergeRuntimeEnabled(RuntimeFeatureFlag value) Runtime flag that controls whether the filter is enabled or not.
LocalRateLimit.Builder	mergeTokenBucket(TokenBucket value) The token bucket configuration to use for rate limiting connections that are processed by the filter's filter chain.
LocalRateLimit.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
LocalRateLimit.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
LocalRateLimit.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
LocalRateLimit.Builder	setRuntimeEnabled(RuntimeFeatureFlag.Builder builderForValue) Runtime flag that controls whether the filter is enabled or not.
LocalRateLimit.Builder	setRuntimeEnabled(RuntimeFeatureFlag value) Runtime flag that controls whether the filter is enabled or not.
LocalRateLimit.Builder	setStatPrefix(String value) The prefix to use when emitting :ref:`statistics <config_network_filters_local_rate_limit_stats>`.
LocalRateLimit.Builder	setStatPrefixBytes(com.google.protobuf.ByteString value) The prefix to use when emitting :ref:`statistics <config_network_filters_local_rate_limit_stats>`.
LocalRateLimit.Builder	setTokenBucket(TokenBucket.Builder builderForValue) The token bucket configuration to use for rate limiting connections that are processed by the filter's filter chain.
LocalRateLimit.Builder	setTokenBucket(TokenBucket value) The token bucket configuration to use for rate limiting connections that are processed by the filter's filter chain.
LocalRateLimit.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>

clear

public LocalRateLimit.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>

getDefaultInstanceForType

public LocalRateLimit getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public LocalRateLimit build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public LocalRateLimit buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public LocalRateLimit.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>

setField

public LocalRateLimit.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>

clearField

public LocalRateLimit.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>

clearOneof

public LocalRateLimit.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>

setRepeatedField

public LocalRateLimit.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               int index,
                                               Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>

addRepeatedField

public LocalRateLimit.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>

mergeFrom

public LocalRateLimit.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<LocalRateLimit.Builder>

mergeFrom

public LocalRateLimit.Builder mergeFrom(LocalRateLimit other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>

mergeFrom

public LocalRateLimit.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<LocalRateLimit.Builder>

Throws:

IOException

getStatPrefix

public String getStatPrefix()

 The prefix to use when emitting :ref:`statistics
 <config_network_filters_local_rate_limit_stats>`.
 

string stat_prefix = 1 [(.validate.rules) = { ... }

Specified by:

getStatPrefix in interface LocalRateLimitOrBuilder

getStatPrefixBytes

public com.google.protobuf.ByteString getStatPrefixBytes()

 The prefix to use when emitting :ref:`statistics
 <config_network_filters_local_rate_limit_stats>`.
 

string stat_prefix = 1 [(.validate.rules) = { ... }

Specified by:

getStatPrefixBytes in interface LocalRateLimitOrBuilder

setStatPrefix

public LocalRateLimit.Builder setStatPrefix(String value)

 The prefix to use when emitting :ref:`statistics
 <config_network_filters_local_rate_limit_stats>`.
 

string stat_prefix = 1 [(.validate.rules) = { ... }

clearStatPrefix

public LocalRateLimit.Builder clearStatPrefix()

 The prefix to use when emitting :ref:`statistics
 <config_network_filters_local_rate_limit_stats>`.
 

string stat_prefix = 1 [(.validate.rules) = { ... }

setStatPrefixBytes

public LocalRateLimit.Builder setStatPrefixBytes(com.google.protobuf.ByteString value)

 The prefix to use when emitting :ref:`statistics
 <config_network_filters_local_rate_limit_stats>`.
 

string stat_prefix = 1 [(.validate.rules) = { ... }

hasTokenBucket

public boolean hasTokenBucket()

 The token bucket configuration to use for rate limiting connections that are processed by the
 filter's filter chain. Each incoming connection processed by the filter consumes a single
 token. If the token is available, the connection will be allowed. If no tokens are available,
 the connection will be immediately closed.
 .. note::
   In the current implementation each filter and filter chain has an independent rate limit.
 .. note::
   In the current implementation the token bucket's :ref:`fill_interval
   <envoy_api_field_type.v3.TokenBucket.fill_interval>` must be >= 50ms to avoid too aggressive
   refills.
 

.envoy.type.v3.TokenBucket token_bucket = 2 [(.validate.rules) = { ... }

Specified by:

hasTokenBucket in interface LocalRateLimitOrBuilder

getTokenBucket

public TokenBucket getTokenBucket()

 The token bucket configuration to use for rate limiting connections that are processed by the
 filter's filter chain. Each incoming connection processed by the filter consumes a single
 token. If the token is available, the connection will be allowed. If no tokens are available,
 the connection will be immediately closed.
 .. note::
   In the current implementation each filter and filter chain has an independent rate limit.
 .. note::
   In the current implementation the token bucket's :ref:`fill_interval
   <envoy_api_field_type.v3.TokenBucket.fill_interval>` must be >= 50ms to avoid too aggressive
   refills.
 

.envoy.type.v3.TokenBucket token_bucket = 2 [(.validate.rules) = { ... }

Specified by:

getTokenBucket in interface LocalRateLimitOrBuilder

setTokenBucket

public LocalRateLimit.Builder setTokenBucket(TokenBucket value)

 The token bucket configuration to use for rate limiting connections that are processed by the
 filter's filter chain. Each incoming connection processed by the filter consumes a single
 token. If the token is available, the connection will be allowed. If no tokens are available,
 the connection will be immediately closed.
 .. note::
   In the current implementation each filter and filter chain has an independent rate limit.
 .. note::
   In the current implementation the token bucket's :ref:`fill_interval
   <envoy_api_field_type.v3.TokenBucket.fill_interval>` must be >= 50ms to avoid too aggressive
   refills.
 

.envoy.type.v3.TokenBucket token_bucket = 2 [(.validate.rules) = { ... }

setTokenBucket

public LocalRateLimit.Builder setTokenBucket(TokenBucket.Builder builderForValue)

 The token bucket configuration to use for rate limiting connections that are processed by the
 filter's filter chain. Each incoming connection processed by the filter consumes a single
 token. If the token is available, the connection will be allowed. If no tokens are available,
 the connection will be immediately closed.
 .. note::
   In the current implementation each filter and filter chain has an independent rate limit.
 .. note::
   In the current implementation the token bucket's :ref:`fill_interval
   <envoy_api_field_type.v3.TokenBucket.fill_interval>` must be >= 50ms to avoid too aggressive
   refills.
 

.envoy.type.v3.TokenBucket token_bucket = 2 [(.validate.rules) = { ... }

mergeTokenBucket

public LocalRateLimit.Builder mergeTokenBucket(TokenBucket value)

 The token bucket configuration to use for rate limiting connections that are processed by the
 filter's filter chain. Each incoming connection processed by the filter consumes a single
 token. If the token is available, the connection will be allowed. If no tokens are available,
 the connection will be immediately closed.
 .. note::
   In the current implementation each filter and filter chain has an independent rate limit.
 .. note::
   In the current implementation the token bucket's :ref:`fill_interval
   <envoy_api_field_type.v3.TokenBucket.fill_interval>` must be >= 50ms to avoid too aggressive
   refills.
 

.envoy.type.v3.TokenBucket token_bucket = 2 [(.validate.rules) = { ... }

clearTokenBucket

public LocalRateLimit.Builder clearTokenBucket()

 The token bucket configuration to use for rate limiting connections that are processed by the
 filter's filter chain. Each incoming connection processed by the filter consumes a single
 token. If the token is available, the connection will be allowed. If no tokens are available,
 the connection will be immediately closed.
 .. note::
   In the current implementation each filter and filter chain has an independent rate limit.
 .. note::
   In the current implementation the token bucket's :ref:`fill_interval
   <envoy_api_field_type.v3.TokenBucket.fill_interval>` must be >= 50ms to avoid too aggressive
   refills.
 

.envoy.type.v3.TokenBucket token_bucket = 2 [(.validate.rules) = { ... }

getTokenBucketBuilder

public TokenBucket.Builder getTokenBucketBuilder()

 The token bucket configuration to use for rate limiting connections that are processed by the
 filter's filter chain. Each incoming connection processed by the filter consumes a single
 token. If the token is available, the connection will be allowed. If no tokens are available,
 the connection will be immediately closed.
 .. note::
   In the current implementation each filter and filter chain has an independent rate limit.
 .. note::
   In the current implementation the token bucket's :ref:`fill_interval
   <envoy_api_field_type.v3.TokenBucket.fill_interval>` must be >= 50ms to avoid too aggressive
   refills.
 

.envoy.type.v3.TokenBucket token_bucket = 2 [(.validate.rules) = { ... }

getTokenBucketOrBuilder

public TokenBucketOrBuilder getTokenBucketOrBuilder()

 The token bucket configuration to use for rate limiting connections that are processed by the
 filter's filter chain. Each incoming connection processed by the filter consumes a single
 token. If the token is available, the connection will be allowed. If no tokens are available,
 the connection will be immediately closed.
 .. note::
   In the current implementation each filter and filter chain has an independent rate limit.
 .. note::
   In the current implementation the token bucket's :ref:`fill_interval
   <envoy_api_field_type.v3.TokenBucket.fill_interval>` must be >= 50ms to avoid too aggressive
   refills.
 

.envoy.type.v3.TokenBucket token_bucket = 2 [(.validate.rules) = { ... }

Specified by:

getTokenBucketOrBuilder in interface LocalRateLimitOrBuilder

hasRuntimeEnabled

public boolean hasRuntimeEnabled()

 Runtime flag that controls whether the filter is enabled or not. If not specified, defaults
 to enabled.
 

.envoy.config.core.v3.RuntimeFeatureFlag runtime_enabled = 3;

Specified by:

hasRuntimeEnabled in interface LocalRateLimitOrBuilder

getRuntimeEnabled

public RuntimeFeatureFlag getRuntimeEnabled()

 Runtime flag that controls whether the filter is enabled or not. If not specified, defaults
 to enabled.
 

.envoy.config.core.v3.RuntimeFeatureFlag runtime_enabled = 3;

Specified by:

getRuntimeEnabled in interface LocalRateLimitOrBuilder

setRuntimeEnabled

public LocalRateLimit.Builder setRuntimeEnabled(RuntimeFeatureFlag value)

 Runtime flag that controls whether the filter is enabled or not. If not specified, defaults
 to enabled.
 

.envoy.config.core.v3.RuntimeFeatureFlag runtime_enabled = 3;

setRuntimeEnabled

public LocalRateLimit.Builder setRuntimeEnabled(RuntimeFeatureFlag.Builder builderForValue)

 Runtime flag that controls whether the filter is enabled or not. If not specified, defaults
 to enabled.
 

.envoy.config.core.v3.RuntimeFeatureFlag runtime_enabled = 3;

mergeRuntimeEnabled

public LocalRateLimit.Builder mergeRuntimeEnabled(RuntimeFeatureFlag value)

 Runtime flag that controls whether the filter is enabled or not. If not specified, defaults
 to enabled.
 

.envoy.config.core.v3.RuntimeFeatureFlag runtime_enabled = 3;

clearRuntimeEnabled

public LocalRateLimit.Builder clearRuntimeEnabled()

 Runtime flag that controls whether the filter is enabled or not. If not specified, defaults
 to enabled.
 

.envoy.config.core.v3.RuntimeFeatureFlag runtime_enabled = 3;

getRuntimeEnabledBuilder

public RuntimeFeatureFlag.Builder getRuntimeEnabledBuilder()

 Runtime flag that controls whether the filter is enabled or not. If not specified, defaults
 to enabled.
 

.envoy.config.core.v3.RuntimeFeatureFlag runtime_enabled = 3;

getRuntimeEnabledOrBuilder

public RuntimeFeatureFlagOrBuilder getRuntimeEnabledOrBuilder()

 Runtime flag that controls whether the filter is enabled or not. If not specified, defaults
 to enabled.
 

.envoy.config.core.v3.RuntimeFeatureFlag runtime_enabled = 3;

Specified by:

getRuntimeEnabledOrBuilder in interface LocalRateLimitOrBuilder

setUnknownFields

public final LocalRateLimit.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>

mergeUnknownFields

public final LocalRateLimit.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<LocalRateLimit.Builder>