ratelimitv3

package
v0.12.0 Latest Latest
Warning

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

 Go to latest Published: Jan 2, 2024 License: Apache-2.0 Imports: 24 Imported by: 23

Documentation

Index

Constants

This section is empty.

Variables

View Source 
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.

View Source 
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.

View 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.

View Source 
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.

View Source 
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 *duration.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 */
	// Sets the HTTP status that is returned to the client when the ratelimit server returns an error
	// or cannot be reached. The default status is 500.
	StatusOnError *v31.HttpStatus `protobuf:"bytes,12,opt,name=status_on_error,json=statusOnError,proto3" json:"status_on_error,omitempty"`
	// Optional additional prefix to use when emitting statistics. This allows to distinguish
	// emitted statistics between configured “ratelimit“ filters in an HTTP filter chain.
	StatPrefix string `protobuf:"bytes,13,opt,name=stat_prefix,json=statPrefix,proto3" json:"stat_prefix,omitempty"`
	// contains filtered or unexported fields
}

[#next-free-field: 14]

func (*RateLimit) Descriptor deprecated 

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

Deprecated: Use RateLimit.ProtoReflect.Descriptor instead.

func (*RateLimit) GetDisableXEnvoyRatelimitedHeader added in v0.9.8 

func (x *RateLimit) GetDisableXEnvoyRatelimitedHeader() bool

func (*RateLimit) GetDomain 

func (x *RateLimit) GetDomain() string

func (*RateLimit) GetEnableXRatelimitHeaders added in v0.9.7 

func (x *RateLimit) GetEnableXRatelimitHeaders() RateLimit_XRateLimitHeadersRFCVersion

func (*RateLimit) GetFailureModeDeny 

func (x *RateLimit) GetFailureModeDeny() bool

func (*RateLimit) GetRateLimitService 

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

func (*RateLimit) GetRateLimitedAsResourceExhausted 

func (x *RateLimit) GetRateLimitedAsResourceExhausted() bool

func (*RateLimit) GetRateLimitedStatus added in v0.10.2 

func (x *RateLimit) GetRateLimitedStatus() *v31.HttpStatus

func (*RateLimit) GetRequestType 

func (x *RateLimit) GetRequestType() string

func (*RateLimit) GetResponseHeadersToAdd added in v0.11.0 

func (x *RateLimit) GetResponseHeadersToAdd() []*v32.HeaderValueOption

func (*RateLimit) GetStage 

func (x *RateLimit) GetStage() uint32

func (*RateLimit) GetStatPrefix added in v0.12.0 

func (x *RateLimit) GetStatPrefix() string

func (*RateLimit) GetStatusOnError added in v0.12.0 

func (x *RateLimit) GetStatusOnError() *v31.HttpStatus

func (*RateLimit) GetTimeout 

func (x *RateLimit) GetTimeout() *duration.Duration

func (*RateLimit) ProtoMessage 

func (*RateLimit) ProtoMessage()

func (*RateLimit) ProtoReflect added in v0.9.6 

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, the first error encountered is returned, or nil if there are no violations.

func (*RateLimit) ValidateAll added in v0.10.0 

func (m *RateLimit) ValidateAll() error

ValidateAll checks the field values on RateLimit with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in RateLimitMultiError, or nil if none found.

type RateLimitConfig added in v0.10.0 

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 added in v0.10.0 

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

Deprecated: Use RateLimitConfig.ProtoReflect.Descriptor instead.

func (*RateLimitConfig) GetActions added in v0.10.0 

func (x *RateLimitConfig) GetActions() []*RateLimitConfig_Action

func (*RateLimitConfig) GetDisableKey added in v0.10.0 

func (x *RateLimitConfig) GetDisableKey() string

func (*RateLimitConfig) GetLimit added in v0.10.0 

func (x *RateLimitConfig) GetLimit() *RateLimitConfig_Override

func (*RateLimitConfig) GetStage added in v0.10.0 

func (x *RateLimitConfig) GetStage() uint32

func (*RateLimitConfig) ProtoMessage added in v0.10.0 

func (*RateLimitConfig) ProtoMessage()

func (*RateLimitConfig) ProtoReflect added in v0.10.0 

func (x *RateLimitConfig) ProtoReflect() protoreflect.Message

func (*RateLimitConfig) Reset added in v0.10.0 

func (x *RateLimitConfig) Reset()

func (*RateLimitConfig) String added in v0.10.0 

func (x *RateLimitConfig) String() string

func (*RateLimitConfig) Validate added in v0.10.0 

func (m *RateLimitConfig) Validate() error

Validate checks the field values on RateLimitConfig with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*RateLimitConfig) ValidateAll added in v0.10.0 

func (m *RateLimitConfig) ValidateAll() error

ValidateAll checks the field values on RateLimitConfig with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in RateLimitConfigMultiError, or nil if none found.

type RateLimitConfigMultiError added in v0.10.0 

type RateLimitConfigMultiError []error

RateLimitConfigMultiError is an error wrapping multiple validation errors returned by RateLimitConfig.ValidateAll() if the designated constraints aren't met.

func (RateLimitConfigMultiError) AllErrors added in v0.10.0 

func (m RateLimitConfigMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (RateLimitConfigMultiError) Error added in v0.10.0 

func (m RateLimitConfigMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type RateLimitConfigValidationError added in v0.10.0 

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

RateLimitConfigValidationError is the validation error returned by RateLimitConfig.Validate if the designated constraints aren't met.

func (RateLimitConfigValidationError) Cause added in v0.10.0 

func (e RateLimitConfigValidationError) Cause() error

Cause function returns cause value.

func (RateLimitConfigValidationError) Error added in v0.10.0 

func (e RateLimitConfigValidationError) Error() string

Error satisfies the builtin error interface

func (RateLimitConfigValidationError) ErrorName added in v0.10.0 

func (e RateLimitConfigValidationError) ErrorName() string

ErrorName returns error name.

func (RateLimitConfigValidationError) Field added in v0.10.0 

func (e RateLimitConfigValidationError) Field() string

Field function returns field value.

func (RateLimitConfigValidationError) Key added in v0.10.0 

func (e RateLimitConfigValidationError) Key() bool

Key function returns key value.

func (RateLimitConfigValidationError) Reason added in v0.10.0 

func (e RateLimitConfigValidationError) Reason() string

Reason function returns reason value.

type RateLimitConfig_Action added in v0.10.0 

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 added in v0.10.0 

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

Deprecated: Use RateLimitConfig_Action.ProtoReflect.Descriptor instead.

func (*RateLimitConfig_Action) GetActionSpecifier added in v0.10.0 

func (m *RateLimitConfig_Action) GetActionSpecifier() isRateLimitConfig_Action_ActionSpecifier

func (*RateLimitConfig_Action) GetDestinationCluster added in v0.10.0 

func (x *RateLimitConfig_Action) GetDestinationCluster() *RateLimitConfig_Action_DestinationCluster

func (*RateLimitConfig_Action) GetExtension added in v0.10.0 

func (x *RateLimitConfig_Action) GetExtension() *v32.TypedExtensionConfig

func (*RateLimitConfig_Action) GetGenericKey added in v0.10.0 

func (x *RateLimitConfig_Action) GetGenericKey() *RateLimitConfig_Action_GenericKey

func (*RateLimitConfig_Action) GetHeaderValueMatch added in v0.10.0 

func (x *RateLimitConfig_Action) GetHeaderValueMatch() *RateLimitConfig_Action_HeaderValueMatch

func (*RateLimitConfig_Action) GetMetadata added in v0.10.0 

func (x *RateLimitConfig_Action) GetMetadata() *RateLimitConfig_Action_MetaData

func (*RateLimitConfig_Action) GetRemoteAddress added in v0.10.0 

func (x *RateLimitConfig_Action) GetRemoteAddress() *RateLimitConfig_Action_RemoteAddress

func (*RateLimitConfig_Action) GetRequestHeaders added in v0.10.0 

func (x *RateLimitConfig_Action) GetRequestHeaders() *RateLimitConfig_Action_RequestHeaders

func (*RateLimitConfig_Action) GetSourceCluster added in v0.10.0 

func (x *RateLimitConfig_Action) GetSourceCluster() *RateLimitConfig_Action_SourceCluster

func (*RateLimitConfig_Action) ProtoMessage added in v0.10.0 

func (*RateLimitConfig_Action) ProtoMessage()

func (*RateLimitConfig_Action) ProtoReflect added in v0.10.0 

func (x *RateLimitConfig_Action) ProtoReflect() protoreflect.Message

func (*RateLimitConfig_Action) Reset added in v0.10.0 

func (x *RateLimitConfig_Action) Reset()

func (*RateLimitConfig_Action) String added in v0.10.0 

func (x *RateLimitConfig_Action) String() string

func (*RateLimitConfig_Action) Validate added in v0.10.0 

func (m *RateLimitConfig_Action) Validate() error

Validate checks the field values on RateLimitConfig_Action with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*RateLimitConfig_Action) ValidateAll added in v0.10.0 

func (m *RateLimitConfig_Action) ValidateAll() error

ValidateAll checks the field values on RateLimitConfig_Action with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in RateLimitConfig_ActionMultiError, or nil if none found.

type RateLimitConfig_ActionMultiError added in v0.10.0 

type RateLimitConfig_ActionMultiError []error

RateLimitConfig_ActionMultiError is an error wrapping multiple validation errors returned by RateLimitConfig_Action.ValidateAll() if the designated constraints aren't met.

func (RateLimitConfig_ActionMultiError) AllErrors added in v0.10.0 

func (m RateLimitConfig_ActionMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (RateLimitConfig_ActionMultiError) Error added in v0.10.0 

func (m RateLimitConfig_ActionMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type RateLimitConfig_ActionValidationError added in v0.10.0 

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

RateLimitConfig_ActionValidationError is the validation error returned by RateLimitConfig_Action.Validate if the designated constraints aren't met.

func (RateLimitConfig_ActionValidationError) Cause added in v0.10.0 

func (e RateLimitConfig_ActionValidationError) Cause() error

Cause function returns cause value.

func (RateLimitConfig_ActionValidationError) Error added in v0.10.0 

func (e RateLimitConfig_ActionValidationError) Error() string

Error satisfies the builtin error interface

func (RateLimitConfig_ActionValidationError) ErrorName added in v0.10.0 

func (e RateLimitConfig_ActionValidationError) ErrorName() string

ErrorName returns error name.

func (RateLimitConfig_ActionValidationError) Field added in v0.10.0 

func (e RateLimitConfig_ActionValidationError) Field() string

Field function returns field value.

func (RateLimitConfig_ActionValidationError) Key added in v0.10.0 

func (e RateLimitConfig_ActionValidationError) Key() bool

Key function returns key value.

func (RateLimitConfig_ActionValidationError) Reason added in v0.10.0 

func (e RateLimitConfig_ActionValidationError) Reason() string

Reason function returns reason value.

type RateLimitConfig_Action_DestinationCluster added in v0.10.0 

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 added in v0.10.0 

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

Deprecated: Use RateLimitConfig_Action_DestinationCluster.ProtoReflect.Descriptor instead.

func (*RateLimitConfig_Action_DestinationCluster) ProtoMessage added in v0.10.0 

func (*RateLimitConfig_Action_DestinationCluster) ProtoMessage()

func (*RateLimitConfig_Action_DestinationCluster) ProtoReflect added in v0.10.0 

func (x *RateLimitConfig_Action_DestinationCluster) ProtoReflect() protoreflect.Message

func (*RateLimitConfig_Action_DestinationCluster) Reset added in v0.10.0 

func (x *RateLimitConfig_Action_DestinationCluster) Reset()

func (*RateLimitConfig_Action_DestinationCluster) String added in v0.10.0 

func (x *RateLimitConfig_Action_DestinationCluster) String() string

func (*RateLimitConfig_Action_DestinationCluster) Validate added in v0.10.0 

func (m *RateLimitConfig_Action_DestinationCluster) Validate() error

Validate checks the field values on RateLimitConfig_Action_DestinationCluster with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*RateLimitConfig_Action_DestinationCluster) ValidateAll added in v0.10.0 

func (m *RateLimitConfig_Action_DestinationCluster) ValidateAll() error

ValidateAll checks the field values on RateLimitConfig_Action_DestinationCluster with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in RateLimitConfig_Action_DestinationClusterMultiError, or nil if none found.

type RateLimitConfig_Action_DestinationClusterMultiError added in v0.10.0 

type RateLimitConfig_Action_DestinationClusterMultiError []error

RateLimitConfig_Action_DestinationClusterMultiError is an error wrapping multiple validation errors returned by RateLimitConfig_Action_DestinationCluster.ValidateAll() if the designated constraints aren't met.

func (RateLimitConfig_Action_DestinationClusterMultiError) AllErrors added in v0.10.0 

func (m RateLimitConfig_Action_DestinationClusterMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (RateLimitConfig_Action_DestinationClusterMultiError) Error added in v0.10.0 

func (m RateLimitConfig_Action_DestinationClusterMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type RateLimitConfig_Action_DestinationClusterValidationError added in v0.10.0 

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

RateLimitConfig_Action_DestinationClusterValidationError is the validation error returned by RateLimitConfig_Action_DestinationCluster.Validate if the designated constraints aren't met.

func (RateLimitConfig_Action_DestinationClusterValidationError) Cause added in v0.10.0 

func (e RateLimitConfig_Action_DestinationClusterValidationError) Cause() error

Cause function returns cause value.

func (RateLimitConfig_Action_DestinationClusterValidationError) Error added in v0.10.0 

func (e RateLimitConfig_Action_DestinationClusterValidationError) Error() string

Error satisfies the builtin error interface

func (RateLimitConfig_Action_DestinationClusterValidationError) ErrorName added in v0.10.0 

func (e RateLimitConfig_Action_DestinationClusterValidationError) ErrorName() string

ErrorName returns error name.

func (RateLimitConfig_Action_DestinationClusterValidationError) Field added in v0.10.0 

func (e RateLimitConfig_Action_DestinationClusterValidationError) Field() string

Field function returns field value.

func (RateLimitConfig_Action_DestinationClusterValidationError) Key added in v0.10.0 

func (e RateLimitConfig_Action_DestinationClusterValidationError) Key() bool

Key function returns key value.

func (RateLimitConfig_Action_DestinationClusterValidationError) Reason added in v0.10.0 

func (e RateLimitConfig_Action_DestinationClusterValidationError) Reason() string

Reason function returns reason value.

type RateLimitConfig_Action_DestinationCluster_ added in v0.10.0 

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 added in v0.10.0 

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 added in v0.10.0 

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 added in v0.10.0 

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

Deprecated: Use RateLimitConfig_Action_GenericKey.ProtoReflect.Descriptor instead.

func (*RateLimitConfig_Action_GenericKey) GetDescriptorKey added in v0.10.0 

func (x *RateLimitConfig_Action_GenericKey) GetDescriptorKey() string

func (*RateLimitConfig_Action_GenericKey) GetDescriptorValue added in v0.10.0 

func (x *RateLimitConfig_Action_GenericKey) GetDescriptorValue() string

func (*RateLimitConfig_Action_GenericKey) ProtoMessage added in v0.10.0 

func (*RateLimitConfig_Action_GenericKey) ProtoMessage()

func (*RateLimitConfig_Action_GenericKey) ProtoReflect added in v0.10.0 

func (x *RateLimitConfig_Action_GenericKey) ProtoReflect() protoreflect.Message

func (*RateLimitConfig_Action_GenericKey) Reset added in v0.10.0 

func (x *RateLimitConfig_Action_GenericKey) Reset()

func (*RateLimitConfig_Action_GenericKey) String added in v0.10.0 

func (x *RateLimitConfig_Action_GenericKey) String() string

func (*RateLimitConfig_Action_GenericKey) Validate added in v0.10.0 

func (m *RateLimitConfig_Action_GenericKey) Validate() error

Validate checks the field values on RateLimitConfig_Action_GenericKey with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*RateLimitConfig_Action_GenericKey) ValidateAll added in v0.10.0 

func (m *RateLimitConfig_Action_GenericKey) ValidateAll() error

ValidateAll checks the field values on RateLimitConfig_Action_GenericKey with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in RateLimitConfig_Action_GenericKeyMultiError, or nil if none found.

type RateLimitConfig_Action_GenericKeyMultiError added in v0.10.0 

type RateLimitConfig_Action_GenericKeyMultiError []error

RateLimitConfig_Action_GenericKeyMultiError is an error wrapping multiple validation errors returned by RateLimitConfig_Action_GenericKey.ValidateAll() if the designated constraints aren't met.

func (RateLimitConfig_Action_GenericKeyMultiError) AllErrors added in v0.10.0 

func (m RateLimitConfig_Action_GenericKeyMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (RateLimitConfig_Action_GenericKeyMultiError) Error added in v0.10.0 

func (m RateLimitConfig_Action_GenericKeyMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type RateLimitConfig_Action_GenericKeyValidationError added in v0.10.0 

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

RateLimitConfig_Action_GenericKeyValidationError is the validation error returned by RateLimitConfig_Action_GenericKey.Validate if the designated constraints aren't met.

func (RateLimitConfig_Action_GenericKeyValidationError) Cause added in v0.10.0 

func (e RateLimitConfig_Action_GenericKeyValidationError) Cause() error

Cause function returns cause value.

func (RateLimitConfig_Action_GenericKeyValidationError) Error added in v0.10.0 

func (e RateLimitConfig_Action_GenericKeyValidationError) Error() string

Error satisfies the builtin error interface

func (RateLimitConfig_Action_GenericKeyValidationError) ErrorName added in v0.10.0 

func (e RateLimitConfig_Action_GenericKeyValidationError) ErrorName() string

ErrorName returns error name.

func (RateLimitConfig_Action_GenericKeyValidationError) Field added in v0.10.0 

func (e RateLimitConfig_Action_GenericKeyValidationError) Field() string

Field function returns field value.

func (RateLimitConfig_Action_GenericKeyValidationError) Key added in v0.10.0 

func (e RateLimitConfig_Action_GenericKeyValidationError) Key() bool

Key function returns key value.

func (RateLimitConfig_Action_GenericKeyValidationError) Reason added in v0.10.0 

func (e RateLimitConfig_Action_GenericKeyValidationError) Reason() string

Reason function returns reason value.

type RateLimitConfig_Action_GenericKey_ added in v0.10.0 

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 added in v0.10.0 

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 added in v0.10.0 

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

Deprecated: Use RateLimitConfig_Action_HeaderValueMatch.ProtoReflect.Descriptor instead.

func (*RateLimitConfig_Action_HeaderValueMatch) GetDescriptorValue added in v0.10.0 

func (x *RateLimitConfig_Action_HeaderValueMatch) GetDescriptorValue() string

func (*RateLimitConfig_Action_HeaderValueMatch) GetExpectMatch added in v0.10.0 

func (x *RateLimitConfig_Action_HeaderValueMatch) GetExpectMatch() bool

func (*RateLimitConfig_Action_HeaderValueMatch) GetHeaders added in v0.10.0 

func (x *RateLimitConfig_Action_HeaderValueMatch) GetHeaders() []*v33.HeaderMatcher

func (*RateLimitConfig_Action_HeaderValueMatch) ProtoMessage added in v0.10.0 

func (*RateLimitConfig_Action_HeaderValueMatch) ProtoMessage()

func (*RateLimitConfig_Action_HeaderValueMatch) ProtoReflect added in v0.10.0 

func (x *RateLimitConfig_Action_HeaderValueMatch) ProtoReflect() protoreflect.Message

func (*RateLimitConfig_Action_HeaderValueMatch) Reset added in v0.10.0 

func (x *RateLimitConfig_Action_HeaderValueMatch) Reset()

func (*RateLimitConfig_Action_HeaderValueMatch) String added in v0.10.0 

func (x *RateLimitConfig_Action_HeaderValueMatch) String() string

func (*RateLimitConfig_Action_HeaderValueMatch) Validate added in v0.10.0 

func (m *RateLimitConfig_Action_HeaderValueMatch) Validate() error

Validate checks the field values on RateLimitConfig_Action_HeaderValueMatch with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*RateLimitConfig_Action_HeaderValueMatch) ValidateAll added in v0.10.0 

func (m *RateLimitConfig_Action_HeaderValueMatch) ValidateAll() error

ValidateAll checks the field values on RateLimitConfig_Action_HeaderValueMatch with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in RateLimitConfig_Action_HeaderValueMatchMultiError, or nil if none found.

type RateLimitConfig_Action_HeaderValueMatchMultiError added in v0.10.0 

type RateLimitConfig_Action_HeaderValueMatchMultiError []error

RateLimitConfig_Action_HeaderValueMatchMultiError is an error wrapping multiple validation errors returned by RateLimitConfig_Action_HeaderValueMatch.ValidateAll() if the designated constraints aren't met.

func (RateLimitConfig_Action_HeaderValueMatchMultiError) AllErrors added in v0.10.0 

func (m RateLimitConfig_Action_HeaderValueMatchMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (RateLimitConfig_Action_HeaderValueMatchMultiError) Error added in v0.10.0 

func (m RateLimitConfig_Action_HeaderValueMatchMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type RateLimitConfig_Action_HeaderValueMatchValidationError added in v0.10.0 

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

RateLimitConfig_Action_HeaderValueMatchValidationError is the validation error returned by RateLimitConfig_Action_HeaderValueMatch.Validate if the designated constraints aren't met.

func (RateLimitConfig_Action_HeaderValueMatchValidationError) Cause added in v0.10.0 

func (e RateLimitConfig_Action_HeaderValueMatchValidationError) Cause() error

Cause function returns cause value.

func (RateLimitConfig_Action_HeaderValueMatchValidationError) Error added in v0.10.0 

func (e RateLimitConfig_Action_HeaderValueMatchValidationError) Error() string

Error satisfies the builtin error interface

func (RateLimitConfig_Action_HeaderValueMatchValidationError) ErrorName added in v0.10.0 

func (e RateLimitConfig_Action_HeaderValueMatchValidationError) ErrorName() string

ErrorName returns error name.

func (RateLimitConfig_Action_HeaderValueMatchValidationError) Field added in v0.10.0 

func (e RateLimitConfig_Action_HeaderValueMatchValidationError) Field() string

Field function returns field value.

func (RateLimitConfig_Action_HeaderValueMatchValidationError) Key added in v0.10.0 

func (e RateLimitConfig_Action_HeaderValueMatchValidationError) Key() bool

Key function returns key value.

func (RateLimitConfig_Action_HeaderValueMatchValidationError) Reason added in v0.10.0 

func (e RateLimitConfig_Action_HeaderValueMatchValidationError) Reason() string

Reason function returns reason value.

type RateLimitConfig_Action_HeaderValueMatch_ added in v0.10.0 

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 added in v0.10.0 

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 added in v0.10.0 

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

Deprecated: Use RateLimitConfig_Action_MetaData.ProtoReflect.Descriptor instead.

func (*RateLimitConfig_Action_MetaData) GetDefaultValue added in v0.10.0 

func (x *RateLimitConfig_Action_MetaData) GetDefaultValue() string

func (*RateLimitConfig_Action_MetaData) GetDescriptorKey added in v0.10.0 

func (x *RateLimitConfig_Action_MetaData) GetDescriptorKey() string

func (*RateLimitConfig_Action_MetaData) GetMetadataKey added in v0.10.0 

func (x *RateLimitConfig_Action_MetaData) GetMetadataKey() *v34.MetadataKey

func (*RateLimitConfig_Action_MetaData) GetSkipIfAbsent added in v0.11.0 

func (x *RateLimitConfig_Action_MetaData) GetSkipIfAbsent() bool

func (*RateLimitConfig_Action_MetaData) GetSource added in v0.10.0 

func (x *RateLimitConfig_Action_MetaData) GetSource() RateLimitConfig_Action_MetaData_Source

func (*RateLimitConfig_Action_MetaData) ProtoMessage added in v0.10.0 

func (*RateLimitConfig_Action_MetaData) ProtoMessage()

func (*RateLimitConfig_Action_MetaData) ProtoReflect added in v0.10.0 

func (x *RateLimitConfig_Action_MetaData) ProtoReflect() protoreflect.Message

func (*RateLimitConfig_Action_MetaData) Reset added in v0.10.0 

func (x *RateLimitConfig_Action_MetaData) Reset()

func (*RateLimitConfig_Action_MetaData) String added in v0.10.0 

func (x *RateLimitConfig_Action_MetaData) String() string

func (*RateLimitConfig_Action_MetaData) Validate added in v0.10.0 

func (m *RateLimitConfig_Action_MetaData) Validate() error

Validate checks the field values on RateLimitConfig_Action_MetaData with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*RateLimitConfig_Action_MetaData) ValidateAll added in v0.10.0 

func (m *RateLimitConfig_Action_MetaData) ValidateAll() error

ValidateAll checks the field values on RateLimitConfig_Action_MetaData with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in RateLimitConfig_Action_MetaDataMultiError, or nil if none found.

type RateLimitConfig_Action_MetaDataMultiError added in v0.10.0 

type RateLimitConfig_Action_MetaDataMultiError []error

RateLimitConfig_Action_MetaDataMultiError is an error wrapping multiple validation errors returned by RateLimitConfig_Action_MetaData.ValidateAll() if the designated constraints aren't met.

func (RateLimitConfig_Action_MetaDataMultiError) AllErrors added in v0.10.0 

func (m RateLimitConfig_Action_MetaDataMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (RateLimitConfig_Action_MetaDataMultiError) Error added in v0.10.0 

func (m RateLimitConfig_Action_MetaDataMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type RateLimitConfig_Action_MetaDataValidationError added in v0.10.0 

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

RateLimitConfig_Action_MetaDataValidationError is the validation error returned by RateLimitConfig_Action_MetaData.Validate if the designated constraints aren't met.

func (RateLimitConfig_Action_MetaDataValidationError) Cause added in v0.10.0 

func (e RateLimitConfig_Action_MetaDataValidationError) Cause() error

Cause function returns cause value.

func (RateLimitConfig_Action_MetaDataValidationError) Error added in v0.10.0 

func (e RateLimitConfig_Action_MetaDataValidationError) Error() string

Error satisfies the builtin error interface

func (RateLimitConfig_Action_MetaDataValidationError) ErrorName added in v0.10.0 

func (e RateLimitConfig_Action_MetaDataValidationError) ErrorName() string

ErrorName returns error name.

func (RateLimitConfig_Action_MetaDataValidationError) Field added in v0.10.0 

func (e RateLimitConfig_Action_MetaDataValidationError) Field() string

Field function returns field value.

func (RateLimitConfig_Action_MetaDataValidationError) Key added in v0.10.0 

func (e RateLimitConfig_Action_MetaDataValidationError) Key() bool

Key function returns key value.

func (RateLimitConfig_Action_MetaDataValidationError) Reason added in v0.10.0 

func (e RateLimitConfig_Action_MetaDataValidationError) Reason() string

Reason function returns reason value.

type RateLimitConfig_Action_MetaData_Source added in v0.10.0 

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 added in v0.10.0 

func (RateLimitConfig_Action_MetaData_Source) Descriptor() protoreflect.EnumDescriptor

func (RateLimitConfig_Action_MetaData_Source) Enum added in v0.10.0 

func (x RateLimitConfig_Action_MetaData_Source) Enum() *RateLimitConfig_Action_MetaData_Source

func (RateLimitConfig_Action_MetaData_Source) EnumDescriptor deprecated added in v0.10.0 

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

Deprecated: Use RateLimitConfig_Action_MetaData_Source.Descriptor instead.

func (RateLimitConfig_Action_MetaData_Source) Number added in v0.10.0 

func (x RateLimitConfig_Action_MetaData_Source) Number() protoreflect.EnumNumber

func (RateLimitConfig_Action_MetaData_Source) String added in v0.10.0 

func (x RateLimitConfig_Action_MetaData_Source) String() string

func (RateLimitConfig_Action_MetaData_Source) Type added in v0.10.0 

func (RateLimitConfig_Action_MetaData_Source) Type() protoreflect.EnumType

type RateLimitConfig_Action_Metadata added in v0.10.0 

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 added in v0.10.0 

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 added in v0.10.0 

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

Deprecated: Use RateLimitConfig_Action_RemoteAddress.ProtoReflect.Descriptor instead.

func (*RateLimitConfig_Action_RemoteAddress) ProtoMessage added in v0.10.0 

func (*RateLimitConfig_Action_RemoteAddress) ProtoMessage()

func (*RateLimitConfig_Action_RemoteAddress) ProtoReflect added in v0.10.0 

func (x *RateLimitConfig_Action_RemoteAddress) ProtoReflect() protoreflect.Message

func (*RateLimitConfig_Action_RemoteAddress) Reset added in v0.10.0 

func (x *RateLimitConfig_Action_RemoteAddress) Reset()

func (*RateLimitConfig_Action_RemoteAddress) String added in v0.10.0 

func (x *RateLimitConfig_Action_RemoteAddress) String() string

func (*RateLimitConfig_Action_RemoteAddress) Validate added in v0.10.0 

func (m *RateLimitConfig_Action_RemoteAddress) Validate() error

Validate checks the field values on RateLimitConfig_Action_RemoteAddress with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*RateLimitConfig_Action_RemoteAddress) ValidateAll added in v0.10.0 

func (m *RateLimitConfig_Action_RemoteAddress) ValidateAll() error

ValidateAll checks the field values on RateLimitConfig_Action_RemoteAddress with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in RateLimitConfig_Action_RemoteAddressMultiError, or nil if none found.

type RateLimitConfig_Action_RemoteAddressMultiError added in v0.10.0 

type RateLimitConfig_Action_RemoteAddressMultiError []error

RateLimitConfig_Action_RemoteAddressMultiError is an error wrapping multiple validation errors returned by RateLimitConfig_Action_RemoteAddress.ValidateAll() if the designated constraints aren't met.

func (RateLimitConfig_Action_RemoteAddressMultiError) AllErrors added in v0.10.0 

func (m RateLimitConfig_Action_RemoteAddressMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (RateLimitConfig_Action_RemoteAddressMultiError) Error added in v0.10.0 

func (m RateLimitConfig_Action_RemoteAddressMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type RateLimitConfig_Action_RemoteAddressValidationError added in v0.10.0 

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

RateLimitConfig_Action_RemoteAddressValidationError is the validation error returned by RateLimitConfig_Action_RemoteAddress.Validate if the designated constraints aren't met.

func (RateLimitConfig_Action_RemoteAddressValidationError) Cause added in v0.10.0 

func (e RateLimitConfig_Action_RemoteAddressValidationError) Cause() error

Cause function returns cause value.

func (RateLimitConfig_Action_RemoteAddressValidationError) Error added in v0.10.0 

func (e RateLimitConfig_Action_RemoteAddressValidationError) Error() string

Error satisfies the builtin error interface

func (RateLimitConfig_Action_RemoteAddressValidationError) ErrorName added in v0.10.0 

func (e RateLimitConfig_Action_RemoteAddressValidationError) ErrorName() string

ErrorName returns error name.

func (RateLimitConfig_Action_RemoteAddressValidationError) Field added in v0.10.0 

func (e RateLimitConfig_Action_RemoteAddressValidationError) Field() string

Field function returns field value.

func (RateLimitConfig_Action_RemoteAddressValidationError) Key added in v0.10.0 

func (e RateLimitConfig_Action_RemoteAddressValidationError) Key() bool

Key function returns key value.

func (RateLimitConfig_Action_RemoteAddressValidationError) Reason added in v0.10.0 

func (e RateLimitConfig_Action_RemoteAddressValidationError) Reason() string

Reason function returns reason value.

type RateLimitConfig_Action_RemoteAddress_ added in v0.10.0 

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 added in v0.10.0 

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 added in v0.10.0 

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

Deprecated: Use RateLimitConfig_Action_RequestHeaders.ProtoReflect.Descriptor instead.

func (*RateLimitConfig_Action_RequestHeaders) GetDescriptorKey added in v0.10.0 

func (x *RateLimitConfig_Action_RequestHeaders) GetDescriptorKey() string

func (*RateLimitConfig_Action_RequestHeaders) GetHeaderName added in v0.10.0 

func (x *RateLimitConfig_Action_RequestHeaders) GetHeaderName() string

func (*RateLimitConfig_Action_RequestHeaders) GetSkipIfAbsent added in v0.10.0 

func (x *RateLimitConfig_Action_RequestHeaders) GetSkipIfAbsent() bool

func (*RateLimitConfig_Action_RequestHeaders) ProtoMessage added in v0.10.0 

func (*RateLimitConfig_Action_RequestHeaders) ProtoMessage()

func (*RateLimitConfig_Action_RequestHeaders) ProtoReflect added in v0.10.0 

func (x *RateLimitConfig_Action_RequestHeaders) ProtoReflect() protoreflect.Message

func (*RateLimitConfig_Action_RequestHeaders) Reset added in v0.10.0 

func (x *RateLimitConfig_Action_RequestHeaders) Reset()

func (*RateLimitConfig_Action_RequestHeaders) String added in v0.10.0 

func (x *RateLimitConfig_Action_RequestHeaders) String() string

func (*RateLimitConfig_Action_RequestHeaders) Validate added in v0.10.0 

func (m *RateLimitConfig_Action_RequestHeaders) Validate() error

Validate checks the field values on RateLimitConfig_Action_RequestHeaders with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*RateLimitConfig_Action_RequestHeaders) ValidateAll added in v0.10.0 

func (m *RateLimitConfig_Action_RequestHeaders) ValidateAll() error

ValidateAll checks the field values on RateLimitConfig_Action_RequestHeaders with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in RateLimitConfig_Action_RequestHeadersMultiError, or nil if none found.

type RateLimitConfig_Action_RequestHeadersMultiError added in v0.10.0 

type RateLimitConfig_Action_RequestHeadersMultiError []error

RateLimitConfig_Action_RequestHeadersMultiError is an error wrapping multiple validation errors returned by RateLimitConfig_Action_RequestHeaders.ValidateAll() if the designated constraints aren't met.

func (RateLimitConfig_Action_RequestHeadersMultiError) AllErrors added in v0.10.0 

func (m RateLimitConfig_Action_RequestHeadersMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (RateLimitConfig_Action_RequestHeadersMultiError) Error added in v0.10.0 

func (m RateLimitConfig_Action_RequestHeadersMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type RateLimitConfig_Action_RequestHeadersValidationError added in v0.10.0 

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

RateLimitConfig_Action_RequestHeadersValidationError is the validation error returned by RateLimitConfig_Action_RequestHeaders.Validate if the designated constraints aren't met.

func (RateLimitConfig_Action_RequestHeadersValidationError) Cause added in v0.10.0 

func (e RateLimitConfig_Action_RequestHeadersValidationError) Cause() error

Cause function returns cause value.

func (RateLimitConfig_Action_RequestHeadersValidationError) Error added in v0.10.0 

func (e RateLimitConfig_Action_RequestHeadersValidationError) Error() string

Error satisfies the builtin error interface

func (RateLimitConfig_Action_RequestHeadersValidationError) ErrorName added in v0.10.0 

func (e RateLimitConfig_Action_RequestHeadersValidationError) ErrorName() string

ErrorName returns error name.

func (RateLimitConfig_Action_RequestHeadersValidationError) Field added in v0.10.0 

func (e RateLimitConfig_Action_RequestHeadersValidationError) Field() string

Field function returns field value.

func (RateLimitConfig_Action_RequestHeadersValidationError) Key added in v0.10.0 

func (e RateLimitConfig_Action_RequestHeadersValidationError) Key() bool

Key function returns key value.

func (RateLimitConfig_Action_RequestHeadersValidationError) Reason added in v0.10.0 

func (e RateLimitConfig_Action_RequestHeadersValidationError) Reason() string

Reason function returns reason value.

type RateLimitConfig_Action_RequestHeaders_ added in v0.10.0 

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 added in v0.10.0 

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 added in v0.10.0 

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

Deprecated: Use RateLimitConfig_Action_SourceCluster.ProtoReflect.Descriptor instead.

func (*RateLimitConfig_Action_SourceCluster) ProtoMessage added in v0.10.0 

func (*RateLimitConfig_Action_SourceCluster) ProtoMessage()

func (*RateLimitConfig_Action_SourceCluster) ProtoReflect added in v0.10.0 

func (x *RateLimitConfig_Action_SourceCluster) ProtoReflect() protoreflect.Message

func (*RateLimitConfig_Action_SourceCluster) Reset added in v0.10.0 

func (x *RateLimitConfig_Action_SourceCluster) Reset()

func (*RateLimitConfig_Action_SourceCluster) String added in v0.10.0 

func (x *RateLimitConfig_Action_SourceCluster) String() string

func (*RateLimitConfig_Action_SourceCluster) Validate added in v0.10.0 

func (m *RateLimitConfig_Action_SourceCluster) Validate() error

Validate checks the field values on RateLimitConfig_Action_SourceCluster with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*RateLimitConfig_Action_SourceCluster) ValidateAll added in v0.10.0 

func (m *RateLimitConfig_Action_SourceCluster) ValidateAll() error

ValidateAll checks the field values on RateLimitConfig_Action_SourceCluster with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in RateLimitConfig_Action_SourceClusterMultiError, or nil if none found.

type RateLimitConfig_Action_SourceClusterMultiError added in v0.10.0 

type RateLimitConfig_Action_SourceClusterMultiError []error

RateLimitConfig_Action_SourceClusterMultiError is an error wrapping multiple validation errors returned by RateLimitConfig_Action_SourceCluster.ValidateAll() if the designated constraints aren't met.

func (RateLimitConfig_Action_SourceClusterMultiError) AllErrors added in v0.10.0 

func (m RateLimitConfig_Action_SourceClusterMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (RateLimitConfig_Action_SourceClusterMultiError) Error added in v0.10.0 

func (m RateLimitConfig_Action_SourceClusterMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type RateLimitConfig_Action_SourceClusterValidationError added in v0.10.0 

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

RateLimitConfig_Action_SourceClusterValidationError is the validation error returned by RateLimitConfig_Action_SourceCluster.Validate if the designated constraints aren't met.

func (RateLimitConfig_Action_SourceClusterValidationError) Cause added in v0.10.0 

func (e RateLimitConfig_Action_SourceClusterValidationError) Cause() error

Cause function returns cause value.

func (RateLimitConfig_Action_SourceClusterValidationError) Error added in v0.10.0 

func (e RateLimitConfig_Action_SourceClusterValidationError) Error() string

Error satisfies the builtin error interface

func (RateLimitConfig_Action_SourceClusterValidationError) ErrorName added in v0.10.0 

func (e RateLimitConfig_Action_SourceClusterValidationError) ErrorName() string

ErrorName returns error name.

func (RateLimitConfig_Action_SourceClusterValidationError) Field added in v0.10.0 

func (e RateLimitConfig_Action_SourceClusterValidationError) Field() string

Field function returns field value.

func (RateLimitConfig_Action_SourceClusterValidationError) Key added in v0.10.0 

func (e RateLimitConfig_Action_SourceClusterValidationError) Key() bool

Key function returns key value.

func (RateLimitConfig_Action_SourceClusterValidationError) Reason added in v0.10.0 

func (e RateLimitConfig_Action_SourceClusterValidationError) Reason() string

Reason function returns reason value.

type RateLimitConfig_Action_SourceCluster_ added in v0.10.0 

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 added in v0.10.0 

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 added in v0.10.0 

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

Deprecated: Use RateLimitConfig_Override.ProtoReflect.Descriptor instead.

func (*RateLimitConfig_Override) GetDynamicMetadata added in v0.10.0 

func (x *RateLimitConfig_Override) GetDynamicMetadata() *RateLimitConfig_Override_DynamicMetadata

func (*RateLimitConfig_Override) GetOverrideSpecifier added in v0.10.0 

func (m *RateLimitConfig_Override) GetOverrideSpecifier() isRateLimitConfig_Override_OverrideSpecifier

func (*RateLimitConfig_Override) ProtoMessage added in v0.10.0 

func (*RateLimitConfig_Override) ProtoMessage()

func (*RateLimitConfig_Override) ProtoReflect added in v0.10.0 

func (x *RateLimitConfig_Override) ProtoReflect() protoreflect.Message

func (*RateLimitConfig_Override) Reset added in v0.10.0 

func (x *RateLimitConfig_Override) Reset()

func (*RateLimitConfig_Override) String added in v0.10.0 

func (x *RateLimitConfig_Override) String() string

func (*RateLimitConfig_Override) Validate added in v0.10.0 

func (m *RateLimitConfig_Override) Validate() error

Validate checks the field values on RateLimitConfig_Override with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*RateLimitConfig_Override) ValidateAll added in v0.10.0 

func (m *RateLimitConfig_Override) ValidateAll() error

ValidateAll checks the field values on RateLimitConfig_Override with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in RateLimitConfig_OverrideMultiError, or nil if none found.

type RateLimitConfig_OverrideMultiError added in v0.10.0 

type RateLimitConfig_OverrideMultiError []error

RateLimitConfig_OverrideMultiError is an error wrapping multiple validation errors returned by RateLimitConfig_Override.ValidateAll() if the designated constraints aren't met.

func (RateLimitConfig_OverrideMultiError) AllErrors added in v0.10.0 

func (m RateLimitConfig_OverrideMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (RateLimitConfig_OverrideMultiError) Error added in v0.10.0 

func (m RateLimitConfig_OverrideMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type RateLimitConfig_OverrideValidationError added in v0.10.0 

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

RateLimitConfig_OverrideValidationError is the validation error returned by RateLimitConfig_Override.Validate if the designated constraints aren't met.

func (RateLimitConfig_OverrideValidationError) Cause added in v0.10.0 

func (e RateLimitConfig_OverrideValidationError) Cause() error

Cause function returns cause value.

func (RateLimitConfig_OverrideValidationError) Error added in v0.10.0 

func (e RateLimitConfig_OverrideValidationError) Error() string

Error satisfies the builtin error interface

func (RateLimitConfig_OverrideValidationError) ErrorName added in v0.10.0 

func (e RateLimitConfig_OverrideValidationError) ErrorName() string

ErrorName returns error name.

func (RateLimitConfig_OverrideValidationError) Field added in v0.10.0 

func (e RateLimitConfig_OverrideValidationError) Field() string

Field function returns field value.

func (RateLimitConfig_OverrideValidationError) Key added in v0.10.0 

func (e RateLimitConfig_OverrideValidationError) Key() bool

Key function returns key value.

func (RateLimitConfig_OverrideValidationError) Reason added in v0.10.0 

func (e RateLimitConfig_OverrideValidationError) Reason() string

Reason function returns reason value.

type RateLimitConfig_Override_DynamicMetadata added in v0.10.0 

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 added in v0.10.0 

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

Deprecated: Use RateLimitConfig_Override_DynamicMetadata.ProtoReflect.Descriptor instead.

func (*RateLimitConfig_Override_DynamicMetadata) GetMetadataKey added in v0.10.0 

func (x *RateLimitConfig_Override_DynamicMetadata) GetMetadataKey() *v34.MetadataKey

func (*RateLimitConfig_Override_DynamicMetadata) ProtoMessage added in v0.10.0 

func (*RateLimitConfig_Override_DynamicMetadata) ProtoMessage()

func (*RateLimitConfig_Override_DynamicMetadata) ProtoReflect added in v0.10.0 

func (x *RateLimitConfig_Override_DynamicMetadata) ProtoReflect() protoreflect.Message

func (*RateLimitConfig_Override_DynamicMetadata) Reset added in v0.10.0 

func (x *RateLimitConfig_Override_DynamicMetadata) Reset()

func (*RateLimitConfig_Override_DynamicMetadata) String added in v0.10.0 

func (x *RateLimitConfig_Override_DynamicMetadata) String() string

func (*RateLimitConfig_Override_DynamicMetadata) Validate added in v0.10.0 

func (m *RateLimitConfig_Override_DynamicMetadata) Validate() error

Validate checks the field values on RateLimitConfig_Override_DynamicMetadata with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*RateLimitConfig_Override_DynamicMetadata) ValidateAll added in v0.10.0 

func (m *RateLimitConfig_Override_DynamicMetadata) ValidateAll() error

ValidateAll checks the field values on RateLimitConfig_Override_DynamicMetadata with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in RateLimitConfig_Override_DynamicMetadataMultiError, or nil if none found.

type RateLimitConfig_Override_DynamicMetadataMultiError added in v0.10.0 

type RateLimitConfig_Override_DynamicMetadataMultiError []error

RateLimitConfig_Override_DynamicMetadataMultiError is an error wrapping multiple validation errors returned by RateLimitConfig_Override_DynamicMetadata.ValidateAll() if the designated constraints aren't met.

func (RateLimitConfig_Override_DynamicMetadataMultiError) AllErrors added in v0.10.0 

func (m RateLimitConfig_Override_DynamicMetadataMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (RateLimitConfig_Override_DynamicMetadataMultiError) Error added in v0.10.0 

func (m RateLimitConfig_Override_DynamicMetadataMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type RateLimitConfig_Override_DynamicMetadataValidationError added in v0.10.0 

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

RateLimitConfig_Override_DynamicMetadataValidationError is the validation error returned by RateLimitConfig_Override_DynamicMetadata.Validate if the designated constraints aren't met.

func (RateLimitConfig_Override_DynamicMetadataValidationError) Cause added in v0.10.0 

func (e RateLimitConfig_Override_DynamicMetadataValidationError) Cause() error

Cause function returns cause value.

func (RateLimitConfig_Override_DynamicMetadataValidationError) Error added in v0.10.0 

func (e RateLimitConfig_Override_DynamicMetadataValidationError) Error() string

Error satisfies the builtin error interface

func (RateLimitConfig_Override_DynamicMetadataValidationError) ErrorName added in v0.10.0 

func (e RateLimitConfig_Override_DynamicMetadataValidationError) ErrorName() string

ErrorName returns error name.

func (RateLimitConfig_Override_DynamicMetadataValidationError) Field added in v0.10.0 

func (e RateLimitConfig_Override_DynamicMetadataValidationError) Field() string

Field function returns field value.

func (RateLimitConfig_Override_DynamicMetadataValidationError) Key added in v0.10.0 

func (e RateLimitConfig_Override_DynamicMetadataValidationError) Key() bool

Key function returns key value.

func (RateLimitConfig_Override_DynamicMetadataValidationError) Reason added in v0.10.0 

func (e RateLimitConfig_Override_DynamicMetadataValidationError) Reason() string

Reason function returns reason value.

type RateLimitConfig_Override_DynamicMetadata_ added in v0.10.0 

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 RateLimitMultiError added in v0.10.0 

type RateLimitMultiError []error

RateLimitMultiError is an error wrapping multiple validation errors returned by RateLimit.ValidateAll() if the designated constraints aren't met.

func (RateLimitMultiError) AllErrors added in v0.10.0 

func (m RateLimitMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (RateLimitMultiError) Error added in v0.10.0 

func (m RateLimitMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type RateLimitPerRoute added in v0.9.7 

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 added in v0.9.7 

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

Deprecated: Use RateLimitPerRoute.ProtoReflect.Descriptor instead.

func (*RateLimitPerRoute) GetDomain added in v0.11.1 

func (x *RateLimitPerRoute) GetDomain() string

func (*RateLimitPerRoute) GetOverrideOption added in v0.10.0 

func (x *RateLimitPerRoute) GetOverrideOption() RateLimitPerRoute_OverrideOptions

func (*RateLimitPerRoute) GetRateLimits added in v0.10.0 

func (x *RateLimitPerRoute) GetRateLimits() []*RateLimitConfig

func (*RateLimitPerRoute) GetVhRateLimits added in v0.9.7 

func (x *RateLimitPerRoute) GetVhRateLimits() RateLimitPerRoute_VhRateLimitsOptions

func (*RateLimitPerRoute) ProtoMessage added in v0.9.7 

func (*RateLimitPerRoute) ProtoMessage()

func (*RateLimitPerRoute) ProtoReflect added in v0.9.7 

func (x *RateLimitPerRoute) ProtoReflect() protoreflect.Message

func (*RateLimitPerRoute) Reset added in v0.9.7 

func (x *RateLimitPerRoute) Reset()

func (*RateLimitPerRoute) String added in v0.9.7 

func (x *RateLimitPerRoute) String() string

func (*RateLimitPerRoute) Validate added in v0.9.7 

func (m *RateLimitPerRoute) Validate() error

Validate checks the field values on RateLimitPerRoute with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*RateLimitPerRoute) ValidateAll added in v0.10.0 

func (m *RateLimitPerRoute) ValidateAll() error

ValidateAll checks the field values on RateLimitPerRoute with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in RateLimitPerRouteMultiError, or nil if none found.

type RateLimitPerRouteMultiError added in v0.10.0 

type RateLimitPerRouteMultiError []error

RateLimitPerRouteMultiError is an error wrapping multiple validation errors returned by RateLimitPerRoute.ValidateAll() if the designated constraints aren't met.

func (RateLimitPerRouteMultiError) AllErrors added in v0.10.0 

func (m RateLimitPerRouteMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (RateLimitPerRouteMultiError) Error added in v0.10.0 

func (m RateLimitPerRouteMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type RateLimitPerRouteValidationError added in v0.9.7 

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

RateLimitPerRouteValidationError is the validation error returned by RateLimitPerRoute.Validate if the designated constraints aren't met.

func (RateLimitPerRouteValidationError) Cause added in v0.9.7 

func (e RateLimitPerRouteValidationError) Cause() error

Cause function returns cause value.

func (RateLimitPerRouteValidationError) Error added in v0.9.7 

func (e RateLimitPerRouteValidationError) Error() string

Error satisfies the builtin error interface

func (RateLimitPerRouteValidationError) ErrorName added in v0.9.7 

func (e RateLimitPerRouteValidationError) ErrorName() string

ErrorName returns error name.

func (RateLimitPerRouteValidationError) Field added in v0.9.7 

func (e RateLimitPerRouteValidationError) Field() string

Field function returns field value.

func (RateLimitPerRouteValidationError) Key added in v0.9.7 

func (e RateLimitPerRouteValidationError) Key() bool

Key function returns key value.

func (RateLimitPerRouteValidationError) Reason added in v0.9.7 

func (e RateLimitPerRouteValidationError) Reason() string

Reason function returns reason value.

type RateLimitPerRoute_OverrideOptions added in v0.10.0 

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 added in v0.10.0 

func (RateLimitPerRoute_OverrideOptions) Descriptor() protoreflect.EnumDescriptor

func (RateLimitPerRoute_OverrideOptions) Enum added in v0.10.0 

func (x RateLimitPerRoute_OverrideOptions) Enum() *RateLimitPerRoute_OverrideOptions

func (RateLimitPerRoute_OverrideOptions) EnumDescriptor deprecated added in v0.10.0 

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

Deprecated: Use RateLimitPerRoute_OverrideOptions.Descriptor instead.

func (RateLimitPerRoute_OverrideOptions) Number added in v0.10.0 

func (x RateLimitPerRoute_OverrideOptions) Number() protoreflect.EnumNumber

func (RateLimitPerRoute_OverrideOptions) String added in v0.10.0 

func (x RateLimitPerRoute_OverrideOptions) String() string

func (RateLimitPerRoute_OverrideOptions) Type added in v0.10.0 

func (RateLimitPerRoute_OverrideOptions) Type() protoreflect.EnumType

type RateLimitPerRoute_VhRateLimitsOptions added in v0.9.7 

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 added in v0.9.7 

func (RateLimitPerRoute_VhRateLimitsOptions) Descriptor() protoreflect.EnumDescriptor

func (RateLimitPerRoute_VhRateLimitsOptions) Enum added in v0.9.7 

func (x RateLimitPerRoute_VhRateLimitsOptions) Enum() *RateLimitPerRoute_VhRateLimitsOptions

func (RateLimitPerRoute_VhRateLimitsOptions) EnumDescriptor deprecated added in v0.9.7 

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

Deprecated: Use RateLimitPerRoute_VhRateLimitsOptions.Descriptor instead.

func (RateLimitPerRoute_VhRateLimitsOptions) Number added in v0.9.7 

func (x RateLimitPerRoute_VhRateLimitsOptions) Number() protoreflect.EnumNumber

func (RateLimitPerRoute_VhRateLimitsOptions) String added in v0.9.7 

func (x RateLimitPerRoute_VhRateLimitsOptions) String() string

func (RateLimitPerRoute_VhRateLimitsOptions) Type added in v0.9.7 

func (RateLimitPerRoute_VhRateLimitsOptions) Type() protoreflect.EnumType

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 

func (e RateLimitValidationError) Key() bool

Key function returns key value.

func (RateLimitValidationError) Reason 

func (e RateLimitValidationError) Reason() string

Reason function returns reason value.

type RateLimit_XRateLimitHeadersRFCVersion added in v0.9.7 

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 added in v0.9.7 

func (RateLimit_XRateLimitHeadersRFCVersion) Descriptor() protoreflect.EnumDescriptor

func (RateLimit_XRateLimitHeadersRFCVersion) Enum added in v0.9.7 

func (x RateLimit_XRateLimitHeadersRFCVersion) Enum() *RateLimit_XRateLimitHeadersRFCVersion

func (RateLimit_XRateLimitHeadersRFCVersion) EnumDescriptor deprecated added in v0.9.7 

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

Deprecated: Use RateLimit_XRateLimitHeadersRFCVersion.Descriptor instead.

func (RateLimit_XRateLimitHeadersRFCVersion) Number added in v0.9.7 

func (x RateLimit_XRateLimitHeadersRFCVersion) Number() protoreflect.EnumNumber

func (RateLimit_XRateLimitHeadersRFCVersion) String added in v0.9.7 

func (x RateLimit_XRateLimitHeadersRFCVersion) String() string

func (RateLimit_XRateLimitHeadersRFCVersion) Type added in v0.9.7 

func (RateLimit_XRateLimitHeadersRFCVersion) Type() protoreflect.EnumType

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.