envoy_service_ratelimit_v3

package
v1.5.0 Latest Latest
Warning

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

 Go to latest Published: May 28, 2020 License: Apache-2.0 Imports: 23 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrInvalidLengthRls        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowRls          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupRls = fmt.Errorf("proto: unexpected end of group")
)
View Source 
var RateLimitResponse_Code_name = map[int32]string{
	0: "UNKNOWN",
	1: "OK",
	2: "OVER_LIMIT",
}
View Source 
var RateLimitResponse_Code_value = map[string]int32{
	"UNKNOWN":    0,
	"OK":         1,
	"OVER_LIMIT": 2,
}
View Source 
var RateLimitResponse_RateLimit_Unit_name = map[int32]string{
	0: "UNKNOWN",
	1: "SECOND",
	2: "MINUTE",
	3: "HOUR",
	4: "DAY",
}
View Source 
var RateLimitResponse_RateLimit_Unit_value = map[string]int32{
	"UNKNOWN": 0,
	"SECOND":  1,
	"MINUTE":  2,
	"HOUR":    3,
	"DAY":     4,
}

Functions

func RegisterRateLimitServiceServer 

func RegisterRateLimitServiceServer(s *grpc.Server, srv RateLimitServiceServer)

Types

type RateLimitRequest 

type RateLimitRequest struct {
	// All rate limit requests must specify a domain. This enables the configuration to be per
	// application without fear of overlap. E.g., "envoy".
	Domain string `protobuf:"bytes,1,opt,name=domain,proto3" json:"domain,omitempty"`
	// All rate limit requests must specify at least one RateLimitDescriptor. Each descriptor is
	// processed by the service (see below). If any of the descriptors are over limit, the entire
	// request is considered to be over limit.
	Descriptors []*v3.RateLimitDescriptor `protobuf:"bytes,2,rep,name=descriptors,proto3" json:"descriptors,omitempty"`
	// Rate limit requests can optionally specify the number of hits a request adds to the matched
	// limit. If the value is not set in the message, a request increases the matched limit by 1.
	HitsAddend           uint32   `protobuf:"varint,3,opt,name=hits_addend,json=hitsAddend,proto3" json:"hits_addend,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Main message for a rate limit request. The rate limit service is designed to be fully generic in the sense that it can operate on arbitrary hierarchical key/value pairs. The loaded configuration will parse the request and find the most specific limit to apply. In addition, a RateLimitRequest can contain multiple "descriptors" to limit on. When multiple descriptors are provided, the server will limit on *ALL* of them and return an OVER_LIMIT response if any of them are over limit. This enables more complex application level rate limiting scenarios if desired.

func (*RateLimitRequest) Descriptor 

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

func (*RateLimitRequest) GetDescriptors 

func (m *RateLimitRequest) GetDescriptors() []*v3.RateLimitDescriptor

func (*RateLimitRequest) GetDomain 

func (m *RateLimitRequest) GetDomain() string

func (*RateLimitRequest) GetHitsAddend 

func (m *RateLimitRequest) GetHitsAddend() uint32

func (*RateLimitRequest) Marshal 

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

func (*RateLimitRequest) MarshalTo 

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

func (*RateLimitRequest) MarshalToSizedBuffer 

func (m *RateLimitRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*RateLimitRequest) ProtoMessage 

func (*RateLimitRequest) ProtoMessage()

func (*RateLimitRequest) Reset 

func (m *RateLimitRequest) Reset()

func (*RateLimitRequest) Size 

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

func (*RateLimitRequest) String 

func (m *RateLimitRequest) String() string

func (*RateLimitRequest) Unmarshal 

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

func (*RateLimitRequest) Validate 

func (m *RateLimitRequest) Validate() error

Validate checks the field values on RateLimitRequest with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*RateLimitRequest) XXX_DiscardUnknown 

func (m *RateLimitRequest) XXX_DiscardUnknown()

func (*RateLimitRequest) XXX_Marshal 

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

func (*RateLimitRequest) XXX_Merge 

func (m *RateLimitRequest) XXX_Merge(src proto.Message)

func (*RateLimitRequest) XXX_Size 

func (m *RateLimitRequest) XXX_Size() int

func (*RateLimitRequest) XXX_Unmarshal 

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

type RateLimitRequestValidationError 

type RateLimitRequestValidationError struct {
	// contains filtered or unexported fields
}

RateLimitRequestValidationError is the validation error returned by RateLimitRequest.Validate if the designated constraints aren't met.

func (RateLimitRequestValidationError) Cause 

func (e RateLimitRequestValidationError) Cause() error

Cause function returns cause value.

func (RateLimitRequestValidationError) Error 

func (e RateLimitRequestValidationError) Error() string

Error satisfies the builtin error interface

func (RateLimitRequestValidationError) ErrorName 

func (e RateLimitRequestValidationError) ErrorName() string

ErrorName returns error name.

func (RateLimitRequestValidationError) Field 

func (e RateLimitRequestValidationError) Field() string

Field function returns field value.

func (RateLimitRequestValidationError) Key 

func (e RateLimitRequestValidationError) Key() bool

Key function returns key value.

func (RateLimitRequestValidationError) Reason 

func (e RateLimitRequestValidationError) Reason() string

Reason function returns reason value.

type RateLimitResponse 

type RateLimitResponse struct {
	// The overall response code which takes into account all of the descriptors that were passed
	// in the RateLimitRequest message.
	OverallCode RateLimitResponse_Code `` /* 150-byte string literal not displayed */
	// A list of DescriptorStatus messages which matches the length of the descriptor list passed
	// in the RateLimitRequest. This can be used by the caller to determine which individual
	// descriptors failed and/or what the currently configured limits are for all of them.
	Statuses []*RateLimitResponse_DescriptorStatus `protobuf:"bytes,2,rep,name=statuses,proto3" json:"statuses,omitempty"`
	// A list of headers to add to the response
	ResponseHeadersToAdd []*v31.HeaderValue `protobuf:"bytes,3,rep,name=response_headers_to_add,json=responseHeadersToAdd,proto3" json:"response_headers_to_add,omitempty"`
	// A list of headers to add to the request when forwarded
	RequestHeadersToAdd  []*v31.HeaderValue `protobuf:"bytes,4,rep,name=request_headers_to_add,json=requestHeadersToAdd,proto3" json:"request_headers_to_add,omitempty"`
	XXX_NoUnkeyedLiteral struct{}           `json:"-"`
	XXX_unrecognized     []byte             `json:"-"`
	XXX_sizecache        int32              `json:"-"`
}

A response from a ShouldRateLimit call.

func (*RateLimitResponse) Descriptor 

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

func (*RateLimitResponse) GetOverallCode 

func (m *RateLimitResponse) GetOverallCode() RateLimitResponse_Code

func (*RateLimitResponse) GetRequestHeadersToAdd 

func (m *RateLimitResponse) GetRequestHeadersToAdd() []*v31.HeaderValue

func (*RateLimitResponse) GetResponseHeadersToAdd 

func (m *RateLimitResponse) GetResponseHeadersToAdd() []*v31.HeaderValue

func (*RateLimitResponse) GetStatuses 

func (m *RateLimitResponse) GetStatuses() []*RateLimitResponse_DescriptorStatus

func (*RateLimitResponse) Marshal 

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

func (*RateLimitResponse) MarshalTo 

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

func (*RateLimitResponse) MarshalToSizedBuffer 

func (m *RateLimitResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*RateLimitResponse) ProtoMessage 

func (*RateLimitResponse) ProtoMessage()

func (*RateLimitResponse) Reset 

func (m *RateLimitResponse) Reset()

func (*RateLimitResponse) Size 

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

func (*RateLimitResponse) String 

func (m *RateLimitResponse) String() string

func (*RateLimitResponse) Unmarshal 

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

func (*RateLimitResponse) Validate 

func (m *RateLimitResponse) Validate() error

Validate checks the field values on RateLimitResponse with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*RateLimitResponse) XXX_DiscardUnknown 

func (m *RateLimitResponse) XXX_DiscardUnknown()

func (*RateLimitResponse) XXX_Marshal 

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

func (*RateLimitResponse) XXX_Merge 

func (m *RateLimitResponse) XXX_Merge(src proto.Message)

func (*RateLimitResponse) XXX_Size 

func (m *RateLimitResponse) XXX_Size() int

func (*RateLimitResponse) XXX_Unmarshal 

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

type RateLimitResponseValidationError 

type RateLimitResponseValidationError struct {
	// contains filtered or unexported fields
}

RateLimitResponseValidationError is the validation error returned by RateLimitResponse.Validate if the designated constraints aren't met.

func (RateLimitResponseValidationError) Cause 

func (e RateLimitResponseValidationError) Cause() error

Cause function returns cause value.

func (RateLimitResponseValidationError) Error 

func (e RateLimitResponseValidationError) Error() string

Error satisfies the builtin error interface

func (RateLimitResponseValidationError) ErrorName 

func (e RateLimitResponseValidationError) ErrorName() string

ErrorName returns error name.

func (RateLimitResponseValidationError) Field 

func (e RateLimitResponseValidationError) Field() string

Field function returns field value.

func (RateLimitResponseValidationError) Key 

func (e RateLimitResponseValidationError) Key() bool

Key function returns key value.

func (RateLimitResponseValidationError) Reason 

func (e RateLimitResponseValidationError) Reason() string

Reason function returns reason value.

type RateLimitResponse_Code 

type RateLimitResponse_Code int32
const (
	// The response code is not known.
	RateLimitResponse_UNKNOWN RateLimitResponse_Code = 0
	// The response code to notify that the number of requests are under limit.
	RateLimitResponse_OK RateLimitResponse_Code = 1
	// The response code to notify that the number of requests are over limit.
	RateLimitResponse_OVER_LIMIT RateLimitResponse_Code = 2
)

func (RateLimitResponse_Code) EnumDescriptor 

func (RateLimitResponse_Code) EnumDescriptor() ([]byte, []int)

func (RateLimitResponse_Code) String 

func (x RateLimitResponse_Code) String() string

type RateLimitResponse_DescriptorStatus 

type RateLimitResponse_DescriptorStatus struct {
	// The response code for an individual descriptor.
	Code RateLimitResponse_Code `protobuf:"varint,1,opt,name=code,proto3,enum=envoy.service.ratelimit.v3.RateLimitResponse_Code" json:"code,omitempty"`
	// The current limit as configured by the server. Useful for debugging, etc.
	CurrentLimit *RateLimitResponse_RateLimit `protobuf:"bytes,2,opt,name=current_limit,json=currentLimit,proto3" json:"current_limit,omitempty"`
	// The limit remaining in the current time unit.
	LimitRemaining       uint32   `protobuf:"varint,3,opt,name=limit_remaining,json=limitRemaining,proto3" json:"limit_remaining,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*RateLimitResponse_DescriptorStatus) Descriptor 

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

func (*RateLimitResponse_DescriptorStatus) GetCode 

func (m *RateLimitResponse_DescriptorStatus) GetCode() RateLimitResponse_Code

func (*RateLimitResponse_DescriptorStatus) GetCurrentLimit 

func (m *RateLimitResponse_DescriptorStatus) GetCurrentLimit() *RateLimitResponse_RateLimit

func (*RateLimitResponse_DescriptorStatus) GetLimitRemaining 

func (m *RateLimitResponse_DescriptorStatus) GetLimitRemaining() uint32

func (*RateLimitResponse_DescriptorStatus) Marshal 

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

func (*RateLimitResponse_DescriptorStatus) MarshalTo 

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

func (*RateLimitResponse_DescriptorStatus) MarshalToSizedBuffer 

func (m *RateLimitResponse_DescriptorStatus) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*RateLimitResponse_DescriptorStatus) ProtoMessage 

func (*RateLimitResponse_DescriptorStatus) ProtoMessage()

func (*RateLimitResponse_DescriptorStatus) Reset 

func (m *RateLimitResponse_DescriptorStatus) Reset()

func (*RateLimitResponse_DescriptorStatus) Size 

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

func (*RateLimitResponse_DescriptorStatus) String 

func (m *RateLimitResponse_DescriptorStatus) String() string

func (*RateLimitResponse_DescriptorStatus) Unmarshal 

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

func (*RateLimitResponse_DescriptorStatus) Validate 

func (m *RateLimitResponse_DescriptorStatus) Validate() error

Validate checks the field values on RateLimitResponse_DescriptorStatus with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*RateLimitResponse_DescriptorStatus) XXX_DiscardUnknown 

func (m *RateLimitResponse_DescriptorStatus) XXX_DiscardUnknown()

func (*RateLimitResponse_DescriptorStatus) XXX_Marshal 

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

func (*RateLimitResponse_DescriptorStatus) XXX_Merge 

func (m *RateLimitResponse_DescriptorStatus) XXX_Merge(src proto.Message)

func (*RateLimitResponse_DescriptorStatus) XXX_Size 

func (m *RateLimitResponse_DescriptorStatus) XXX_Size() int

func (*RateLimitResponse_DescriptorStatus) XXX_Unmarshal 

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

type RateLimitResponse_DescriptorStatusValidationError 

type RateLimitResponse_DescriptorStatusValidationError struct {
	// contains filtered or unexported fields
}

RateLimitResponse_DescriptorStatusValidationError is the validation error returned by RateLimitResponse_DescriptorStatus.Validate if the designated constraints aren't met.

func (RateLimitResponse_DescriptorStatusValidationError) Cause 

func (e RateLimitResponse_DescriptorStatusValidationError) Cause() error

Cause function returns cause value.

func (RateLimitResponse_DescriptorStatusValidationError) Error 

func (e RateLimitResponse_DescriptorStatusValidationError) Error() string

Error satisfies the builtin error interface

func (RateLimitResponse_DescriptorStatusValidationError) ErrorName 

func (e RateLimitResponse_DescriptorStatusValidationError) ErrorName() string

ErrorName returns error name.

func (RateLimitResponse_DescriptorStatusValidationError) Field 

func (e RateLimitResponse_DescriptorStatusValidationError) Field() string

Field function returns field value.

func (RateLimitResponse_DescriptorStatusValidationError) Key 

func (e RateLimitResponse_DescriptorStatusValidationError) Key() bool

Key function returns key value.

func (RateLimitResponse_DescriptorStatusValidationError) Reason 

func (e RateLimitResponse_DescriptorStatusValidationError) Reason() string

Reason function returns reason value.

type RateLimitResponse_RateLimit 

type RateLimitResponse_RateLimit struct {
	// A name or description of this limit.
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// 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                 RateLimitResponse_RateLimit_Unit `` /* 127-byte string literal not displayed */
	XXX_NoUnkeyedLiteral struct{}                         `json:"-"`
	XXX_unrecognized     []byte                           `json:"-"`
	XXX_sizecache        int32                            `json:"-"`
}

Defines an actual rate limit in terms of requests per unit of time and the unit itself.

func (*RateLimitResponse_RateLimit) Descriptor 

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

func (*RateLimitResponse_RateLimit) GetName 

func (m *RateLimitResponse_RateLimit) GetName() string

func (*RateLimitResponse_RateLimit) GetRequestsPerUnit 

func (m *RateLimitResponse_RateLimit) GetRequestsPerUnit() uint32

func (*RateLimitResponse_RateLimit) GetUnit 

func (m *RateLimitResponse_RateLimit) GetUnit() RateLimitResponse_RateLimit_Unit

func (*RateLimitResponse_RateLimit) Marshal 

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

func (*RateLimitResponse_RateLimit) MarshalTo 

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

func (*RateLimitResponse_RateLimit) MarshalToSizedBuffer 

func (m *RateLimitResponse_RateLimit) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*RateLimitResponse_RateLimit) ProtoMessage 

func (*RateLimitResponse_RateLimit) ProtoMessage()

func (*RateLimitResponse_RateLimit) Reset 

func (m *RateLimitResponse_RateLimit) Reset()

func (*RateLimitResponse_RateLimit) Size 

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

func (*RateLimitResponse_RateLimit) String 

func (m *RateLimitResponse_RateLimit) String() string

func (*RateLimitResponse_RateLimit) Unmarshal 

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

func (*RateLimitResponse_RateLimit) Validate 

func (m *RateLimitResponse_RateLimit) Validate() error

Validate checks the field values on RateLimitResponse_RateLimit with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*RateLimitResponse_RateLimit) XXX_DiscardUnknown 

func (m *RateLimitResponse_RateLimit) XXX_DiscardUnknown()

func (*RateLimitResponse_RateLimit) XXX_Marshal 

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

func (*RateLimitResponse_RateLimit) XXX_Merge 

func (m *RateLimitResponse_RateLimit) XXX_Merge(src proto.Message)

func (*RateLimitResponse_RateLimit) XXX_Size 

func (m *RateLimitResponse_RateLimit) XXX_Size() int

func (*RateLimitResponse_RateLimit) XXX_Unmarshal 

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

type RateLimitResponse_RateLimitValidationError 

type RateLimitResponse_RateLimitValidationError struct {
	// contains filtered or unexported fields
}

RateLimitResponse_RateLimitValidationError is the validation error returned by RateLimitResponse_RateLimit.Validate if the designated constraints aren't met.

func (RateLimitResponse_RateLimitValidationError) Cause 

func (e RateLimitResponse_RateLimitValidationError) Cause() error

Cause function returns cause value.

func (RateLimitResponse_RateLimitValidationError) Error 

func (e RateLimitResponse_RateLimitValidationError) Error() string

Error satisfies the builtin error interface

func (RateLimitResponse_RateLimitValidationError) ErrorName 

func (e RateLimitResponse_RateLimitValidationError) ErrorName() string

ErrorName returns error name.

func (RateLimitResponse_RateLimitValidationError) Field 

func (e RateLimitResponse_RateLimitValidationError) Field() string

Field function returns field value.

func (RateLimitResponse_RateLimitValidationError) Key 

func (e RateLimitResponse_RateLimitValidationError) Key() bool

Key function returns key value.

func (RateLimitResponse_RateLimitValidationError) Reason 

func (e RateLimitResponse_RateLimitValidationError) Reason() string

Reason function returns reason value.

type RateLimitResponse_RateLimit_Unit 

type RateLimitResponse_RateLimit_Unit int32
const (
	// The time unit is not known.
	RateLimitResponse_RateLimit_UNKNOWN RateLimitResponse_RateLimit_Unit = 0
	// The time unit representing a second.
	RateLimitResponse_RateLimit_SECOND RateLimitResponse_RateLimit_Unit = 1
	// The time unit representing a minute.
	RateLimitResponse_RateLimit_MINUTE RateLimitResponse_RateLimit_Unit = 2
	// The time unit representing an hour.
	RateLimitResponse_RateLimit_HOUR RateLimitResponse_RateLimit_Unit = 3
	// The time unit representing a day.
	RateLimitResponse_RateLimit_DAY RateLimitResponse_RateLimit_Unit = 4
)

func (RateLimitResponse_RateLimit_Unit) EnumDescriptor 

func (RateLimitResponse_RateLimit_Unit) EnumDescriptor() ([]byte, []int)

func (RateLimitResponse_RateLimit_Unit) String 

func (x RateLimitResponse_RateLimit_Unit) String() string

type RateLimitServiceClient 

type RateLimitServiceClient interface {
	// Determine whether rate limiting should take place.
	ShouldRateLimit(ctx context.Context, in *RateLimitRequest, opts ...grpc.CallOption) (*RateLimitResponse, error)
}

RateLimitServiceClient is the client API for RateLimitService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewRateLimitServiceClient 

func NewRateLimitServiceClient(cc *grpc.ClientConn) RateLimitServiceClient

type RateLimitServiceServer 

type RateLimitServiceServer interface {
	// Determine whether rate limiting should take place.
	ShouldRateLimit(context.Context, *RateLimitRequest) (*RateLimitResponse, error)
}

RateLimitServiceServer is the server API for RateLimitService service.

type UnimplementedRateLimitServiceServer 

type UnimplementedRateLimitServiceServer struct {
}

UnimplementedRateLimitServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedRateLimitServiceServer) ShouldRateLimit 

func (*UnimplementedRateLimitServiceServer) ShouldRateLimit(ctx context.Context, req *RateLimitRequest) (*RateLimitResponse, error)

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.