go-control-plane: github.com/envoyproxy/go-control-plane/envoy/extensions/filters/network/local_ratelimit/v3 Index | Files

package envoy_extensions_filters_network_local_ratelimit_v3

import "github.com/envoyproxy/go-control-plane/envoy/extensions/filters/network/local_ratelimit/v3"


Package Files

local_rate_limit.pb.go local_rate_limit.pb.validate.go


var File_envoy_extensions_filters_network_local_ratelimit_v3_local_rate_limit_proto protoreflect.FileDescriptor

type LocalRateLimit Uses

type LocalRateLimit struct {

    // The prefix to use when emitting :ref:`statistics
    // <config_network_filters_local_rate_limit_stats>`.
    StatPrefix string `protobuf:"bytes,1,opt,name=stat_prefix,json=statPrefix,proto3" json:"stat_prefix,omitempty"`
    // 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.
    TokenBucket *v3.TokenBucket `protobuf:"bytes,2,opt,name=token_bucket,json=tokenBucket,proto3" json:"token_bucket,omitempty"`
    // Runtime flag that controls whether the filter is enabled or not. If not specified, defaults
    // to enabled.
    RuntimeEnabled *v31.RuntimeFeatureFlag `protobuf:"bytes,3,opt,name=runtime_enabled,json=runtimeEnabled,proto3" json:"runtime_enabled,omitempty"`
    // contains filtered or unexported fields

func (*LocalRateLimit) Descriptor Uses

func (*LocalRateLimit) Descriptor() ([]byte, []int)

Deprecated: Use LocalRateLimit.ProtoReflect.Descriptor instead.

func (*LocalRateLimit) GetRuntimeEnabled Uses

func (x *LocalRateLimit) GetRuntimeEnabled() *v31.RuntimeFeatureFlag

func (*LocalRateLimit) GetStatPrefix Uses

func (x *LocalRateLimit) GetStatPrefix() string

func (*LocalRateLimit) GetTokenBucket Uses

func (x *LocalRateLimit) GetTokenBucket() *v3.TokenBucket

func (*LocalRateLimit) ProtoMessage Uses

func (*LocalRateLimit) ProtoMessage()

func (*LocalRateLimit) ProtoReflect Uses

func (x *LocalRateLimit) ProtoReflect() protoreflect.Message

func (*LocalRateLimit) Reset Uses

func (x *LocalRateLimit) Reset()

func (*LocalRateLimit) String Uses

func (x *LocalRateLimit) String() string

func (*LocalRateLimit) Validate Uses

func (m *LocalRateLimit) Validate() error

Validate checks the field values on LocalRateLimit with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type LocalRateLimitValidationError Uses

type LocalRateLimitValidationError struct {
    // contains filtered or unexported fields

LocalRateLimitValidationError is the validation error returned by LocalRateLimit.Validate if the designated constraints aren't met.

func (LocalRateLimitValidationError) Cause Uses

func (e LocalRateLimitValidationError) Cause() error

Cause function returns cause value.

func (LocalRateLimitValidationError) Error Uses

func (e LocalRateLimitValidationError) Error() string

Error satisfies the builtin error interface

func (LocalRateLimitValidationError) ErrorName Uses

func (e LocalRateLimitValidationError) ErrorName() string

ErrorName returns error name.

func (LocalRateLimitValidationError) Field Uses

func (e LocalRateLimitValidationError) Field() string

Field function returns field value.

func (LocalRateLimitValidationError) Key Uses

func (e LocalRateLimitValidationError) Key() bool

Key function returns key value.

func (LocalRateLimitValidationError) Reason Uses

func (e LocalRateLimitValidationError) Reason() string

Reason function returns reason value.

Package envoy_extensions_filters_network_local_ratelimit_v3 imports 20 packages (graph) and is imported by 6 packages. Updated 2021-01-15. Refresh now. Tools for package owners.