Documentation
¶
Index ¶
- Variables
- type RateLimit
- func (x *RateLimit) ClearRateLimitService()
- func (x *RateLimit) ClearTimeout()
- 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() *durationpb.Duration
- func (x *RateLimit) HasRateLimitService() bool
- func (x *RateLimit) HasTimeout() bool
- func (*RateLimit) ProtoMessage()
- func (x *RateLimit) ProtoReflect() protoreflect.Message
- func (x *RateLimit) Reset()
- func (x *RateLimit) SetDescriptors(v []*v3.RateLimitDescriptor)
- func (x *RateLimit) SetDomain(v string)
- func (x *RateLimit) SetFailureModeDeny(v bool)
- func (x *RateLimit) SetRateLimitService(v *v31.RateLimitServiceConfig)
- func (x *RateLimit) SetStatPrefix(v string)
- func (x *RateLimit) SetTimeout(v *durationpb.Duration)
- func (x *RateLimit) String() string
- type RateLimit_builder
Constants ¶
This section is empty.
Variables ¶
View Source
var File_envoy_extensions_filters_network_ratelimit_v3_rate_limit_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
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 *durationpb.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) GetDescriptors ¶
func (x *RateLimit) GetDescriptors() []*v3.RateLimitDescriptor
func (*RateLimit) GetRateLimitService ¶
func (x *RateLimit) GetRateLimitService() *v31.RateLimitServiceConfig
func (*RateLimit) GetTimeout ¶
func (x *RateLimit) GetTimeout() *durationpb.Duration
func (*RateLimit) ProtoReflect ¶
func (x *RateLimit) ProtoReflect() protoreflect.Message
func (*RateLimit) SetDescriptors ¶
func (x *RateLimit) SetDescriptors(v []*v3.RateLimitDescriptor)
func (*RateLimit) SetRateLimitService ¶
func (x *RateLimit) SetRateLimitService(v *v31.RateLimitServiceConfig)
func (*RateLimit) SetTimeout ¶
func (x *RateLimit) SetTimeout(v *durationpb.Duration)
type RateLimit_builder ¶
type RateLimit_builder struct {
// The prefix to use when emitting :ref:`statistics <config_network_filters_rate_limit_stats>`.
StatPrefix string
// The rate limit domain to use in the rate limit service request.
Domain string
// The rate limit descriptor list to use in the rate limit service request.
Descriptors []*v3.RateLimitDescriptor
// The timeout in milliseconds for the rate limit service RPC. If not
// set, this defaults to 20ms.
Timeout *durationpb.Duration
// 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
// 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
// contains filtered or unexported fields
}
func (RateLimit_builder) Build ¶
func (b0 RateLimit_builder) Build() *RateLimit
Source Files
¶
- rate_limit.pb.go
Click to show internal directories.
Click to hide internal directories.