v2alpha1

Documentation

Index

• Variables
• type RateLimit
  • func (*RateLimit) Descriptor() ([]byte, []int)
  • func (m *RateLimit) GetDomain() string
  • func (m *RateLimit) GetFailureModeDeny() bool
  • func (m *RateLimit) GetStage() uint32
  • func (m *RateLimit) GetTimeout() *time.Duration
  • func (m *RateLimit) Marshal() (dAtA []byte, err error)
  • func (m *RateLimit) MarshalTo(dAtA []byte) (int, error)
  • func (*RateLimit) ProtoMessage()
  • func (m *RateLimit) Reset()
  • func (m *RateLimit) Size() (n int)
  • func (m *RateLimit) String() string
  • func (m *RateLimit) Unmarshal(dAtA []byte) error
  • func (m *RateLimit) Validate() error
  • func (m *RateLimit) XXX_DiscardUnknown()
  • func (m *RateLimit) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (dst *RateLimit) XXX_Merge(src proto.Message)
  • func (m *RateLimit) XXX_Size() int
  • func (m *RateLimit) XXX_Unmarshal(b []byte) error
• type RateLimitValidationError
  • func (e RateLimitValidationError) Error() string

Variables

var (
	ErrInvalidLengthRateLimit = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowRateLimit   = fmt.Errorf("proto: integer overflow")
)

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 *time.Duration `protobuf:"bytes,3,opt,name=timeout,stdduration" 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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

[#comment:next free field: 5]

func (*RateLimit) Descriptor

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

func (*RateLimit) GetDomain

func (m *RateLimit) GetDomain() string

func (*RateLimit) GetFailureModeDeny

func (m *RateLimit) GetFailureModeDeny() bool

func (*RateLimit) GetStage

func (m *RateLimit) GetStage() uint32

func (*RateLimit) GetTimeout

func (m *RateLimit) GetTimeout() *time.Duration

func (*RateLimit) Marshal

func (m *RateLimit) Marshal() (dAtA []byte, err error)

func (*RateLimit) MarshalTo

func (m *RateLimit) MarshalTo(dAtA []byte) (int, error)

func (*RateLimit) ProtoMessage

func (*RateLimit) ProtoMessage()

func (*RateLimit) Reset

func (m *RateLimit) Reset()

func (*RateLimit) Size

func (m *RateLimit) Size() (n int)

func (*RateLimit) String

func (m *RateLimit) String() string

func (*RateLimit) Unmarshal

func (m *RateLimit) Unmarshal(dAtA []byte) error

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.

func (*RateLimit) XXX_DiscardUnknown

func (m *RateLimit) XXX_DiscardUnknown()

func (*RateLimit) XXX_Marshal

func (m *RateLimit) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*RateLimit) XXX_Merge

func (dst *RateLimit) XXX_Merge(src proto.Message)

func (*RateLimit) XXX_Size

func (m *RateLimit) XXX_Size() int

func (*RateLimit) XXX_Unmarshal

func (m *RateLimit) XXX_Unmarshal(b []byte) error

type RateLimitValidationError

type RateLimitValidationError struct {
	Field  string
	Reason string
	Cause  error
	Key    bool
}

RateLimitValidationError is the validation error returned by RateLimit.Validate if the designated constraints aren't met.

func (RateLimitValidationError) Error

func (e RateLimitValidationError) Error() string

Error satisfies the builtin error interface