go-control-plane: github.com/envoyproxy/go-control-plane/envoy/extensions/common/ratelimit/v3 Index | Files

package envoy_extensions_common_ratelimit_v3

import "github.com/envoyproxy/go-control-plane/envoy/extensions/common/ratelimit/v3"

Index

Package Files

ratelimit.pb.go ratelimit.pb.validate.go

Variables

var File_envoy_extensions_common_ratelimit_v3_ratelimit_proto protoreflect.FileDescriptor

type LocalRateLimitDescriptor Uses

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 Uses

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

Deprecated: Use LocalRateLimitDescriptor.ProtoReflect.Descriptor instead.

func (*LocalRateLimitDescriptor) GetEntries Uses

func (x *LocalRateLimitDescriptor) GetEntries() []*RateLimitDescriptor_Entry

func (*LocalRateLimitDescriptor) GetTokenBucket Uses

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

func (*LocalRateLimitDescriptor) ProtoMessage Uses

func (*LocalRateLimitDescriptor) ProtoMessage()

func (*LocalRateLimitDescriptor) ProtoReflect Uses

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

func (*LocalRateLimitDescriptor) Reset Uses

func (x *LocalRateLimitDescriptor) Reset()

func (*LocalRateLimitDescriptor) String Uses

func (x *LocalRateLimitDescriptor) String() string

func (*LocalRateLimitDescriptor) Validate Uses

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, an error is returned.

type LocalRateLimitDescriptorValidationError Uses

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 Uses

func (e LocalRateLimitDescriptorValidationError) Cause() error

Cause function returns cause value.

func (LocalRateLimitDescriptorValidationError) Error Uses

func (e LocalRateLimitDescriptorValidationError) Error() string

Error satisfies the builtin error interface

func (LocalRateLimitDescriptorValidationError) ErrorName Uses

func (e LocalRateLimitDescriptorValidationError) ErrorName() string

ErrorName returns error name.

func (LocalRateLimitDescriptorValidationError) Field Uses

func (e LocalRateLimitDescriptorValidationError) Field() string

Field function returns field value.

func (LocalRateLimitDescriptorValidationError) Key Uses

func (e LocalRateLimitDescriptorValidationError) Key() bool

Key function returns key value.

func (LocalRateLimitDescriptorValidationError) Reason Uses

func (e LocalRateLimitDescriptorValidationError) Reason() string

Reason function returns reason value.

type RateLimitDescriptor Uses

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 Uses

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

Deprecated: Use RateLimitDescriptor.ProtoReflect.Descriptor instead.

func (*RateLimitDescriptor) GetEntries Uses

func (x *RateLimitDescriptor) GetEntries() []*RateLimitDescriptor_Entry

func (*RateLimitDescriptor) GetLimit Uses

func (x *RateLimitDescriptor) GetLimit() *RateLimitDescriptor_RateLimitOverride

func (*RateLimitDescriptor) ProtoMessage Uses

func (*RateLimitDescriptor) ProtoMessage()

func (*RateLimitDescriptor) ProtoReflect Uses

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

func (*RateLimitDescriptor) Reset Uses

func (x *RateLimitDescriptor) Reset()

func (*RateLimitDescriptor) String Uses

func (x *RateLimitDescriptor) String() string

func (*RateLimitDescriptor) Validate Uses

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, an error is returned.

type RateLimitDescriptorValidationError Uses

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 Uses

func (e RateLimitDescriptorValidationError) Cause() error

Cause function returns cause value.

func (RateLimitDescriptorValidationError) Error Uses

func (e RateLimitDescriptorValidationError) Error() string

Error satisfies the builtin error interface

func (RateLimitDescriptorValidationError) ErrorName Uses

func (e RateLimitDescriptorValidationError) ErrorName() string

ErrorName returns error name.

func (RateLimitDescriptorValidationError) Field Uses

func (e RateLimitDescriptorValidationError) Field() string

Field function returns field value.

func (RateLimitDescriptorValidationError) Key Uses

func (e RateLimitDescriptorValidationError) Key() bool

Key function returns key value.

func (RateLimitDescriptorValidationError) Reason Uses

func (e RateLimitDescriptorValidationError) Reason() string

Reason function returns reason value.

type RateLimitDescriptor_Entry Uses

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 Uses

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

Deprecated: Use RateLimitDescriptor_Entry.ProtoReflect.Descriptor instead.

func (*RateLimitDescriptor_Entry) GetKey Uses

func (x *RateLimitDescriptor_Entry) GetKey() string

func (*RateLimitDescriptor_Entry) GetValue Uses

func (x *RateLimitDescriptor_Entry) GetValue() string

func (*RateLimitDescriptor_Entry) ProtoMessage Uses

func (*RateLimitDescriptor_Entry) ProtoMessage()

func (*RateLimitDescriptor_Entry) ProtoReflect Uses

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

func (*RateLimitDescriptor_Entry) Reset Uses

func (x *RateLimitDescriptor_Entry) Reset()

func (*RateLimitDescriptor_Entry) String Uses

func (x *RateLimitDescriptor_Entry) String() string

func (*RateLimitDescriptor_Entry) Validate Uses

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, an error is returned.

type RateLimitDescriptor_EntryValidationError Uses

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 Uses

func (e RateLimitDescriptor_EntryValidationError) Cause() error

Cause function returns cause value.

func (RateLimitDescriptor_EntryValidationError) Error Uses

func (e RateLimitDescriptor_EntryValidationError) Error() string

Error satisfies the builtin error interface

func (RateLimitDescriptor_EntryValidationError) ErrorName Uses

func (e RateLimitDescriptor_EntryValidationError) ErrorName() string

ErrorName returns error name.

func (RateLimitDescriptor_EntryValidationError) Field Uses

func (e RateLimitDescriptor_EntryValidationError) Field() string

Field function returns field value.

func (RateLimitDescriptor_EntryValidationError) Key Uses

func (e RateLimitDescriptor_EntryValidationError) Key() bool

Key function returns key value.

func (RateLimitDescriptor_EntryValidationError) Reason Uses

func (e RateLimitDescriptor_EntryValidationError) Reason() string

Reason function returns reason value.

type RateLimitDescriptor_RateLimitOverride Uses

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 Uses

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

Deprecated: Use RateLimitDescriptor_RateLimitOverride.ProtoReflect.Descriptor instead.

func (*RateLimitDescriptor_RateLimitOverride) GetRequestsPerUnit Uses

func (x *RateLimitDescriptor_RateLimitOverride) GetRequestsPerUnit() uint32

func (*RateLimitDescriptor_RateLimitOverride) GetUnit Uses

func (x *RateLimitDescriptor_RateLimitOverride) GetUnit() v3.RateLimitUnit

func (*RateLimitDescriptor_RateLimitOverride) ProtoMessage Uses

func (*RateLimitDescriptor_RateLimitOverride) ProtoMessage()

func (*RateLimitDescriptor_RateLimitOverride) ProtoReflect Uses

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

func (*RateLimitDescriptor_RateLimitOverride) Reset Uses

func (x *RateLimitDescriptor_RateLimitOverride) Reset()

func (*RateLimitDescriptor_RateLimitOverride) String Uses

func (x *RateLimitDescriptor_RateLimitOverride) String() string

func (*RateLimitDescriptor_RateLimitOverride) Validate Uses

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, an error is returned.

type RateLimitDescriptor_RateLimitOverrideValidationError Uses

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 Uses

func (e RateLimitDescriptor_RateLimitOverrideValidationError) Cause() error

Cause function returns cause value.

func (RateLimitDescriptor_RateLimitOverrideValidationError) Error Uses

func (e RateLimitDescriptor_RateLimitOverrideValidationError) Error() string

Error satisfies the builtin error interface

func (RateLimitDescriptor_RateLimitOverrideValidationError) ErrorName Uses

func (e RateLimitDescriptor_RateLimitOverrideValidationError) ErrorName() string

ErrorName returns error name.

func (RateLimitDescriptor_RateLimitOverrideValidationError) Field Uses

func (e RateLimitDescriptor_RateLimitOverrideValidationError) Field() string

Field function returns field value.

func (RateLimitDescriptor_RateLimitOverrideValidationError) Key Uses

func (e RateLimitDescriptor_RateLimitOverrideValidationError) Key() bool

Key function returns key value.

func (RateLimitDescriptor_RateLimitOverrideValidationError) Reason Uses

func (e RateLimitDescriptor_RateLimitOverrideValidationError) Reason() string

Reason function returns reason value.

Package envoy_extensions_common_ratelimit_v3 imports 19 packages (graph) and is imported by 18 packages. Updated 2021-01-15. Refresh now. Tools for package owners.