ratelimitv3

Documentation

Index

• Variables
• type RateLimit
  • func (*RateLimit) Descriptor() ([]byte, []int)
  • func (x *RateLimit) GetDescriptors() []*v3.RateLimitDescriptor
  • func (x *RateLimit) GetDomain() string
  • func (x *RateLimit) GetFailureModeDeny() bool
  • func (x *RateLimit) GetRateLimitService() *v31.RateLimitServiceConfig
  • func (x *RateLimit) GetStatPrefix() string
  • func (x *RateLimit) GetTimeout() *duration.Duration
  • func (*RateLimit) ProtoMessage()
  • func (x *RateLimit) ProtoReflect() protoreflect.Message
  • func (x *RateLimit) Reset()
  • func (x *RateLimit) String() string
  • func (m *RateLimit) Validate() error
  • func (m *RateLimit) ValidateAll() error
• type RateLimitMultiError
  • func (m RateLimitMultiError) AllErrors() []error
  • func (m RateLimitMultiError) Error() string
• type RateLimitValidationError
  • func (e RateLimitValidationError) Cause() error
  • func (e RateLimitValidationError) Error() string
  • func (e RateLimitValidationError) ErrorName() string
  • func (e RateLimitValidationError) Field() string
  • func (e RateLimitValidationError) Key() bool
  • func (e RateLimitValidationError) Reason() string

Variables

var File_envoy_extensions_filters_network_ratelimit_v3_rate_limit_proto protoreflect.FileDescriptor

Types

type RateLimit

type RateLimit struct {

	// The prefix to use when emitting :ref:`statistics <config_network_filters_rate_limit_stats>`.
	StatPrefix string `protobuf:"bytes,1,opt,name=stat_prefix,json=statPrefix,proto3" json:"stat_prefix,omitempty"`
	// The rate limit domain to use in the rate limit service request.
	Domain string `protobuf:"bytes,2,opt,name=domain,proto3" json:"domain,omitempty"`
	// The rate limit descriptor list to use in the rate limit service request.
	Descriptors []*v3.RateLimitDescriptor `protobuf:"bytes,3,rep,name=descriptors,proto3" json:"descriptors,omitempty"`
	// The timeout in milliseconds for the rate limit service RPC. If not
	// set, this defaults to 20ms.
	Timeout *duration.Duration `protobuf:"bytes,4,opt,name=timeout,proto3" json:"timeout,omitempty"`
	// The filter's behaviour in case the rate limiting service does
	// not respond back. When it is set to true, Envoy will not allow traffic in case of
	// communication failure between rate limiting service and the proxy.
	// Defaults to false.
	FailureModeDeny bool `protobuf:"varint,5,opt,name=failure_mode_deny,json=failureModeDeny,proto3" json:"failure_mode_deny,omitempty"`
	// Configuration for an external rate limit service provider. If not
	// specified, any calls to the rate limit service will immediately return
	// success.
	RateLimitService *v31.RateLimitServiceConfig `protobuf:"bytes,6,opt,name=rate_limit_service,json=rateLimitService,proto3" json:"rate_limit_service,omitempty"`
	// contains filtered or unexported fields
}

[#next-free-field: 7]

func (*RateLimit) Descriptor

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

Deprecated: Use RateLimit.ProtoReflect.Descriptor instead.

func (*RateLimit) GetDescriptors

func (x *RateLimit) GetDescriptors() []*v3.RateLimitDescriptor

func (*RateLimit) GetDomain

func (x *RateLimit) GetDomain() string

func (*RateLimit) GetFailureModeDeny

func (x *RateLimit) GetFailureModeDeny() bool

func (*RateLimit) GetRateLimitService

func (x *RateLimit) GetRateLimitService() *v31.RateLimitServiceConfig

func (*RateLimit) GetStatPrefix

func (x *RateLimit) GetStatPrefix() string

func (*RateLimit) GetTimeout

func (x *RateLimit) GetTimeout() *duration.Duration

func (*RateLimit) ProtoMessage

func (*RateLimit) ProtoMessage()

func (*RateLimit) ProtoReflect

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

func (*RateLimit) Reset

func (x *RateLimit) Reset()

func (*RateLimit) String

func (x *RateLimit) String() string

func (*RateLimit) Validate

func (m *RateLimit) Validate() error

Validate checks the field values on RateLimit with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*RateLimit) ValidateAll

func (m *RateLimit) ValidateAll() error

ValidateAll checks the field values on RateLimit with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in RateLimitMultiError, or nil if none found.

type RateLimitMultiError

type RateLimitMultiError []error

RateLimitMultiError is an error wrapping multiple validation errors returned by RateLimit.ValidateAll() if the designated constraints aren't met.

func (RateLimitMultiError) AllErrors

func (m RateLimitMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (RateLimitMultiError) Error

func (m RateLimitMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type RateLimitValidationError

type RateLimitValidationError struct {
	// contains filtered or unexported fields
}

RateLimitValidationError is the validation error returned by RateLimit.Validate if the designated constraints aren't met.

func (RateLimitValidationError) Cause

func (e RateLimitValidationError) Cause() error

Cause function returns cause value.

func (RateLimitValidationError) Error

func (e RateLimitValidationError) Error() string

Error satisfies the builtin error interface

func (RateLimitValidationError) ErrorName

func (e RateLimitValidationError) ErrorName() string

ErrorName returns error name.

func (RateLimitValidationError) Field

func (e RateLimitValidationError) Field() string

Field function returns field value.

func (RateLimitValidationError) Key

func (e RateLimitValidationError) Key() bool

Key function returns key value.

func (RateLimitValidationError) Reason

func (e RateLimitValidationError) Reason() string

Reason function returns reason value.