v2

Documentation

Overview

Package v2 is a generated protocol buffer package.

It is generated from these files:

envoy/config/ratelimit/v2/rls.proto

It has these top-level messages:

RateLimitServiceConfig

Index

• Variables
• type RateLimitServiceConfig
  • func (*RateLimitServiceConfig) Descriptor() ([]byte, []int)
  • func (m *RateLimitServiceConfig) GetClusterName() string
  • func (m *RateLimitServiceConfig) GetGrpcService() *envoy_api_v2_core1.GrpcService
  • func (m *RateLimitServiceConfig) GetServiceSpecifier() isRateLimitServiceConfig_ServiceSpecifier
  • func (m *RateLimitServiceConfig) GetUseDataPlaneProto() bool
  • func (m *RateLimitServiceConfig) Marshal() (dAtA []byte, err error)
  • func (m *RateLimitServiceConfig) MarshalTo(dAtA []byte) (int, error)
  • func (*RateLimitServiceConfig) ProtoMessage()
  • func (m *RateLimitServiceConfig) Reset()
  • func (m *RateLimitServiceConfig) Size() (n int)
  • func (m *RateLimitServiceConfig) String() string
  • func (m *RateLimitServiceConfig) Unmarshal(dAtA []byte) error
  • func (m *RateLimitServiceConfig) Validate() error
  • func (*RateLimitServiceConfig) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, ...)
• type RateLimitServiceConfigValidationError
  • func (e RateLimitServiceConfigValidationError) Error() string
• type RateLimitServiceConfig_ClusterName
  • func (m *RateLimitServiceConfig_ClusterName) MarshalTo(dAtA []byte) (int, error)
  • func (m *RateLimitServiceConfig_ClusterName) Size() (n int)
• type RateLimitServiceConfig_GrpcService
  • func (m *RateLimitServiceConfig_GrpcService) MarshalTo(dAtA []byte) (int, error)
  • func (m *RateLimitServiceConfig_GrpcService) Size() (n int)

Variables

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

Types

type RateLimitServiceConfig

type RateLimitServiceConfig struct {
	// Types that are valid to be assigned to ServiceSpecifier:
	//	*RateLimitServiceConfig_ClusterName
	//	*RateLimitServiceConfig_GrpcService
	ServiceSpecifier isRateLimitServiceConfig_ServiceSpecifier `protobuf_oneof:"service_specifier"`
	// Specifies if Envoy should use the data-plane-api client
	// :repo:`api/envoy/service/ratelimit/v2/rls.proto` or the legacy
	// client :repo:`source/common/ratelimit/ratelimit.proto` when
	// making requests to the rate limit service.
	//
	// .. note::
	//
	//   The legacy client will be used by
	//   default until the start of the 1.9.0 release cycle. At the start of the
	//   1.9.0 release cycle this field will be removed and only the data-plane-api
	//   proto will be supported. This means that your rate limit service needs to
	//   have support for the data-plane-api proto by the start of the 1.9.0 release cycle.
	//   Lyft's `reference implementation <https://github.com/lyft/ratelimit>`_
	//   supports the data-plane-api version as of v1.1.0.
	UseDataPlaneProto bool `protobuf:"varint,3,opt,name=use_data_plane_proto,json=useDataPlaneProto,proto3" json:"use_data_plane_proto,omitempty"`
}

Rate limit :ref:`configuration overview <config_rate_limit_service>`.

func (*RateLimitServiceConfig) Descriptor

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

func (*RateLimitServiceConfig) GetClusterName

func (m *RateLimitServiceConfig) GetClusterName() string

func (*RateLimitServiceConfig) GetGrpcService

func (m *RateLimitServiceConfig) GetGrpcService() *envoy_api_v2_core1.GrpcService

func (*RateLimitServiceConfig) GetServiceSpecifier

func (m *RateLimitServiceConfig) GetServiceSpecifier() isRateLimitServiceConfig_ServiceSpecifier

func (*RateLimitServiceConfig) GetUseDataPlaneProto

func (m *RateLimitServiceConfig) GetUseDataPlaneProto() bool

func (*RateLimitServiceConfig) Marshal

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

func (*RateLimitServiceConfig) MarshalTo

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

func (*RateLimitServiceConfig) ProtoMessage

func (*RateLimitServiceConfig) ProtoMessage()

func (*RateLimitServiceConfig) Reset

func (m *RateLimitServiceConfig) Reset()

func (*RateLimitServiceConfig) Size

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

func (*RateLimitServiceConfig) String

func (m *RateLimitServiceConfig) String() string

func (*RateLimitServiceConfig) Unmarshal

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

func (*RateLimitServiceConfig) Validate

func (m *RateLimitServiceConfig) Validate() error

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

func (*RateLimitServiceConfig) XXX_OneofFuncs

func (*RateLimitServiceConfig) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type RateLimitServiceConfigValidationError

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

RateLimitServiceConfigValidationError is the validation error returned by RateLimitServiceConfig.Validate if the designated constraints aren't met.

func (RateLimitServiceConfigValidationError) Error

func (e RateLimitServiceConfigValidationError) Error() string

Error satisfies the builtin error interface

type RateLimitServiceConfig_ClusterName

type RateLimitServiceConfig_ClusterName struct {
	ClusterName string `protobuf:"bytes,1,opt,name=cluster_name,json=clusterName,proto3,oneof"`
}

func (*RateLimitServiceConfig_ClusterName) MarshalTo

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

func (*RateLimitServiceConfig_ClusterName) Size

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

type RateLimitServiceConfig_GrpcService

type RateLimitServiceConfig_GrpcService struct {
	GrpcService *envoy_api_v2_core1.GrpcService `protobuf:"bytes,2,opt,name=grpc_service,json=grpcService,oneof"`
}

func (*RateLimitServiceConfig_GrpcService) MarshalTo

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

func (*RateLimitServiceConfig_GrpcService) Size

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