ratelimit

package
v0.13.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 15, 2024 License: Apache-2.0 Imports: 18 Imported by: 50

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_envoy_api_v2_ratelimit_ratelimit_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type RateLimitDescriptor 

type RateLimitDescriptor struct {

	// Descriptor entries.
	Entries []*RateLimitDescriptor_Entry `protobuf:"bytes,1,rep,name=entries,proto3" json:"entries,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.

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) 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 added in v0.7.0 

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 added in v0.7.0 

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.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.