Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_envoy_config_filter_thrift_rate_limit_v2alpha1_rate_limit_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type RateLimit

type RateLimit struct {

	// The rate limit domain to use in the rate limit service request.
	Domain string `protobuf:"bytes,1,opt,name=domain,proto3" json:"domain,omitempty"`
	// Specifies the rate limit configuration stage. Each configured rate limit filter performs a
	// rate limit check using descriptors configured in the
	// :ref:`envoy_api_msg_config.filter.network.thrift_proxy.v2alpha1.RouteAction` for the request.
	// Only those entries with a matching stage number are used for a given filter. If not set, the
	// default stage number is 0.
	//
	// .. note::
	//
	//  The filter supports a range of 0 - 10 inclusively for stage numbers.
	Stage uint32 `protobuf:"varint,2,opt,name=stage,proto3" json:"stage,omitempty"`
	// The timeout in milliseconds for the rate limit service RPC. If not
	// set, this defaults to 20ms.
	Timeout *duration.Duration `protobuf:"bytes,3,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,4,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 *v2.RateLimitServiceConfig `protobuf:"bytes,5,opt,name=rate_limit_service,json=rateLimitService,proto3" json:"rate_limit_service,omitempty"`
	// contains filtered or unexported fields
}

    [#next-free-field: 6]

    func (*RateLimit) Descriptor

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

      Deprecated: Use RateLimit.ProtoReflect.Descriptor instead.

      func (*RateLimit) GetDomain

      func (x *RateLimit) GetDomain() string

      func (*RateLimit) GetFailureModeDeny

      func (x *RateLimit) GetFailureModeDeny() bool

      func (*RateLimit) GetRateLimitService

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

      func (*RateLimit) GetStage

      func (x *RateLimit) GetStage() uint32

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

        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

                    Key function returns key value.

                    func (RateLimitValidationError) Reason

                    func (e RateLimitValidationError) Reason() string

                      Reason function returns reason value.