Documentation ¶
Index ¶
- Variables
- type RateLimit
- func (*RateLimit) Descriptor() ([]byte, []int)deprecated
- func (x *RateLimit) GetDisableXEnvoyRatelimitedHeader() bool
- func (x *RateLimit) GetDomain() string
- func (x *RateLimit) GetEnableXRatelimitHeaders() RateLimit_XRateLimitHeadersRFCVersion
- func (x *RateLimit) GetFailureModeDeny() bool
- func (x *RateLimit) GetRateLimitService() *v3.RateLimitServiceConfig
- func (x *RateLimit) GetRateLimitedAsResourceExhausted() bool
- func (x *RateLimit) GetRateLimitedStatus() *v31.HttpStatus
- func (x *RateLimit) GetRequestType() string
- func (x *RateLimit) GetResponseHeadersToAdd() []*v32.HeaderValueOption
- func (x *RateLimit) GetStage() uint32
- func (x *RateLimit) GetTimeout() *durationpb.Duration
- func (*RateLimit) ProtoMessage()
- func (x *RateLimit) ProtoReflect() protoreflect.Message
- func (x *RateLimit) Reset()
- func (x *RateLimit) String() string
- type RateLimitConfig
- func (*RateLimitConfig) Descriptor() ([]byte, []int)deprecated
- func (x *RateLimitConfig) GetActions() []*RateLimitConfig_Action
- func (x *RateLimitConfig) GetDisableKey() string
- func (x *RateLimitConfig) GetLimit() *RateLimitConfig_Override
- func (x *RateLimitConfig) GetStage() uint32
- func (*RateLimitConfig) ProtoMessage()
- func (x *RateLimitConfig) ProtoReflect() protoreflect.Message
- func (x *RateLimitConfig) Reset()
- func (x *RateLimitConfig) String() string
- type RateLimitConfig_Action
- func (*RateLimitConfig_Action) Descriptor() ([]byte, []int)deprecated
- func (m *RateLimitConfig_Action) GetActionSpecifier() isRateLimitConfig_Action_ActionSpecifier
- func (x *RateLimitConfig_Action) GetDestinationCluster() *RateLimitConfig_Action_DestinationCluster
- func (x *RateLimitConfig_Action) GetExtension() *v32.TypedExtensionConfig
- func (x *RateLimitConfig_Action) GetGenericKey() *RateLimitConfig_Action_GenericKey
- func (x *RateLimitConfig_Action) GetHeaderValueMatch() *RateLimitConfig_Action_HeaderValueMatch
- func (x *RateLimitConfig_Action) GetMetadata() *RateLimitConfig_Action_MetaData
- func (x *RateLimitConfig_Action) GetRemoteAddress() *RateLimitConfig_Action_RemoteAddress
- func (x *RateLimitConfig_Action) GetRequestHeaders() *RateLimitConfig_Action_RequestHeaders
- func (x *RateLimitConfig_Action) GetSourceCluster() *RateLimitConfig_Action_SourceCluster
- func (*RateLimitConfig_Action) ProtoMessage()
- func (x *RateLimitConfig_Action) ProtoReflect() protoreflect.Message
- func (x *RateLimitConfig_Action) Reset()
- func (x *RateLimitConfig_Action) String() string
- type RateLimitConfig_Action_DestinationCluster
- func (*RateLimitConfig_Action_DestinationCluster) Descriptor() ([]byte, []int)deprecated
- func (*RateLimitConfig_Action_DestinationCluster) ProtoMessage()
- func (x *RateLimitConfig_Action_DestinationCluster) ProtoReflect() protoreflect.Message
- func (x *RateLimitConfig_Action_DestinationCluster) Reset()
- func (x *RateLimitConfig_Action_DestinationCluster) String() string
- type RateLimitConfig_Action_DestinationCluster_
- type RateLimitConfig_Action_Extension
- type RateLimitConfig_Action_GenericKey
- func (*RateLimitConfig_Action_GenericKey) Descriptor() ([]byte, []int)deprecated
- func (x *RateLimitConfig_Action_GenericKey) GetDescriptorKey() string
- func (x *RateLimitConfig_Action_GenericKey) GetDescriptorValue() string
- func (*RateLimitConfig_Action_GenericKey) ProtoMessage()
- func (x *RateLimitConfig_Action_GenericKey) ProtoReflect() protoreflect.Message
- func (x *RateLimitConfig_Action_GenericKey) Reset()
- func (x *RateLimitConfig_Action_GenericKey) String() string
- type RateLimitConfig_Action_GenericKey_
- type RateLimitConfig_Action_HeaderValueMatch
- func (*RateLimitConfig_Action_HeaderValueMatch) Descriptor() ([]byte, []int)deprecated
- func (x *RateLimitConfig_Action_HeaderValueMatch) GetDescriptorValue() string
- func (x *RateLimitConfig_Action_HeaderValueMatch) GetExpectMatch() bool
- func (x *RateLimitConfig_Action_HeaderValueMatch) GetHeaders() []*v33.HeaderMatcher
- func (*RateLimitConfig_Action_HeaderValueMatch) ProtoMessage()
- func (x *RateLimitConfig_Action_HeaderValueMatch) ProtoReflect() protoreflect.Message
- func (x *RateLimitConfig_Action_HeaderValueMatch) Reset()
- func (x *RateLimitConfig_Action_HeaderValueMatch) String() string
- type RateLimitConfig_Action_HeaderValueMatch_
- type RateLimitConfig_Action_MetaData
- func (*RateLimitConfig_Action_MetaData) Descriptor() ([]byte, []int)deprecated
- func (x *RateLimitConfig_Action_MetaData) GetDefaultValue() string
- func (x *RateLimitConfig_Action_MetaData) GetDescriptorKey() string
- func (x *RateLimitConfig_Action_MetaData) GetMetadataKey() *v34.MetadataKey
- func (x *RateLimitConfig_Action_MetaData) GetSkipIfAbsent() bool
- func (x *RateLimitConfig_Action_MetaData) GetSource() RateLimitConfig_Action_MetaData_Source
- func (*RateLimitConfig_Action_MetaData) ProtoMessage()
- func (x *RateLimitConfig_Action_MetaData) ProtoReflect() protoreflect.Message
- func (x *RateLimitConfig_Action_MetaData) Reset()
- func (x *RateLimitConfig_Action_MetaData) String() string
- type RateLimitConfig_Action_MetaData_Source
- func (RateLimitConfig_Action_MetaData_Source) Descriptor() protoreflect.EnumDescriptor
- func (x RateLimitConfig_Action_MetaData_Source) Enum() *RateLimitConfig_Action_MetaData_Source
- func (RateLimitConfig_Action_MetaData_Source) EnumDescriptor() ([]byte, []int)deprecated
- func (x RateLimitConfig_Action_MetaData_Source) Number() protoreflect.EnumNumber
- func (x RateLimitConfig_Action_MetaData_Source) String() string
- func (RateLimitConfig_Action_MetaData_Source) Type() protoreflect.EnumType
- type RateLimitConfig_Action_Metadata
- type RateLimitConfig_Action_RemoteAddress
- func (*RateLimitConfig_Action_RemoteAddress) Descriptor() ([]byte, []int)deprecated
- func (*RateLimitConfig_Action_RemoteAddress) ProtoMessage()
- func (x *RateLimitConfig_Action_RemoteAddress) ProtoReflect() protoreflect.Message
- func (x *RateLimitConfig_Action_RemoteAddress) Reset()
- func (x *RateLimitConfig_Action_RemoteAddress) String() string
- type RateLimitConfig_Action_RemoteAddress_
- type RateLimitConfig_Action_RequestHeaders
- func (*RateLimitConfig_Action_RequestHeaders) Descriptor() ([]byte, []int)deprecated
- func (x *RateLimitConfig_Action_RequestHeaders) GetDescriptorKey() string
- func (x *RateLimitConfig_Action_RequestHeaders) GetHeaderName() string
- func (x *RateLimitConfig_Action_RequestHeaders) GetSkipIfAbsent() bool
- func (*RateLimitConfig_Action_RequestHeaders) ProtoMessage()
- func (x *RateLimitConfig_Action_RequestHeaders) ProtoReflect() protoreflect.Message
- func (x *RateLimitConfig_Action_RequestHeaders) Reset()
- func (x *RateLimitConfig_Action_RequestHeaders) String() string
- type RateLimitConfig_Action_RequestHeaders_
- type RateLimitConfig_Action_SourceCluster
- func (*RateLimitConfig_Action_SourceCluster) Descriptor() ([]byte, []int)deprecated
- func (*RateLimitConfig_Action_SourceCluster) ProtoMessage()
- func (x *RateLimitConfig_Action_SourceCluster) ProtoReflect() protoreflect.Message
- func (x *RateLimitConfig_Action_SourceCluster) Reset()
- func (x *RateLimitConfig_Action_SourceCluster) String() string
- type RateLimitConfig_Action_SourceCluster_
- type RateLimitConfig_Override
- func (*RateLimitConfig_Override) Descriptor() ([]byte, []int)deprecated
- func (x *RateLimitConfig_Override) GetDynamicMetadata() *RateLimitConfig_Override_DynamicMetadata
- func (m *RateLimitConfig_Override) GetOverrideSpecifier() isRateLimitConfig_Override_OverrideSpecifier
- func (*RateLimitConfig_Override) ProtoMessage()
- func (x *RateLimitConfig_Override) ProtoReflect() protoreflect.Message
- func (x *RateLimitConfig_Override) Reset()
- func (x *RateLimitConfig_Override) String() string
- type RateLimitConfig_Override_DynamicMetadata
- func (*RateLimitConfig_Override_DynamicMetadata) Descriptor() ([]byte, []int)deprecated
- func (x *RateLimitConfig_Override_DynamicMetadata) GetMetadataKey() *v34.MetadataKey
- func (*RateLimitConfig_Override_DynamicMetadata) ProtoMessage()
- func (x *RateLimitConfig_Override_DynamicMetadata) ProtoReflect() protoreflect.Message
- func (x *RateLimitConfig_Override_DynamicMetadata) Reset()
- func (x *RateLimitConfig_Override_DynamicMetadata) String() string
- type RateLimitConfig_Override_DynamicMetadata_
- type RateLimitPerRoute
- func (*RateLimitPerRoute) Descriptor() ([]byte, []int)deprecated
- func (x *RateLimitPerRoute) GetDomain() string
- func (x *RateLimitPerRoute) GetOverrideOption() RateLimitPerRoute_OverrideOptions
- func (x *RateLimitPerRoute) GetRateLimits() []*RateLimitConfig
- func (x *RateLimitPerRoute) GetVhRateLimits() RateLimitPerRoute_VhRateLimitsOptions
- func (*RateLimitPerRoute) ProtoMessage()
- func (x *RateLimitPerRoute) ProtoReflect() protoreflect.Message
- func (x *RateLimitPerRoute) Reset()
- func (x *RateLimitPerRoute) String() string
- type RateLimitPerRoute_OverrideOptions
- func (RateLimitPerRoute_OverrideOptions) Descriptor() protoreflect.EnumDescriptor
- func (x RateLimitPerRoute_OverrideOptions) Enum() *RateLimitPerRoute_OverrideOptions
- func (RateLimitPerRoute_OverrideOptions) EnumDescriptor() ([]byte, []int)deprecated
- func (x RateLimitPerRoute_OverrideOptions) Number() protoreflect.EnumNumber
- func (x RateLimitPerRoute_OverrideOptions) String() string
- func (RateLimitPerRoute_OverrideOptions) Type() protoreflect.EnumType
- type RateLimitPerRoute_VhRateLimitsOptions
- func (RateLimitPerRoute_VhRateLimitsOptions) Descriptor() protoreflect.EnumDescriptor
- func (x RateLimitPerRoute_VhRateLimitsOptions) Enum() *RateLimitPerRoute_VhRateLimitsOptions
- func (RateLimitPerRoute_VhRateLimitsOptions) EnumDescriptor() ([]byte, []int)deprecated
- func (x RateLimitPerRoute_VhRateLimitsOptions) Number() protoreflect.EnumNumber
- func (x RateLimitPerRoute_VhRateLimitsOptions) String() string
- func (RateLimitPerRoute_VhRateLimitsOptions) Type() protoreflect.EnumType
- type RateLimit_XRateLimitHeadersRFCVersion
- func (RateLimit_XRateLimitHeadersRFCVersion) Descriptor() protoreflect.EnumDescriptor
- func (x RateLimit_XRateLimitHeadersRFCVersion) Enum() *RateLimit_XRateLimitHeadersRFCVersion
- func (RateLimit_XRateLimitHeadersRFCVersion) EnumDescriptor() ([]byte, []int)deprecated
- func (x RateLimit_XRateLimitHeadersRFCVersion) Number() protoreflect.EnumNumber
- func (x RateLimit_XRateLimitHeadersRFCVersion) String() string
- func (RateLimit_XRateLimitHeadersRFCVersion) Type() protoreflect.EnumType
Constants ¶
This section is empty.
Variables ¶
var ( RateLimit_XRateLimitHeadersRFCVersion_name = map[int32]string{ 0: "OFF", 1: "DRAFT_VERSION_03", } RateLimit_XRateLimitHeadersRFCVersion_value = map[string]int32{ "OFF": 0, "DRAFT_VERSION_03": 1, } )
Enum value maps for RateLimit_XRateLimitHeadersRFCVersion.
var ( RateLimitConfig_Action_MetaData_Source_name = map[int32]string{ 0: "DYNAMIC", 1: "ROUTE_ENTRY", } RateLimitConfig_Action_MetaData_Source_value = map[string]int32{ "DYNAMIC": 0, "ROUTE_ENTRY": 1, } )
Enum value maps for RateLimitConfig_Action_MetaData_Source.
var ( RateLimitPerRoute_VhRateLimitsOptions_name = map[int32]string{ 0: "OVERRIDE", 1: "INCLUDE", 2: "IGNORE", } RateLimitPerRoute_VhRateLimitsOptions_value = map[string]int32{ "OVERRIDE": 0, "INCLUDE": 1, "IGNORE": 2, } )
Enum value maps for RateLimitPerRoute_VhRateLimitsOptions.
var ( RateLimitPerRoute_OverrideOptions_name = map[int32]string{ 0: "DEFAULT", 1: "OVERRIDE_POLICY", 2: "INCLUDE_POLICY", 3: "IGNORE_POLICY", } RateLimitPerRoute_OverrideOptions_value = map[string]int32{ "DEFAULT": 0, "OVERRIDE_POLICY": 1, "INCLUDE_POLICY": 2, "IGNORE_POLICY": 3, } )
Enum value maps for RateLimitPerRoute_OverrideOptions.
var File_envoy_extensions_filters_http_ratelimit_v3_rate_limit_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type RateLimit ¶
type RateLimit struct { // The rate limit domain to use when calling the rate limit service. Domain string `protobuf:"bytes,1,opt,name=domain,proto3" json:"domain,omitempty"` // Specifies the rate limit configurations to be applied with the same // stage number. 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 type of requests the filter should apply to. The supported // types are “internal“, “external“ or “both“. A request is considered internal if // :ref:`x-envoy-internal<config_http_conn_man_headers_x-envoy-internal>` is set to true. If // :ref:`x-envoy-internal<config_http_conn_man_headers_x-envoy-internal>` is not set or false, a // request is considered external. The filter defaults to “both“, and it will apply to all request // types. RequestType string `protobuf:"bytes,3,opt,name=request_type,json=requestType,proto3" json:"request_type,omitempty"` // The timeout in milliseconds for the rate limit service RPC. If not // set, this defaults to 20ms. Timeout *durationpb.Duration `protobuf:"bytes,4,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. FailureModeDeny bool `protobuf:"varint,5,opt,name=failure_mode_deny,json=failureModeDeny,proto3" json:"failure_mode_deny,omitempty"` // Specifies whether a “RESOURCE_EXHAUSTED“ gRPC code must be returned instead // of the default “UNAVAILABLE“ gRPC code for a rate limited gRPC call. The // HTTP code will be 200 for a gRPC response. RateLimitedAsResourceExhausted bool `` /* 158-byte string literal not displayed */ // Configuration for an external rate limit service provider. If not // specified, any calls to the rate limit service will immediately return // success. RateLimitService *v3.RateLimitServiceConfig `protobuf:"bytes,7,opt,name=rate_limit_service,json=rateLimitService,proto3" json:"rate_limit_service,omitempty"` // Defines the standard version to use for X-RateLimit headers emitted by the filter: // // - “X-RateLimit-Limit“ - indicates the request-quota associated to the // client in the current time-window followed by the description of the // quota policy. The values are returned by the rate limiting service in // :ref:`current_limit<envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.DescriptorStatus.current_limit>` // field. Example: “10, 10;w=1;name="per-ip", 1000;w=3600“. // - “X-RateLimit-Remaining“ - indicates the remaining requests in the // current time-window. The values are returned by the rate limiting service // in :ref:`limit_remaining<envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.DescriptorStatus.limit_remaining>` // field. // - “X-RateLimit-Reset“ - indicates the number of seconds until reset of // the current time-window. The values are returned by the rate limiting service // in :ref:`duration_until_reset<envoy_v3_api_field_service.ratelimit.v3.RateLimitResponse.DescriptorStatus.duration_until_reset>` // field. // // In case rate limiting policy specifies more then one time window, the values // above represent the window that is closest to reaching its limit. // // For more information about the headers specification see selected version of // the `draft RFC <https://tools.ietf.org/id/draft-polli-ratelimit-headers-03.html>`_. // // Disabled by default. // // [#next-major-version: unify with local ratelimit, should use common.ratelimit.v3.XRateLimitHeadersRFCVersion instead.] EnableXRatelimitHeaders RateLimit_XRateLimitHeadersRFCVersion `` /* 221-byte string literal not displayed */ // Disables emitting the :ref:`x-envoy-ratelimited<config_http_filters_router_x-envoy-ratelimited>` header // in case of rate limiting (i.e. 429 responses). // Having this header not present potentially makes the request retriable. DisableXEnvoyRatelimitedHeader bool `` /* 158-byte string literal not displayed */ // This field allows for a custom HTTP response status code to the downstream client when // the request has been rate limited. // Defaults to 429 (TooManyRequests). // // .. note:: // // If this is set to < 400, 429 will be used instead. RateLimitedStatus *v31.HttpStatus `protobuf:"bytes,10,opt,name=rate_limited_status,json=rateLimitedStatus,proto3" json:"rate_limited_status,omitempty"` // Specifies a list of HTTP headers that should be added to each response for requests that // have been rate limited. ResponseHeadersToAdd []*v32.HeaderValueOption `` /* 126-byte string literal not displayed */ // contains filtered or unexported fields }
[#next-free-field: 12]
func (*RateLimit) GetDisableXEnvoyRatelimitedHeader ¶
func (*RateLimit) GetEnableXRatelimitHeaders ¶
func (x *RateLimit) GetEnableXRatelimitHeaders() RateLimit_XRateLimitHeadersRFCVersion
func (*RateLimit) GetRateLimitService ¶
func (x *RateLimit) GetRateLimitService() *v3.RateLimitServiceConfig
func (*RateLimit) GetRateLimitedAsResourceExhausted ¶
func (*RateLimit) GetRateLimitedStatus ¶
func (x *RateLimit) GetRateLimitedStatus() *v31.HttpStatus
func (*RateLimit) GetResponseHeadersToAdd ¶
func (x *RateLimit) GetResponseHeadersToAdd() []*v32.HeaderValueOption
func (*RateLimit) GetTimeout ¶
func (x *RateLimit) GetTimeout() *durationpb.Duration
func (*RateLimit) ProtoReflect ¶
func (x *RateLimit) ProtoReflect() protoreflect.Message
type RateLimitConfig ¶
type RateLimitConfig struct { // Refers to the stage set in the filter. The rate limit configuration only // applies to filters with the same stage number. The default stage number is // 0. // // .. note:: // // The filter supports a range of 0 - 10 inclusively for stage numbers. Stage uint32 `protobuf:"varint,1,opt,name=stage,proto3" json:"stage,omitempty"` // The key to be set in runtime to disable this rate limit configuration. DisableKey string `protobuf:"bytes,2,opt,name=disable_key,json=disableKey,proto3" json:"disable_key,omitempty"` // A list of actions that are to be applied for this rate limit configuration. // Order matters as the actions are processed sequentially and the descriptor // is composed by appending descriptor entries in that sequence. If an action // cannot append a descriptor entry, no descriptor is generated for the // configuration. See :ref:`composing actions // <config_http_filters_rate_limit_composing_actions>` for additional documentation. Actions []*RateLimitConfig_Action `protobuf:"bytes,3,rep,name=actions,proto3" json:"actions,omitempty"` // An optional limit override to be appended to the descriptor produced by this // rate limit configuration. If the override value is invalid or cannot be resolved // from metadata, no override is provided. See :ref:`rate limit override // <config_http_filters_rate_limit_rate_limit_override>` for more information. Limit *RateLimitConfig_Override `protobuf:"bytes,4,opt,name=limit,proto3" json:"limit,omitempty"` // contains filtered or unexported fields }
Global rate limiting :ref:`architecture overview <arch_overview_global_rate_limit>`. Also applies to Local rate limiting :ref:`using descriptors <config_http_filters_local_rate_limit_descriptors>`. [#not-implemented-hide:]
func (*RateLimitConfig) Descriptor
deprecated
func (*RateLimitConfig) Descriptor() ([]byte, []int)
Deprecated: Use RateLimitConfig.ProtoReflect.Descriptor instead.
func (*RateLimitConfig) GetActions ¶
func (x *RateLimitConfig) GetActions() []*RateLimitConfig_Action
func (*RateLimitConfig) GetDisableKey ¶
func (x *RateLimitConfig) GetDisableKey() string
func (*RateLimitConfig) GetLimit ¶
func (x *RateLimitConfig) GetLimit() *RateLimitConfig_Override
func (*RateLimitConfig) GetStage ¶
func (x *RateLimitConfig) GetStage() uint32
func (*RateLimitConfig) ProtoMessage ¶
func (*RateLimitConfig) ProtoMessage()
func (*RateLimitConfig) ProtoReflect ¶
func (x *RateLimitConfig) ProtoReflect() protoreflect.Message
func (*RateLimitConfig) Reset ¶
func (x *RateLimitConfig) Reset()
func (*RateLimitConfig) String ¶
func (x *RateLimitConfig) String() string
type RateLimitConfig_Action ¶
type RateLimitConfig_Action struct { // Types that are assignable to ActionSpecifier: // // *RateLimitConfig_Action_SourceCluster_ // *RateLimitConfig_Action_DestinationCluster_ // *RateLimitConfig_Action_RequestHeaders_ // *RateLimitConfig_Action_RemoteAddress_ // *RateLimitConfig_Action_GenericKey_ // *RateLimitConfig_Action_HeaderValueMatch_ // *RateLimitConfig_Action_Metadata // *RateLimitConfig_Action_Extension ActionSpecifier isRateLimitConfig_Action_ActionSpecifier `protobuf_oneof:"action_specifier"` // contains filtered or unexported fields }
[#next-free-field: 10]
func (*RateLimitConfig_Action) Descriptor
deprecated
func (*RateLimitConfig_Action) Descriptor() ([]byte, []int)
Deprecated: Use RateLimitConfig_Action.ProtoReflect.Descriptor instead.
func (*RateLimitConfig_Action) GetActionSpecifier ¶
func (m *RateLimitConfig_Action) GetActionSpecifier() isRateLimitConfig_Action_ActionSpecifier
func (*RateLimitConfig_Action) GetDestinationCluster ¶
func (x *RateLimitConfig_Action) GetDestinationCluster() *RateLimitConfig_Action_DestinationCluster
func (*RateLimitConfig_Action) GetExtension ¶
func (x *RateLimitConfig_Action) GetExtension() *v32.TypedExtensionConfig
func (*RateLimitConfig_Action) GetGenericKey ¶
func (x *RateLimitConfig_Action) GetGenericKey() *RateLimitConfig_Action_GenericKey
func (*RateLimitConfig_Action) GetHeaderValueMatch ¶
func (x *RateLimitConfig_Action) GetHeaderValueMatch() *RateLimitConfig_Action_HeaderValueMatch
func (*RateLimitConfig_Action) GetMetadata ¶
func (x *RateLimitConfig_Action) GetMetadata() *RateLimitConfig_Action_MetaData
func (*RateLimitConfig_Action) GetRemoteAddress ¶
func (x *RateLimitConfig_Action) GetRemoteAddress() *RateLimitConfig_Action_RemoteAddress
func (*RateLimitConfig_Action) GetRequestHeaders ¶
func (x *RateLimitConfig_Action) GetRequestHeaders() *RateLimitConfig_Action_RequestHeaders
func (*RateLimitConfig_Action) GetSourceCluster ¶
func (x *RateLimitConfig_Action) GetSourceCluster() *RateLimitConfig_Action_SourceCluster
func (*RateLimitConfig_Action) ProtoMessage ¶
func (*RateLimitConfig_Action) ProtoMessage()
func (*RateLimitConfig_Action) ProtoReflect ¶
func (x *RateLimitConfig_Action) ProtoReflect() protoreflect.Message
func (*RateLimitConfig_Action) Reset ¶
func (x *RateLimitConfig_Action) Reset()
func (*RateLimitConfig_Action) String ¶
func (x *RateLimitConfig_Action) String() string
type RateLimitConfig_Action_DestinationCluster ¶
type RateLimitConfig_Action_DestinationCluster struct {
// contains filtered or unexported fields
}
The following descriptor entry is appended to the descriptor:
.. code-block:: cpp
("destination_cluster", "<routed target cluster>")
Once a request matches against a route table rule, a routed cluster is determined by one of the following :ref:`route table configuration <envoy_v3_api_msg_config.route.v3.RouteConfiguration>` settings:
- :ref:`cluster <envoy_v3_api_field_config.route.v3.RouteAction.cluster>` indicates the upstream cluster to route to.
- :ref:`weighted_clusters <envoy_v3_api_field_config.route.v3.RouteAction.weighted_clusters>` chooses a cluster randomly from a set of clusters with attributed weight.
- :ref:`cluster_header <envoy_v3_api_field_config.route.v3.RouteAction.cluster_header>` indicates which header in the request contains the target cluster.
func (*RateLimitConfig_Action_DestinationCluster) Descriptor
deprecated
func (*RateLimitConfig_Action_DestinationCluster) Descriptor() ([]byte, []int)
Deprecated: Use RateLimitConfig_Action_DestinationCluster.ProtoReflect.Descriptor instead.
func (*RateLimitConfig_Action_DestinationCluster) ProtoMessage ¶
func (*RateLimitConfig_Action_DestinationCluster) ProtoMessage()
func (*RateLimitConfig_Action_DestinationCluster) ProtoReflect ¶
func (x *RateLimitConfig_Action_DestinationCluster) ProtoReflect() protoreflect.Message
func (*RateLimitConfig_Action_DestinationCluster) Reset ¶
func (x *RateLimitConfig_Action_DestinationCluster) Reset()
func (*RateLimitConfig_Action_DestinationCluster) String ¶
func (x *RateLimitConfig_Action_DestinationCluster) String() string
type RateLimitConfig_Action_DestinationCluster_ ¶
type RateLimitConfig_Action_DestinationCluster_ struct { // Rate limit on destination cluster. DestinationCluster *RateLimitConfig_Action_DestinationCluster `protobuf:"bytes,2,opt,name=destination_cluster,json=destinationCluster,proto3,oneof"` }
type RateLimitConfig_Action_Extension ¶
type RateLimitConfig_Action_Extension struct { // Rate limit descriptor extension. See the rate limit descriptor extensions documentation. // [#extension-category: envoy.rate_limit_descriptors] Extension *v32.TypedExtensionConfig `protobuf:"bytes,9,opt,name=extension,proto3,oneof"` }
type RateLimitConfig_Action_GenericKey ¶
type RateLimitConfig_Action_GenericKey struct { // The value to use in the descriptor entry. DescriptorValue string `protobuf:"bytes,1,opt,name=descriptor_value,json=descriptorValue,proto3" json:"descriptor_value,omitempty"` // An optional key to use in the descriptor entry. If not set it defaults // to 'generic_key' as the descriptor key. DescriptorKey string `protobuf:"bytes,2,opt,name=descriptor_key,json=descriptorKey,proto3" json:"descriptor_key,omitempty"` // contains filtered or unexported fields }
The following descriptor entry is appended to the descriptor:
.. code-block:: cpp
("generic_key", "<descriptor_value>")
func (*RateLimitConfig_Action_GenericKey) Descriptor
deprecated
func (*RateLimitConfig_Action_GenericKey) Descriptor() ([]byte, []int)
Deprecated: Use RateLimitConfig_Action_GenericKey.ProtoReflect.Descriptor instead.
func (*RateLimitConfig_Action_GenericKey) GetDescriptorKey ¶
func (x *RateLimitConfig_Action_GenericKey) GetDescriptorKey() string
func (*RateLimitConfig_Action_GenericKey) GetDescriptorValue ¶
func (x *RateLimitConfig_Action_GenericKey) GetDescriptorValue() string
func (*RateLimitConfig_Action_GenericKey) ProtoMessage ¶
func (*RateLimitConfig_Action_GenericKey) ProtoMessage()
func (*RateLimitConfig_Action_GenericKey) ProtoReflect ¶
func (x *RateLimitConfig_Action_GenericKey) ProtoReflect() protoreflect.Message
func (*RateLimitConfig_Action_GenericKey) Reset ¶
func (x *RateLimitConfig_Action_GenericKey) Reset()
func (*RateLimitConfig_Action_GenericKey) String ¶
func (x *RateLimitConfig_Action_GenericKey) String() string
type RateLimitConfig_Action_GenericKey_ ¶
type RateLimitConfig_Action_GenericKey_ struct { // Rate limit on a generic key. GenericKey *RateLimitConfig_Action_GenericKey `protobuf:"bytes,5,opt,name=generic_key,json=genericKey,proto3,oneof"` }
type RateLimitConfig_Action_HeaderValueMatch ¶
type RateLimitConfig_Action_HeaderValueMatch struct { // The value to use in the descriptor entry. DescriptorValue string `protobuf:"bytes,1,opt,name=descriptor_value,json=descriptorValue,proto3" json:"descriptor_value,omitempty"` // If set to true, the action will append a descriptor entry when the // request matches the headers. If set to false, the action will append a // descriptor entry when the request does not match the headers. The // default value is true. ExpectMatch bool `protobuf:"varint,2,opt,name=expect_match,json=expectMatch,proto3" json:"expect_match,omitempty"` // Specifies a set of headers that the rate limit action should match // on. The action will check the request’s headers against all the // specified headers in the config. A match will happen if all the // headers in the config are present in the request with the same values // (or based on presence if the value field is not in the config). Headers []*v33.HeaderMatcher `protobuf:"bytes,3,rep,name=headers,proto3" json:"headers,omitempty"` // contains filtered or unexported fields }
The following descriptor entry is appended to the descriptor:
.. code-block:: cpp
("header_match", "<descriptor_value>")
func (*RateLimitConfig_Action_HeaderValueMatch) Descriptor
deprecated
func (*RateLimitConfig_Action_HeaderValueMatch) Descriptor() ([]byte, []int)
Deprecated: Use RateLimitConfig_Action_HeaderValueMatch.ProtoReflect.Descriptor instead.
func (*RateLimitConfig_Action_HeaderValueMatch) GetDescriptorValue ¶
func (x *RateLimitConfig_Action_HeaderValueMatch) GetDescriptorValue() string
func (*RateLimitConfig_Action_HeaderValueMatch) GetExpectMatch ¶
func (x *RateLimitConfig_Action_HeaderValueMatch) GetExpectMatch() bool
func (*RateLimitConfig_Action_HeaderValueMatch) GetHeaders ¶
func (x *RateLimitConfig_Action_HeaderValueMatch) GetHeaders() []*v33.HeaderMatcher
func (*RateLimitConfig_Action_HeaderValueMatch) ProtoMessage ¶
func (*RateLimitConfig_Action_HeaderValueMatch) ProtoMessage()
func (*RateLimitConfig_Action_HeaderValueMatch) ProtoReflect ¶
func (x *RateLimitConfig_Action_HeaderValueMatch) ProtoReflect() protoreflect.Message
func (*RateLimitConfig_Action_HeaderValueMatch) Reset ¶
func (x *RateLimitConfig_Action_HeaderValueMatch) Reset()
func (*RateLimitConfig_Action_HeaderValueMatch) String ¶
func (x *RateLimitConfig_Action_HeaderValueMatch) String() string
type RateLimitConfig_Action_HeaderValueMatch_ ¶
type RateLimitConfig_Action_HeaderValueMatch_ struct { // Rate limit on the existence of request headers. HeaderValueMatch *RateLimitConfig_Action_HeaderValueMatch `protobuf:"bytes,6,opt,name=header_value_match,json=headerValueMatch,proto3,oneof"` }
type RateLimitConfig_Action_MetaData ¶
type RateLimitConfig_Action_MetaData struct { // The key to use in the descriptor entry. DescriptorKey string `protobuf:"bytes,1,opt,name=descriptor_key,json=descriptorKey,proto3" json:"descriptor_key,omitempty"` // Metadata struct that defines the key and path to retrieve the string value. A match will // only happen if the value in the metadata is of type string. MetadataKey *v34.MetadataKey `protobuf:"bytes,2,opt,name=metadata_key,json=metadataKey,proto3" json:"metadata_key,omitempty"` // An optional value to use if “metadata_key“ is empty. If not set and // no value is present under the metadata_key then “skip_if_absent“ is followed to // skip calling the rate limiting service or skip the descriptor. DefaultValue string `protobuf:"bytes,3,opt,name=default_value,json=defaultValue,proto3" json:"default_value,omitempty"` // Source of metadata Source RateLimitConfig_Action_MetaData_Source `` /* 153-byte string literal not displayed */ // If set to true, Envoy skips the descriptor while calling rate limiting service // when “metadata_key“ is empty and “default_value“ is not set. By default it skips calling the // rate limiting service in that case. SkipIfAbsent bool `protobuf:"varint,5,opt,name=skip_if_absent,json=skipIfAbsent,proto3" json:"skip_if_absent,omitempty"` // contains filtered or unexported fields }
The following descriptor entry is appended when the metadata contains a key value:
.. code-block:: cpp
("<descriptor_key>", "<value_queried_from_metadata>")
[#next-free-field: 6]
func (*RateLimitConfig_Action_MetaData) Descriptor
deprecated
func (*RateLimitConfig_Action_MetaData) Descriptor() ([]byte, []int)
Deprecated: Use RateLimitConfig_Action_MetaData.ProtoReflect.Descriptor instead.
func (*RateLimitConfig_Action_MetaData) GetDefaultValue ¶
func (x *RateLimitConfig_Action_MetaData) GetDefaultValue() string
func (*RateLimitConfig_Action_MetaData) GetDescriptorKey ¶
func (x *RateLimitConfig_Action_MetaData) GetDescriptorKey() string
func (*RateLimitConfig_Action_MetaData) GetMetadataKey ¶
func (x *RateLimitConfig_Action_MetaData) GetMetadataKey() *v34.MetadataKey
func (*RateLimitConfig_Action_MetaData) GetSkipIfAbsent ¶
func (x *RateLimitConfig_Action_MetaData) GetSkipIfAbsent() bool
func (*RateLimitConfig_Action_MetaData) GetSource ¶
func (x *RateLimitConfig_Action_MetaData) GetSource() RateLimitConfig_Action_MetaData_Source
func (*RateLimitConfig_Action_MetaData) ProtoMessage ¶
func (*RateLimitConfig_Action_MetaData) ProtoMessage()
func (*RateLimitConfig_Action_MetaData) ProtoReflect ¶
func (x *RateLimitConfig_Action_MetaData) ProtoReflect() protoreflect.Message
func (*RateLimitConfig_Action_MetaData) Reset ¶
func (x *RateLimitConfig_Action_MetaData) Reset()
func (*RateLimitConfig_Action_MetaData) String ¶
func (x *RateLimitConfig_Action_MetaData) String() string
type RateLimitConfig_Action_MetaData_Source ¶
type RateLimitConfig_Action_MetaData_Source int32
const ( // Query :ref:`dynamic metadata <well_known_dynamic_metadata>` RateLimitConfig_Action_MetaData_DYNAMIC RateLimitConfig_Action_MetaData_Source = 0 // Query :ref:`route entry metadata <envoy_v3_api_field_config.route.v3.Route.metadata>` RateLimitConfig_Action_MetaData_ROUTE_ENTRY RateLimitConfig_Action_MetaData_Source = 1 )
func (RateLimitConfig_Action_MetaData_Source) Descriptor ¶
func (RateLimitConfig_Action_MetaData_Source) Descriptor() protoreflect.EnumDescriptor
func (RateLimitConfig_Action_MetaData_Source) Enum ¶
func (RateLimitConfig_Action_MetaData_Source) EnumDescriptor
deprecated
func (RateLimitConfig_Action_MetaData_Source) EnumDescriptor() ([]byte, []int)
Deprecated: Use RateLimitConfig_Action_MetaData_Source.Descriptor instead.
func (RateLimitConfig_Action_MetaData_Source) Number ¶
func (x RateLimitConfig_Action_MetaData_Source) Number() protoreflect.EnumNumber
func (RateLimitConfig_Action_MetaData_Source) String ¶
func (x RateLimitConfig_Action_MetaData_Source) String() string
func (RateLimitConfig_Action_MetaData_Source) Type ¶
func (RateLimitConfig_Action_MetaData_Source) Type() protoreflect.EnumType
type RateLimitConfig_Action_Metadata ¶
type RateLimitConfig_Action_Metadata struct { // Rate limit on metadata. Metadata *RateLimitConfig_Action_MetaData `protobuf:"bytes,8,opt,name=metadata,proto3,oneof"` }
type RateLimitConfig_Action_RemoteAddress ¶
type RateLimitConfig_Action_RemoteAddress struct {
// contains filtered or unexported fields
}
The following descriptor entry is appended to the descriptor and is populated using the trusted address from :ref:`x-forwarded-for <config_http_conn_man_headers_x-forwarded-for>`:
.. code-block:: cpp
("remote_address", "<trusted address from x-forwarded-for>")
func (*RateLimitConfig_Action_RemoteAddress) Descriptor
deprecated
func (*RateLimitConfig_Action_RemoteAddress) Descriptor() ([]byte, []int)
Deprecated: Use RateLimitConfig_Action_RemoteAddress.ProtoReflect.Descriptor instead.
func (*RateLimitConfig_Action_RemoteAddress) ProtoMessage ¶
func (*RateLimitConfig_Action_RemoteAddress) ProtoMessage()
func (*RateLimitConfig_Action_RemoteAddress) ProtoReflect ¶
func (x *RateLimitConfig_Action_RemoteAddress) ProtoReflect() protoreflect.Message
func (*RateLimitConfig_Action_RemoteAddress) Reset ¶
func (x *RateLimitConfig_Action_RemoteAddress) Reset()
func (*RateLimitConfig_Action_RemoteAddress) String ¶
func (x *RateLimitConfig_Action_RemoteAddress) String() string
type RateLimitConfig_Action_RemoteAddress_ ¶
type RateLimitConfig_Action_RemoteAddress_ struct { // Rate limit on remote address. RemoteAddress *RateLimitConfig_Action_RemoteAddress `protobuf:"bytes,4,opt,name=remote_address,json=remoteAddress,proto3,oneof"` }
type RateLimitConfig_Action_RequestHeaders ¶
type RateLimitConfig_Action_RequestHeaders struct { // The header name to be queried from the request headers. The header’s // value is used to populate the value of the descriptor entry for the // descriptor_key. HeaderName string `protobuf:"bytes,1,opt,name=header_name,json=headerName,proto3" json:"header_name,omitempty"` // The key to use in the descriptor entry. DescriptorKey string `protobuf:"bytes,2,opt,name=descriptor_key,json=descriptorKey,proto3" json:"descriptor_key,omitempty"` // If set to true, Envoy skips the descriptor while calling rate limiting service // when header is not present in the request. By default it skips calling the // rate limiting service if this header is not present in the request. SkipIfAbsent bool `protobuf:"varint,3,opt,name=skip_if_absent,json=skipIfAbsent,proto3" json:"skip_if_absent,omitempty"` // contains filtered or unexported fields }
The following descriptor entry is appended when a header contains a key that matches the “header_name“:
.. code-block:: cpp
("<descriptor_key>", "<header_value_queried_from_header>")
func (*RateLimitConfig_Action_RequestHeaders) Descriptor
deprecated
func (*RateLimitConfig_Action_RequestHeaders) Descriptor() ([]byte, []int)
Deprecated: Use RateLimitConfig_Action_RequestHeaders.ProtoReflect.Descriptor instead.
func (*RateLimitConfig_Action_RequestHeaders) GetDescriptorKey ¶
func (x *RateLimitConfig_Action_RequestHeaders) GetDescriptorKey() string
func (*RateLimitConfig_Action_RequestHeaders) GetHeaderName ¶
func (x *RateLimitConfig_Action_RequestHeaders) GetHeaderName() string
func (*RateLimitConfig_Action_RequestHeaders) GetSkipIfAbsent ¶
func (x *RateLimitConfig_Action_RequestHeaders) GetSkipIfAbsent() bool
func (*RateLimitConfig_Action_RequestHeaders) ProtoMessage ¶
func (*RateLimitConfig_Action_RequestHeaders) ProtoMessage()
func (*RateLimitConfig_Action_RequestHeaders) ProtoReflect ¶
func (x *RateLimitConfig_Action_RequestHeaders) ProtoReflect() protoreflect.Message
func (*RateLimitConfig_Action_RequestHeaders) Reset ¶
func (x *RateLimitConfig_Action_RequestHeaders) Reset()
func (*RateLimitConfig_Action_RequestHeaders) String ¶
func (x *RateLimitConfig_Action_RequestHeaders) String() string
type RateLimitConfig_Action_RequestHeaders_ ¶
type RateLimitConfig_Action_RequestHeaders_ struct { // Rate limit on request headers. RequestHeaders *RateLimitConfig_Action_RequestHeaders `protobuf:"bytes,3,opt,name=request_headers,json=requestHeaders,proto3,oneof"` }
type RateLimitConfig_Action_SourceCluster ¶
type RateLimitConfig_Action_SourceCluster struct {
// contains filtered or unexported fields
}
The following descriptor entry is appended to the descriptor:
.. code-block:: cpp
("source_cluster", "<local service cluster>")
<local service cluster> is derived from the :option:`--service-cluster` option.
func (*RateLimitConfig_Action_SourceCluster) Descriptor
deprecated
func (*RateLimitConfig_Action_SourceCluster) Descriptor() ([]byte, []int)
Deprecated: Use RateLimitConfig_Action_SourceCluster.ProtoReflect.Descriptor instead.
func (*RateLimitConfig_Action_SourceCluster) ProtoMessage ¶
func (*RateLimitConfig_Action_SourceCluster) ProtoMessage()
func (*RateLimitConfig_Action_SourceCluster) ProtoReflect ¶
func (x *RateLimitConfig_Action_SourceCluster) ProtoReflect() protoreflect.Message
func (*RateLimitConfig_Action_SourceCluster) Reset ¶
func (x *RateLimitConfig_Action_SourceCluster) Reset()
func (*RateLimitConfig_Action_SourceCluster) String ¶
func (x *RateLimitConfig_Action_SourceCluster) String() string
type RateLimitConfig_Action_SourceCluster_ ¶
type RateLimitConfig_Action_SourceCluster_ struct { // Rate limit on source cluster. SourceCluster *RateLimitConfig_Action_SourceCluster `protobuf:"bytes,1,opt,name=source_cluster,json=sourceCluster,proto3,oneof"` }
type RateLimitConfig_Override ¶
type RateLimitConfig_Override struct { // Types that are assignable to OverrideSpecifier: // // *RateLimitConfig_Override_DynamicMetadata_ OverrideSpecifier isRateLimitConfig_Override_OverrideSpecifier `protobuf_oneof:"override_specifier"` // contains filtered or unexported fields }
func (*RateLimitConfig_Override) Descriptor
deprecated
func (*RateLimitConfig_Override) Descriptor() ([]byte, []int)
Deprecated: Use RateLimitConfig_Override.ProtoReflect.Descriptor instead.
func (*RateLimitConfig_Override) GetDynamicMetadata ¶
func (x *RateLimitConfig_Override) GetDynamicMetadata() *RateLimitConfig_Override_DynamicMetadata
func (*RateLimitConfig_Override) GetOverrideSpecifier ¶
func (m *RateLimitConfig_Override) GetOverrideSpecifier() isRateLimitConfig_Override_OverrideSpecifier
func (*RateLimitConfig_Override) ProtoMessage ¶
func (*RateLimitConfig_Override) ProtoMessage()
func (*RateLimitConfig_Override) ProtoReflect ¶
func (x *RateLimitConfig_Override) ProtoReflect() protoreflect.Message
func (*RateLimitConfig_Override) Reset ¶
func (x *RateLimitConfig_Override) Reset()
func (*RateLimitConfig_Override) String ¶
func (x *RateLimitConfig_Override) String() string
type RateLimitConfig_Override_DynamicMetadata ¶
type RateLimitConfig_Override_DynamicMetadata struct { // Metadata struct that defines the key and path to retrieve the struct value. // The value must be a struct containing an integer "requests_per_unit" property // and a "unit" property with a value parseable to :ref:`RateLimitUnit // enum <envoy_v3_api_enum_type.v3.RateLimitUnit>` MetadataKey *v34.MetadataKey `protobuf:"bytes,1,opt,name=metadata_key,json=metadataKey,proto3" json:"metadata_key,omitempty"` // contains filtered or unexported fields }
Fetches the override from the dynamic metadata.
func (*RateLimitConfig_Override_DynamicMetadata) Descriptor
deprecated
func (*RateLimitConfig_Override_DynamicMetadata) Descriptor() ([]byte, []int)
Deprecated: Use RateLimitConfig_Override_DynamicMetadata.ProtoReflect.Descriptor instead.
func (*RateLimitConfig_Override_DynamicMetadata) GetMetadataKey ¶
func (x *RateLimitConfig_Override_DynamicMetadata) GetMetadataKey() *v34.MetadataKey
func (*RateLimitConfig_Override_DynamicMetadata) ProtoMessage ¶
func (*RateLimitConfig_Override_DynamicMetadata) ProtoMessage()
func (*RateLimitConfig_Override_DynamicMetadata) ProtoReflect ¶
func (x *RateLimitConfig_Override_DynamicMetadata) ProtoReflect() protoreflect.Message
func (*RateLimitConfig_Override_DynamicMetadata) Reset ¶
func (x *RateLimitConfig_Override_DynamicMetadata) Reset()
func (*RateLimitConfig_Override_DynamicMetadata) String ¶
func (x *RateLimitConfig_Override_DynamicMetadata) String() string
type RateLimitConfig_Override_DynamicMetadata_ ¶
type RateLimitConfig_Override_DynamicMetadata_ struct { // Limit override from dynamic metadata. DynamicMetadata *RateLimitConfig_Override_DynamicMetadata `protobuf:"bytes,1,opt,name=dynamic_metadata,json=dynamicMetadata,proto3,oneof"` }
type RateLimitPerRoute ¶
type RateLimitPerRoute struct { // Specifies if the rate limit filter should include the virtual host rate limits. // [#next-major-version: unify with local ratelimit, should use common.ratelimit.v3.VhRateLimitsOptions instead.] VhRateLimits RateLimitPerRoute_VhRateLimitsOptions `` /* 186-byte string literal not displayed */ // Specifies if the rate limit filter should include the lower levels (route level, virtual host level or cluster weight level) rate limits override options. // [#not-implemented-hide:] OverrideOption RateLimitPerRoute_OverrideOptions `` /* 186-byte string literal not displayed */ // Rate limit configuration. If not set, uses the // :ref:`VirtualHost.rate_limits<envoy_v3_api_field_config.route.v3.VirtualHost.rate_limits>` or // :ref:`RouteAction.rate_limits<envoy_v3_api_field_config.route.v3.RouteAction.rate_limits>` fields instead. // [#not-implemented-hide:] RateLimits []*RateLimitConfig `protobuf:"bytes,3,rep,name=rate_limits,json=rateLimits,proto3" json:"rate_limits,omitempty"` // Overrides the domain. If not set, uses the filter-level domain instead. Domain string `protobuf:"bytes,4,opt,name=domain,proto3" json:"domain,omitempty"` // contains filtered or unexported fields }
func (*RateLimitPerRoute) Descriptor
deprecated
func (*RateLimitPerRoute) Descriptor() ([]byte, []int)
Deprecated: Use RateLimitPerRoute.ProtoReflect.Descriptor instead.
func (*RateLimitPerRoute) GetDomain ¶
func (x *RateLimitPerRoute) GetDomain() string
func (*RateLimitPerRoute) GetOverrideOption ¶
func (x *RateLimitPerRoute) GetOverrideOption() RateLimitPerRoute_OverrideOptions
func (*RateLimitPerRoute) GetRateLimits ¶
func (x *RateLimitPerRoute) GetRateLimits() []*RateLimitConfig
func (*RateLimitPerRoute) GetVhRateLimits ¶
func (x *RateLimitPerRoute) GetVhRateLimits() RateLimitPerRoute_VhRateLimitsOptions
func (*RateLimitPerRoute) ProtoMessage ¶
func (*RateLimitPerRoute) ProtoMessage()
func (*RateLimitPerRoute) ProtoReflect ¶
func (x *RateLimitPerRoute) ProtoReflect() protoreflect.Message
func (*RateLimitPerRoute) Reset ¶
func (x *RateLimitPerRoute) Reset()
func (*RateLimitPerRoute) String ¶
func (x *RateLimitPerRoute) String() string
type RateLimitPerRoute_OverrideOptions ¶
type RateLimitPerRoute_OverrideOptions int32
The override option determines how the filter handles the cases where there is an override config at a more specific level than this one (from least to most specific: virtual host, route, cluster weight). [#not-implemented-hide:]
const ( // Client-defined default, typically OVERRIDE_POLICY. If VhRateLimitsOptions is set, that will be used instead. RateLimitPerRoute_DEFAULT RateLimitPerRoute_OverrideOptions = 0 // If there is an override config at a more specific level, use that instead of this one. RateLimitPerRoute_OVERRIDE_POLICY RateLimitPerRoute_OverrideOptions = 1 // If there is an override config at a more specific level, use data from both. RateLimitPerRoute_INCLUDE_POLICY RateLimitPerRoute_OverrideOptions = 2 // If there is an override config at a more specific level, ignore it and use only this one. RateLimitPerRoute_IGNORE_POLICY RateLimitPerRoute_OverrideOptions = 3 )
func (RateLimitPerRoute_OverrideOptions) Descriptor ¶
func (RateLimitPerRoute_OverrideOptions) Descriptor() protoreflect.EnumDescriptor
func (RateLimitPerRoute_OverrideOptions) Enum ¶
func (x RateLimitPerRoute_OverrideOptions) Enum() *RateLimitPerRoute_OverrideOptions
func (RateLimitPerRoute_OverrideOptions) EnumDescriptor
deprecated
func (RateLimitPerRoute_OverrideOptions) EnumDescriptor() ([]byte, []int)
Deprecated: Use RateLimitPerRoute_OverrideOptions.Descriptor instead.
func (RateLimitPerRoute_OverrideOptions) Number ¶
func (x RateLimitPerRoute_OverrideOptions) Number() protoreflect.EnumNumber
func (RateLimitPerRoute_OverrideOptions) String ¶
func (x RateLimitPerRoute_OverrideOptions) String() string
func (RateLimitPerRoute_OverrideOptions) Type ¶
func (RateLimitPerRoute_OverrideOptions) Type() protoreflect.EnumType
type RateLimitPerRoute_VhRateLimitsOptions ¶
type RateLimitPerRoute_VhRateLimitsOptions int32
[#next-major-version: unify with local ratelimit, should use common.ratelimit.v3.VhRateLimitsOptions instead.]
const ( // Use the virtual host rate limits unless the route has a rate limit policy. RateLimitPerRoute_OVERRIDE RateLimitPerRoute_VhRateLimitsOptions = 0 // Use the virtual host rate limits even if the route has a rate limit policy. RateLimitPerRoute_INCLUDE RateLimitPerRoute_VhRateLimitsOptions = 1 // Ignore the virtual host rate limits even if the route does not have a rate limit policy. RateLimitPerRoute_IGNORE RateLimitPerRoute_VhRateLimitsOptions = 2 )
func (RateLimitPerRoute_VhRateLimitsOptions) Descriptor ¶
func (RateLimitPerRoute_VhRateLimitsOptions) Descriptor() protoreflect.EnumDescriptor
func (RateLimitPerRoute_VhRateLimitsOptions) Enum ¶
func (RateLimitPerRoute_VhRateLimitsOptions) EnumDescriptor
deprecated
func (RateLimitPerRoute_VhRateLimitsOptions) EnumDescriptor() ([]byte, []int)
Deprecated: Use RateLimitPerRoute_VhRateLimitsOptions.Descriptor instead.
func (RateLimitPerRoute_VhRateLimitsOptions) Number ¶
func (x RateLimitPerRoute_VhRateLimitsOptions) Number() protoreflect.EnumNumber
func (RateLimitPerRoute_VhRateLimitsOptions) String ¶
func (x RateLimitPerRoute_VhRateLimitsOptions) String() string
func (RateLimitPerRoute_VhRateLimitsOptions) Type ¶
func (RateLimitPerRoute_VhRateLimitsOptions) Type() protoreflect.EnumType
type RateLimit_XRateLimitHeadersRFCVersion ¶
type RateLimit_XRateLimitHeadersRFCVersion int32
Defines the version of the standard to use for X-RateLimit headers.
[#next-major-version: unify with local ratelimit, should use common.ratelimit.v3.XRateLimitHeadersRFCVersion instead.]
const ( // X-RateLimit headers disabled. RateLimit_OFF RateLimit_XRateLimitHeadersRFCVersion = 0 // Use `draft RFC Version 03 <https://tools.ietf.org/id/draft-polli-ratelimit-headers-03.html>`_. RateLimit_DRAFT_VERSION_03 RateLimit_XRateLimitHeadersRFCVersion = 1 )
func (RateLimit_XRateLimitHeadersRFCVersion) Descriptor ¶
func (RateLimit_XRateLimitHeadersRFCVersion) Descriptor() protoreflect.EnumDescriptor
func (RateLimit_XRateLimitHeadersRFCVersion) Enum ¶
func (RateLimit_XRateLimitHeadersRFCVersion) EnumDescriptor
deprecated
func (RateLimit_XRateLimitHeadersRFCVersion) EnumDescriptor() ([]byte, []int)
Deprecated: Use RateLimit_XRateLimitHeadersRFCVersion.Descriptor instead.
func (RateLimit_XRateLimitHeadersRFCVersion) Number ¶
func (x RateLimit_XRateLimitHeadersRFCVersion) Number() protoreflect.EnumNumber
func (RateLimit_XRateLimitHeadersRFCVersion) String ¶
func (x RateLimit_XRateLimitHeadersRFCVersion) String() string
func (RateLimit_XRateLimitHeadersRFCVersion) Type ¶
func (RateLimit_XRateLimitHeadersRFCVersion) Type() protoreflect.EnumType