Documentation
¶
Index ¶
- Variables
- type LocalRateLimitDescriptor
- func (*LocalRateLimitDescriptor) Descriptor() ([]byte, []int)deprecated
- func (x *LocalRateLimitDescriptor) GetEntries() []*RateLimitDescriptor_Entry
- func (x *LocalRateLimitDescriptor) GetTokenBucket() *v3.TokenBucket
- func (*LocalRateLimitDescriptor) ProtoMessage()
- func (x *LocalRateLimitDescriptor) ProtoReflect() protoreflect.Message
- func (x *LocalRateLimitDescriptor) Reset()
- func (x *LocalRateLimitDescriptor) String() string
- func (m *LocalRateLimitDescriptor) Validate() error
- func (m *LocalRateLimitDescriptor) ValidateAll() error
- type LocalRateLimitDescriptorMultiError
- type LocalRateLimitDescriptorValidationError
- func (e LocalRateLimitDescriptorValidationError) Cause() error
- func (e LocalRateLimitDescriptorValidationError) Error() string
- func (e LocalRateLimitDescriptorValidationError) ErrorName() string
- func (e LocalRateLimitDescriptorValidationError) Field() string
- func (e LocalRateLimitDescriptorValidationError) Key() bool
- func (e LocalRateLimitDescriptorValidationError) Reason() string
- type RateLimitDescriptor
- func (*RateLimitDescriptor) Descriptor() ([]byte, []int)deprecated
- func (x *RateLimitDescriptor) GetEntries() []*RateLimitDescriptor_Entry
- func (x *RateLimitDescriptor) GetLimit() *RateLimitDescriptor_RateLimitOverride
- func (*RateLimitDescriptor) ProtoMessage()
- func (x *RateLimitDescriptor) ProtoReflect() protoreflect.Message
- func (x *RateLimitDescriptor) Reset()
- func (x *RateLimitDescriptor) String() string
- func (m *RateLimitDescriptor) Validate() error
- func (m *RateLimitDescriptor) ValidateAll() error
- type RateLimitDescriptorMultiError
- type RateLimitDescriptorValidationError
- func (e RateLimitDescriptorValidationError) Cause() error
- func (e RateLimitDescriptorValidationError) Error() string
- func (e RateLimitDescriptorValidationError) ErrorName() string
- func (e RateLimitDescriptorValidationError) Field() string
- func (e RateLimitDescriptorValidationError) Key() bool
- func (e RateLimitDescriptorValidationError) Reason() string
- type RateLimitDescriptor_Entry
- func (*RateLimitDescriptor_Entry) Descriptor() ([]byte, []int)deprecated
- func (x *RateLimitDescriptor_Entry) GetKey() string
- func (x *RateLimitDescriptor_Entry) GetValue() string
- func (*RateLimitDescriptor_Entry) ProtoMessage()
- func (x *RateLimitDescriptor_Entry) ProtoReflect() protoreflect.Message
- func (x *RateLimitDescriptor_Entry) Reset()
- func (x *RateLimitDescriptor_Entry) String() string
- func (m *RateLimitDescriptor_Entry) Validate() error
- func (m *RateLimitDescriptor_Entry) ValidateAll() error
- type RateLimitDescriptor_EntryMultiError
- type RateLimitDescriptor_EntryValidationError
- func (e RateLimitDescriptor_EntryValidationError) Cause() error
- func (e RateLimitDescriptor_EntryValidationError) Error() string
- func (e RateLimitDescriptor_EntryValidationError) ErrorName() string
- func (e RateLimitDescriptor_EntryValidationError) Field() string
- func (e RateLimitDescriptor_EntryValidationError) Key() bool
- func (e RateLimitDescriptor_EntryValidationError) Reason() string
- type RateLimitDescriptor_RateLimitOverride
- func (*RateLimitDescriptor_RateLimitOverride) Descriptor() ([]byte, []int)deprecated
- func (x *RateLimitDescriptor_RateLimitOverride) GetRequestsPerUnit() uint32
- func (x *RateLimitDescriptor_RateLimitOverride) GetUnit() v3.RateLimitUnit
- func (*RateLimitDescriptor_RateLimitOverride) ProtoMessage()
- func (x *RateLimitDescriptor_RateLimitOverride) ProtoReflect() protoreflect.Message
- func (x *RateLimitDescriptor_RateLimitOverride) Reset()
- func (x *RateLimitDescriptor_RateLimitOverride) String() string
- func (m *RateLimitDescriptor_RateLimitOverride) Validate() error
- func (m *RateLimitDescriptor_RateLimitOverride) ValidateAll() error
- type RateLimitDescriptor_RateLimitOverrideMultiError
- type RateLimitDescriptor_RateLimitOverrideValidationError
- func (e RateLimitDescriptor_RateLimitOverrideValidationError) Cause() error
- func (e RateLimitDescriptor_RateLimitOverrideValidationError) Error() string
- func (e RateLimitDescriptor_RateLimitOverrideValidationError) ErrorName() string
- func (e RateLimitDescriptor_RateLimitOverrideValidationError) Field() string
- func (e RateLimitDescriptor_RateLimitOverrideValidationError) Key() bool
- func (e RateLimitDescriptor_RateLimitOverrideValidationError) Reason() string
- type XRateLimitHeadersRFCVersion
- func (XRateLimitHeadersRFCVersion) Descriptor() protoreflect.EnumDescriptor
- func (x XRateLimitHeadersRFCVersion) Enum() *XRateLimitHeadersRFCVersion
- func (XRateLimitHeadersRFCVersion) EnumDescriptor() ([]byte, []int)deprecated
- func (x XRateLimitHeadersRFCVersion) Number() protoreflect.EnumNumber
- func (x XRateLimitHeadersRFCVersion) String() string
- func (XRateLimitHeadersRFCVersion) Type() protoreflect.EnumType
Constants ¶
This section is empty.
Variables ¶
var ( XRateLimitHeadersRFCVersion_name = map[int32]string{ 0: "OFF", 1: "DRAFT_VERSION_03", } XRateLimitHeadersRFCVersion_value = map[string]int32{ "OFF": 0, "DRAFT_VERSION_03": 1, } )
Enum value maps for XRateLimitHeadersRFCVersion.
var File_envoy_extensions_common_ratelimit_v3_ratelimit_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type LocalRateLimitDescriptor ¶ added in v0.9.9
type LocalRateLimitDescriptor struct { // Descriptor entries. Entries []*RateLimitDescriptor_Entry `protobuf:"bytes,1,rep,name=entries,proto3" json:"entries,omitempty"` // Token Bucket algorithm for local ratelimiting. TokenBucket *v3.TokenBucket `protobuf:"bytes,2,opt,name=token_bucket,json=tokenBucket,proto3" json:"token_bucket,omitempty"` // contains filtered or unexported fields }
func (*LocalRateLimitDescriptor) Descriptor
deprecated
added in
v0.9.9
func (*LocalRateLimitDescriptor) Descriptor() ([]byte, []int)
Deprecated: Use LocalRateLimitDescriptor.ProtoReflect.Descriptor instead.
func (*LocalRateLimitDescriptor) GetEntries ¶ added in v0.9.9
func (x *LocalRateLimitDescriptor) GetEntries() []*RateLimitDescriptor_Entry
func (*LocalRateLimitDescriptor) GetTokenBucket ¶ added in v0.9.9
func (x *LocalRateLimitDescriptor) GetTokenBucket() *v3.TokenBucket
func (*LocalRateLimitDescriptor) ProtoMessage ¶ added in v0.9.9
func (*LocalRateLimitDescriptor) ProtoMessage()
func (*LocalRateLimitDescriptor) ProtoReflect ¶ added in v0.9.9
func (x *LocalRateLimitDescriptor) ProtoReflect() protoreflect.Message
func (*LocalRateLimitDescriptor) Reset ¶ added in v0.9.9
func (x *LocalRateLimitDescriptor) Reset()
func (*LocalRateLimitDescriptor) String ¶ added in v0.9.9
func (x *LocalRateLimitDescriptor) String() string
func (*LocalRateLimitDescriptor) Validate ¶ added in v0.9.9
func (m *LocalRateLimitDescriptor) Validate() error
Validate checks the field values on LocalRateLimitDescriptor 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 (*LocalRateLimitDescriptor) ValidateAll ¶ added in v0.10.0
func (m *LocalRateLimitDescriptor) ValidateAll() error
ValidateAll checks the field values on LocalRateLimitDescriptor 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 LocalRateLimitDescriptorMultiError, or nil if none found.
type LocalRateLimitDescriptorMultiError ¶ added in v0.10.0
type LocalRateLimitDescriptorMultiError []error
LocalRateLimitDescriptorMultiError is an error wrapping multiple validation errors returned by LocalRateLimitDescriptor.ValidateAll() if the designated constraints aren't met.
func (LocalRateLimitDescriptorMultiError) AllErrors ¶ added in v0.10.0
func (m LocalRateLimitDescriptorMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (LocalRateLimitDescriptorMultiError) Error ¶ added in v0.10.0
func (m LocalRateLimitDescriptorMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type LocalRateLimitDescriptorValidationError ¶ added in v0.9.9
type LocalRateLimitDescriptorValidationError struct {
// contains filtered or unexported fields
}
LocalRateLimitDescriptorValidationError is the validation error returned by LocalRateLimitDescriptor.Validate if the designated constraints aren't met.
func (LocalRateLimitDescriptorValidationError) Cause ¶ added in v0.9.9
func (e LocalRateLimitDescriptorValidationError) Cause() error
Cause function returns cause value.
func (LocalRateLimitDescriptorValidationError) Error ¶ added in v0.9.9
func (e LocalRateLimitDescriptorValidationError) Error() string
Error satisfies the builtin error interface
func (LocalRateLimitDescriptorValidationError) ErrorName ¶ added in v0.9.9
func (e LocalRateLimitDescriptorValidationError) ErrorName() string
ErrorName returns error name.
func (LocalRateLimitDescriptorValidationError) Field ¶ added in v0.9.9
func (e LocalRateLimitDescriptorValidationError) Field() string
Field function returns field value.
func (LocalRateLimitDescriptorValidationError) Key ¶ added in v0.9.9
func (e LocalRateLimitDescriptorValidationError) Key() bool
Key function returns key value.
func (LocalRateLimitDescriptorValidationError) Reason ¶ added in v0.9.9
func (e LocalRateLimitDescriptorValidationError) Reason() string
Reason function returns reason value.
type RateLimitDescriptor ¶
type RateLimitDescriptor struct { // Descriptor entries. Entries []*RateLimitDescriptor_Entry `protobuf:"bytes,1,rep,name=entries,proto3" json:"entries,omitempty"` // Optional rate limit override to supply to the ratelimit service. Limit *RateLimitDescriptor_RateLimitOverride `protobuf:"bytes,2,opt,name=limit,proto3" json:"limit,omitempty"` // contains filtered or unexported fields }
A RateLimitDescriptor is a list of hierarchical entries that are used by the service to determine the final rate limit key and overall allowed limit. Here are some examples of how they might be used for the domain "envoy".
.. code-block:: cpp
["authenticated": "false"], ["remote_address": "10.0.0.1"]
What it does: Limits all unauthenticated traffic for the IP address 10.0.0.1. The configuration supplies a default limit for the *remote_address* key. If there is a desire to raise the limit for 10.0.0.1 or block it entirely it can be specified directly in the configuration.
.. code-block:: cpp
["authenticated": "false"], ["path": "/foo/bar"]
What it does: Limits all unauthenticated traffic globally for a specific path (or prefix if configured that way in the service).
.. code-block:: cpp
["authenticated": "false"], ["path": "/foo/bar"], ["remote_address": "10.0.0.1"]
What it does: Limits unauthenticated traffic to a specific path for a specific IP address. Like (1) we can raise/block specific IP addresses if we want with an override configuration.
.. code-block:: cpp
["authenticated": "true"], ["client_id": "foo"]
What it does: Limits all traffic for an authenticated client "foo"
.. code-block:: cpp
["authenticated": "true"], ["client_id": "foo"], ["path": "/foo/bar"]
What it does: Limits traffic to a specific path for an authenticated client "foo"
The idea behind the API is that (1)/(2)/(3) and (4)/(5) can be sent in 1 request if desired. This enables building complex application scenarios with a generic backend.
Optionally the descriptor can contain a limit override under a "limit" key, that specifies the number of requests per unit to use instead of the number configured in the rate limiting service.
func (*RateLimitDescriptor) Descriptor
deprecated
func (*RateLimitDescriptor) Descriptor() ([]byte, []int)
Deprecated: Use RateLimitDescriptor.ProtoReflect.Descriptor instead.
func (*RateLimitDescriptor) GetEntries ¶
func (x *RateLimitDescriptor) GetEntries() []*RateLimitDescriptor_Entry
func (*RateLimitDescriptor) GetLimit ¶ added in v0.9.6
func (x *RateLimitDescriptor) GetLimit() *RateLimitDescriptor_RateLimitOverride
func (*RateLimitDescriptor) ProtoMessage ¶
func (*RateLimitDescriptor) ProtoMessage()
func (*RateLimitDescriptor) ProtoReflect ¶ added in v0.9.6
func (x *RateLimitDescriptor) ProtoReflect() protoreflect.Message
func (*RateLimitDescriptor) Reset ¶
func (x *RateLimitDescriptor) Reset()
func (*RateLimitDescriptor) String ¶
func (x *RateLimitDescriptor) String() string
func (*RateLimitDescriptor) Validate ¶
func (m *RateLimitDescriptor) Validate() error
Validate checks the field values on RateLimitDescriptor 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 (*RateLimitDescriptor) ValidateAll ¶ added in v0.10.0
func (m *RateLimitDescriptor) ValidateAll() error
ValidateAll checks the field values on RateLimitDescriptor 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 RateLimitDescriptorMultiError, or nil if none found.
type RateLimitDescriptorMultiError ¶ added in v0.10.0
type RateLimitDescriptorMultiError []error
RateLimitDescriptorMultiError is an error wrapping multiple validation errors returned by RateLimitDescriptor.ValidateAll() if the designated constraints aren't met.
func (RateLimitDescriptorMultiError) AllErrors ¶ added in v0.10.0
func (m RateLimitDescriptorMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (RateLimitDescriptorMultiError) Error ¶ added in v0.10.0
func (m RateLimitDescriptorMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type RateLimitDescriptorValidationError ¶
type RateLimitDescriptorValidationError struct {
// contains filtered or unexported fields
}
RateLimitDescriptorValidationError is the validation error returned by RateLimitDescriptor.Validate if the designated constraints aren't met.
func (RateLimitDescriptorValidationError) Cause ¶
func (e RateLimitDescriptorValidationError) Cause() error
Cause function returns cause value.
func (RateLimitDescriptorValidationError) Error ¶
func (e RateLimitDescriptorValidationError) Error() string
Error satisfies the builtin error interface
func (RateLimitDescriptorValidationError) ErrorName ¶
func (e RateLimitDescriptorValidationError) ErrorName() string
ErrorName returns error name.
func (RateLimitDescriptorValidationError) Field ¶
func (e RateLimitDescriptorValidationError) Field() string
Field function returns field value.
func (RateLimitDescriptorValidationError) Key ¶
func (e RateLimitDescriptorValidationError) Key() bool
Key function returns key value.
func (RateLimitDescriptorValidationError) Reason ¶
func (e RateLimitDescriptorValidationError) Reason() string
Reason function returns reason value.
type RateLimitDescriptor_Entry ¶
type RateLimitDescriptor_Entry struct { // Descriptor key. Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"` // Descriptor value. Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` // contains filtered or unexported fields }
func (*RateLimitDescriptor_Entry) Descriptor
deprecated
func (*RateLimitDescriptor_Entry) Descriptor() ([]byte, []int)
Deprecated: Use RateLimitDescriptor_Entry.ProtoReflect.Descriptor instead.
func (*RateLimitDescriptor_Entry) GetKey ¶
func (x *RateLimitDescriptor_Entry) GetKey() string
func (*RateLimitDescriptor_Entry) GetValue ¶
func (x *RateLimitDescriptor_Entry) GetValue() string
func (*RateLimitDescriptor_Entry) ProtoMessage ¶
func (*RateLimitDescriptor_Entry) ProtoMessage()
func (*RateLimitDescriptor_Entry) ProtoReflect ¶ added in v0.9.6
func (x *RateLimitDescriptor_Entry) ProtoReflect() protoreflect.Message
func (*RateLimitDescriptor_Entry) Reset ¶
func (x *RateLimitDescriptor_Entry) Reset()
func (*RateLimitDescriptor_Entry) String ¶
func (x *RateLimitDescriptor_Entry) String() string
func (*RateLimitDescriptor_Entry) Validate ¶
func (m *RateLimitDescriptor_Entry) Validate() error
Validate checks the field values on RateLimitDescriptor_Entry 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 (*RateLimitDescriptor_Entry) ValidateAll ¶ added in v0.10.0
func (m *RateLimitDescriptor_Entry) ValidateAll() error
ValidateAll checks the field values on RateLimitDescriptor_Entry 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 RateLimitDescriptor_EntryMultiError, or nil if none found.
type RateLimitDescriptor_EntryMultiError ¶ added in v0.10.0
type RateLimitDescriptor_EntryMultiError []error
RateLimitDescriptor_EntryMultiError is an error wrapping multiple validation errors returned by RateLimitDescriptor_Entry.ValidateAll() if the designated constraints aren't met.
func (RateLimitDescriptor_EntryMultiError) AllErrors ¶ added in v0.10.0
func (m RateLimitDescriptor_EntryMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (RateLimitDescriptor_EntryMultiError) Error ¶ added in v0.10.0
func (m RateLimitDescriptor_EntryMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type RateLimitDescriptor_EntryValidationError ¶
type RateLimitDescriptor_EntryValidationError struct {
// contains filtered or unexported fields
}
RateLimitDescriptor_EntryValidationError is the validation error returned by RateLimitDescriptor_Entry.Validate if the designated constraints aren't met.
func (RateLimitDescriptor_EntryValidationError) Cause ¶
func (e RateLimitDescriptor_EntryValidationError) Cause() error
Cause function returns cause value.
func (RateLimitDescriptor_EntryValidationError) Error ¶
func (e RateLimitDescriptor_EntryValidationError) Error() string
Error satisfies the builtin error interface
func (RateLimitDescriptor_EntryValidationError) ErrorName ¶
func (e RateLimitDescriptor_EntryValidationError) ErrorName() string
ErrorName returns error name.
func (RateLimitDescriptor_EntryValidationError) Field ¶
func (e RateLimitDescriptor_EntryValidationError) Field() string
Field function returns field value.
func (RateLimitDescriptor_EntryValidationError) Key ¶
func (e RateLimitDescriptor_EntryValidationError) Key() bool
Key function returns key value.
func (RateLimitDescriptor_EntryValidationError) Reason ¶
func (e RateLimitDescriptor_EntryValidationError) Reason() string
Reason function returns reason value.
type RateLimitDescriptor_RateLimitOverride ¶ added in v0.9.6
type RateLimitDescriptor_RateLimitOverride struct { // The number of requests per unit of time. RequestsPerUnit uint32 `protobuf:"varint,1,opt,name=requests_per_unit,json=requestsPerUnit,proto3" json:"requests_per_unit,omitempty"` // The unit of time. Unit v3.RateLimitUnit `protobuf:"varint,2,opt,name=unit,proto3,enum=envoy.type.v3.RateLimitUnit" json:"unit,omitempty"` // contains filtered or unexported fields }
Override rate limit to apply to this descriptor instead of the limit configured in the rate limit service. See :ref:`rate limit override <config_http_filters_rate_limit_rate_limit_override>` for more information.
func (*RateLimitDescriptor_RateLimitOverride) Descriptor
deprecated
added in
v0.9.6
func (*RateLimitDescriptor_RateLimitOverride) Descriptor() ([]byte, []int)
Deprecated: Use RateLimitDescriptor_RateLimitOverride.ProtoReflect.Descriptor instead.
func (*RateLimitDescriptor_RateLimitOverride) GetRequestsPerUnit ¶ added in v0.9.6
func (x *RateLimitDescriptor_RateLimitOverride) GetRequestsPerUnit() uint32
func (*RateLimitDescriptor_RateLimitOverride) GetUnit ¶ added in v0.9.6
func (x *RateLimitDescriptor_RateLimitOverride) GetUnit() v3.RateLimitUnit
func (*RateLimitDescriptor_RateLimitOverride) ProtoMessage ¶ added in v0.9.6
func (*RateLimitDescriptor_RateLimitOverride) ProtoMessage()
func (*RateLimitDescriptor_RateLimitOverride) ProtoReflect ¶ added in v0.9.6
func (x *RateLimitDescriptor_RateLimitOverride) ProtoReflect() protoreflect.Message
func (*RateLimitDescriptor_RateLimitOverride) Reset ¶ added in v0.9.6
func (x *RateLimitDescriptor_RateLimitOverride) Reset()
func (*RateLimitDescriptor_RateLimitOverride) String ¶ added in v0.9.6
func (x *RateLimitDescriptor_RateLimitOverride) String() string
func (*RateLimitDescriptor_RateLimitOverride) Validate ¶ added in v0.9.6
func (m *RateLimitDescriptor_RateLimitOverride) Validate() error
Validate checks the field values on RateLimitDescriptor_RateLimitOverride 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 (*RateLimitDescriptor_RateLimitOverride) ValidateAll ¶ added in v0.10.0
func (m *RateLimitDescriptor_RateLimitOverride) ValidateAll() error
ValidateAll checks the field values on RateLimitDescriptor_RateLimitOverride 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 RateLimitDescriptor_RateLimitOverrideMultiError, or nil if none found.
type RateLimitDescriptor_RateLimitOverrideMultiError ¶ added in v0.10.0
type RateLimitDescriptor_RateLimitOverrideMultiError []error
RateLimitDescriptor_RateLimitOverrideMultiError is an error wrapping multiple validation errors returned by RateLimitDescriptor_RateLimitOverride.ValidateAll() if the designated constraints aren't met.
func (RateLimitDescriptor_RateLimitOverrideMultiError) AllErrors ¶ added in v0.10.0
func (m RateLimitDescriptor_RateLimitOverrideMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (RateLimitDescriptor_RateLimitOverrideMultiError) Error ¶ added in v0.10.0
func (m RateLimitDescriptor_RateLimitOverrideMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type RateLimitDescriptor_RateLimitOverrideValidationError ¶ added in v0.9.6
type RateLimitDescriptor_RateLimitOverrideValidationError struct {
// contains filtered or unexported fields
}
RateLimitDescriptor_RateLimitOverrideValidationError is the validation error returned by RateLimitDescriptor_RateLimitOverride.Validate if the designated constraints aren't met.
func (RateLimitDescriptor_RateLimitOverrideValidationError) Cause ¶ added in v0.9.6
func (e RateLimitDescriptor_RateLimitOverrideValidationError) Cause() error
Cause function returns cause value.
func (RateLimitDescriptor_RateLimitOverrideValidationError) Error ¶ added in v0.9.6
func (e RateLimitDescriptor_RateLimitOverrideValidationError) Error() string
Error satisfies the builtin error interface
func (RateLimitDescriptor_RateLimitOverrideValidationError) ErrorName ¶ added in v0.9.6
func (e RateLimitDescriptor_RateLimitOverrideValidationError) ErrorName() string
ErrorName returns error name.
func (RateLimitDescriptor_RateLimitOverrideValidationError) Field ¶ added in v0.9.6
func (e RateLimitDescriptor_RateLimitOverrideValidationError) Field() string
Field function returns field value.
func (RateLimitDescriptor_RateLimitOverrideValidationError) Key ¶ added in v0.9.6
func (e RateLimitDescriptor_RateLimitOverrideValidationError) Key() bool
Key function returns key value.
func (RateLimitDescriptor_RateLimitOverrideValidationError) Reason ¶ added in v0.9.6
func (e RateLimitDescriptor_RateLimitOverrideValidationError) Reason() string
Reason function returns reason value.
type XRateLimitHeadersRFCVersion ¶ added in v0.10.2
type XRateLimitHeadersRFCVersion int32
Defines the version of the standard to use for X-RateLimit headers.
const ( // X-RateLimit headers disabled. XRateLimitHeadersRFCVersion_OFF XRateLimitHeadersRFCVersion = 0 // Use `draft RFC Version 03 <https://tools.ietf.org/id/draft-polli-ratelimit-headers-03.html>`_ where 3 headers will be added: // // * “X-RateLimit-Limit“ - indicates the request-quota associated to the // client in the current time-window followed by the description of the // quota policy. The value is returned by the maximum tokens of the token bucket. // * “X-RateLimit-Remaining“ - indicates the remaining requests in the // current time-window. The value is returned by the remaining tokens in the token bucket. // * “X-RateLimit-Reset“ - indicates the number of seconds until reset of // the current time-window. The value is returned by the remaining fill interval of the token bucket. XRateLimitHeadersRFCVersion_DRAFT_VERSION_03 XRateLimitHeadersRFCVersion = 1 )
func (XRateLimitHeadersRFCVersion) Descriptor ¶ added in v0.10.2
func (XRateLimitHeadersRFCVersion) Descriptor() protoreflect.EnumDescriptor
func (XRateLimitHeadersRFCVersion) Enum ¶ added in v0.10.2
func (x XRateLimitHeadersRFCVersion) Enum() *XRateLimitHeadersRFCVersion
func (XRateLimitHeadersRFCVersion) EnumDescriptor
deprecated
added in
v0.10.2
func (XRateLimitHeadersRFCVersion) EnumDescriptor() ([]byte, []int)
Deprecated: Use XRateLimitHeadersRFCVersion.Descriptor instead.
func (XRateLimitHeadersRFCVersion) Number ¶ added in v0.10.2
func (x XRateLimitHeadersRFCVersion) Number() protoreflect.EnumNumber
func (XRateLimitHeadersRFCVersion) String ¶ added in v0.10.2
func (x XRateLimitHeadersRFCVersion) String() string
func (XRateLimitHeadersRFCVersion) Type ¶ added in v0.10.2
func (XRateLimitHeadersRFCVersion) Type() protoreflect.EnumType