routev3

package
Version: v0.10.3 Latest Latest
Warning

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

 Go to latest Published: Jun 28, 2022 License: Apache-2.0 Imports: 29 Imported by: 195

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	VirtualHost_TlsRequirementType_name = map[int32]string{
		0: "NONE",
		1: "EXTERNAL_ONLY",
		2: "ALL",
	}
	VirtualHost_TlsRequirementType_value = map[string]int32{
		"NONE":          0,
		"EXTERNAL_ONLY": 1,
		"ALL":           2,
	}
)

Enum value maps for VirtualHost_TlsRequirementType.

View Source 
var (
	RouteAction_ClusterNotFoundResponseCode_name = map[int32]string{
		0: "SERVICE_UNAVAILABLE",
		1: "NOT_FOUND",
	}
	RouteAction_ClusterNotFoundResponseCode_value = map[string]int32{
		"SERVICE_UNAVAILABLE": 0,
		"NOT_FOUND":           1,
	}
)

Enum value maps for RouteAction_ClusterNotFoundResponseCode.

View Source 
var (
	RouteAction_InternalRedirectAction_name = map[int32]string{
		0: "PASS_THROUGH_INTERNAL_REDIRECT",
		1: "HANDLE_INTERNAL_REDIRECT",
	}
	RouteAction_InternalRedirectAction_value = map[string]int32{
		"PASS_THROUGH_INTERNAL_REDIRECT": 0,
		"HANDLE_INTERNAL_REDIRECT":       1,
	}
)

Enum value maps for RouteAction_InternalRedirectAction.

View Source 
var (
	RetryPolicy_ResetHeaderFormat_name = map[int32]string{
		0: "SECONDS",
		1: "UNIX_TIMESTAMP",
	}
	RetryPolicy_ResetHeaderFormat_value = map[string]int32{
		"SECONDS":        0,
		"UNIX_TIMESTAMP": 1,
	}
)

Enum value maps for RetryPolicy_ResetHeaderFormat.

View Source 
var (
	RedirectAction_RedirectResponseCode_name = map[int32]string{
		0: "MOVED_PERMANENTLY",
		1: "FOUND",
		2: "SEE_OTHER",
		3: "TEMPORARY_REDIRECT",
		4: "PERMANENT_REDIRECT",
	}
	RedirectAction_RedirectResponseCode_value = map[string]int32{
		"MOVED_PERMANENTLY":  0,
		"FOUND":              1,
		"SEE_OTHER":          2,
		"TEMPORARY_REDIRECT": 3,
		"PERMANENT_REDIRECT": 4,
	}
)

Enum value maps for RedirectAction_RedirectResponseCode.

View Source 
var (
	RateLimit_Action_MetaData_Source_name = map[int32]string{
		0: "DYNAMIC",
		1: "ROUTE_ENTRY",
	}
	RateLimit_Action_MetaData_Source_value = map[string]int32{
		"DYNAMIC":     0,
		"ROUTE_ENTRY": 1,
	}
)

Enum value maps for RateLimit_Action_MetaData_Source.

View Source 
var File_envoy_config_route_v3_route_components_proto protoreflect.FileDescriptor
View Source 
var File_envoy_config_route_v3_route_proto protoreflect.FileDescriptor
View Source 
var File_envoy_config_route_v3_scoped_route_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type ClusterSpecifierPlugin added in v0.10.0 

type ClusterSpecifierPlugin struct {

	// The name of the plugin and its opaque configuration.
	Extension *v31.TypedExtensionConfig `protobuf:"bytes,1,opt,name=extension,proto3" json:"extension,omitempty"`
	// If is_optional is not set or is set to false and the plugin defined by this message is not a
	// supported type, the containing resource is NACKed. If is_optional is set to true, the resource
	// would not be NACKed for this reason. In this case, routes referencing this plugin's name would
	// not be treated as an illegal configuration, but would result in a failure if the route is
	// selected.
	IsOptional bool `protobuf:"varint,2,opt,name=is_optional,json=isOptional,proto3" json:"is_optional,omitempty"`
	// contains filtered or unexported fields
}

Configuration for a cluster specifier plugin.

func (*ClusterSpecifierPlugin) Descriptor deprecated added in v0.10.0 

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

Deprecated: Use ClusterSpecifierPlugin.ProtoReflect.Descriptor instead.

func (*ClusterSpecifierPlugin) GetExtension added in v0.10.0 

func (x *ClusterSpecifierPlugin) GetExtension() *v31.TypedExtensionConfig

func (*ClusterSpecifierPlugin) GetIsOptional added in v0.10.2 

func (x *ClusterSpecifierPlugin) GetIsOptional() bool

func (*ClusterSpecifierPlugin) ProtoMessage added in v0.10.0 

func (*ClusterSpecifierPlugin) ProtoMessage()

func (*ClusterSpecifierPlugin) ProtoReflect added in v0.10.0 

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

func (*ClusterSpecifierPlugin) Reset added in v0.10.0 

func (x *ClusterSpecifierPlugin) Reset()

func (*ClusterSpecifierPlugin) String added in v0.10.0 

func (x *ClusterSpecifierPlugin) String() string

func (*ClusterSpecifierPlugin) Validate added in v0.10.0 

func (m *ClusterSpecifierPlugin) Validate() error

Validate checks the field values on ClusterSpecifierPlugin 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 (*ClusterSpecifierPlugin) ValidateAll added in v0.10.0 

func (m *ClusterSpecifierPlugin) ValidateAll() error

ValidateAll checks the field values on ClusterSpecifierPlugin 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 ClusterSpecifierPluginMultiError, or nil if none found.

type ClusterSpecifierPluginMultiError added in v0.10.0 

type ClusterSpecifierPluginMultiError []error

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

func (ClusterSpecifierPluginMultiError) AllErrors added in v0.10.0 

func (m ClusterSpecifierPluginMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ClusterSpecifierPluginMultiError) Error added in v0.10.0 

func (m ClusterSpecifierPluginMultiError) Error() string

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

type ClusterSpecifierPluginValidationError added in v0.10.0 

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

ClusterSpecifierPluginValidationError is the validation error returned by ClusterSpecifierPlugin.Validate if the designated constraints aren't met.

func (ClusterSpecifierPluginValidationError) Cause added in v0.10.0 

func (e ClusterSpecifierPluginValidationError) Cause() error

Cause function returns cause value.

func (ClusterSpecifierPluginValidationError) Error added in v0.10.0 

func (e ClusterSpecifierPluginValidationError) Error() string

Error satisfies the builtin error interface

func (ClusterSpecifierPluginValidationError) ErrorName added in v0.10.0 

func (e ClusterSpecifierPluginValidationError) ErrorName() string

ErrorName returns error name.

func (ClusterSpecifierPluginValidationError) Field added in v0.10.0 

func (e ClusterSpecifierPluginValidationError) Field() string

Field function returns field value.

func (ClusterSpecifierPluginValidationError) Key added in v0.10.0 

func (e ClusterSpecifierPluginValidationError) Key() bool

Key function returns key value.

func (ClusterSpecifierPluginValidationError) Reason added in v0.10.0 

func (e ClusterSpecifierPluginValidationError) Reason() string

Reason function returns reason value.

type CorsPolicy 

type CorsPolicy struct {

	// Specifies string patterns that match allowed origins. An origin is allowed if any of the
	// string matchers match.
	AllowOriginStringMatch []*v32.StringMatcher `` /* 132-byte string literal not displayed */
	// Specifies the content for the *access-control-allow-methods* header.
	AllowMethods string `protobuf:"bytes,2,opt,name=allow_methods,json=allowMethods,proto3" json:"allow_methods,omitempty"`
	// Specifies the content for the *access-control-allow-headers* header.
	AllowHeaders string `protobuf:"bytes,3,opt,name=allow_headers,json=allowHeaders,proto3" json:"allow_headers,omitempty"`
	// Specifies the content for the *access-control-expose-headers* header.
	ExposeHeaders string `protobuf:"bytes,4,opt,name=expose_headers,json=exposeHeaders,proto3" json:"expose_headers,omitempty"`
	// Specifies the content for the *access-control-max-age* header.
	MaxAge string `protobuf:"bytes,5,opt,name=max_age,json=maxAge,proto3" json:"max_age,omitempty"`
	// Specifies whether the resource allows credentials.
	AllowCredentials *wrappers.BoolValue `protobuf:"bytes,6,opt,name=allow_credentials,json=allowCredentials,proto3" json:"allow_credentials,omitempty"`
	// Types that are assignable to EnabledSpecifier:
	//	*CorsPolicy_FilterEnabled
	EnabledSpecifier isCorsPolicy_EnabledSpecifier `protobuf_oneof:"enabled_specifier"`
	// Specifies the % of requests for which the CORS policies will be evaluated and tracked, but not
	// enforced.
	//
	// This field is intended to be used when “filter_enabled“ and “enabled“ are off. One of those
	// fields have to explicitly disable the filter in order for this setting to take effect.
	//
	// If :ref:`runtime_key <envoy_v3_api_field_config.core.v3.RuntimeFractionalPercent.runtime_key>` is specified,
	// Envoy will lookup the runtime key to get the percentage of requests for which it will evaluate
	// and track the request's *Origin* to determine if it's valid but will not enforce any policies.
	ShadowEnabled *v31.RuntimeFractionalPercent `protobuf:"bytes,10,opt,name=shadow_enabled,json=shadowEnabled,proto3" json:"shadow_enabled,omitempty"`
	// contains filtered or unexported fields
}

[#next-free-field: 12]

func (*CorsPolicy) Descriptor deprecated 

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

Deprecated: Use CorsPolicy.ProtoReflect.Descriptor instead.

func (*CorsPolicy) GetAllowCredentials 

func (x *CorsPolicy) GetAllowCredentials() *wrappers.BoolValue

func (*CorsPolicy) GetAllowHeaders 

func (x *CorsPolicy) GetAllowHeaders() string

func (*CorsPolicy) GetAllowMethods 

func (x *CorsPolicy) GetAllowMethods() string

func (*CorsPolicy) GetAllowOriginStringMatch 

func (x *CorsPolicy) GetAllowOriginStringMatch() []*v32.StringMatcher

func (*CorsPolicy) GetEnabledSpecifier 

func (m *CorsPolicy) GetEnabledSpecifier() isCorsPolicy_EnabledSpecifier

func (*CorsPolicy) GetExposeHeaders 

func (x *CorsPolicy) GetExposeHeaders() string

func (*CorsPolicy) GetFilterEnabled 

func (x *CorsPolicy) GetFilterEnabled() *v31.RuntimeFractionalPercent

func (*CorsPolicy) GetMaxAge 

func (x *CorsPolicy) GetMaxAge() string

func (*CorsPolicy) GetShadowEnabled 

func (x *CorsPolicy) GetShadowEnabled() *v31.RuntimeFractionalPercent

func (*CorsPolicy) ProtoMessage 

func (*CorsPolicy) ProtoMessage()

func (*CorsPolicy) ProtoReflect added in v0.9.6 

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

func (*CorsPolicy) Reset 

func (x *CorsPolicy) Reset()

func (*CorsPolicy) String 

func (x *CorsPolicy) String() string

func (*CorsPolicy) Validate 

func (m *CorsPolicy) Validate() error

Validate checks the field values on CorsPolicy 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 (*CorsPolicy) ValidateAll added in v0.10.0 

func (m *CorsPolicy) ValidateAll() error

ValidateAll checks the field values on CorsPolicy 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 CorsPolicyMultiError, or nil if none found.

type CorsPolicyMultiError added in v0.10.0 

type CorsPolicyMultiError []error

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

func (CorsPolicyMultiError) AllErrors added in v0.10.0 

func (m CorsPolicyMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (CorsPolicyMultiError) Error added in v0.10.0 

func (m CorsPolicyMultiError) Error() string

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

type CorsPolicyValidationError 

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

CorsPolicyValidationError is the validation error returned by CorsPolicy.Validate if the designated constraints aren't met.

func (CorsPolicyValidationError) Cause 

func (e CorsPolicyValidationError) Cause() error

Cause function returns cause value.

func (CorsPolicyValidationError) Error 

func (e CorsPolicyValidationError) Error() string

Error satisfies the builtin error interface

func (CorsPolicyValidationError) ErrorName 

func (e CorsPolicyValidationError) ErrorName() string

ErrorName returns error name.

func (CorsPolicyValidationError) Field 

func (e CorsPolicyValidationError) Field() string

Field function returns field value.

func (CorsPolicyValidationError) Key 

func (e CorsPolicyValidationError) Key() bool

Key function returns key value.

func (CorsPolicyValidationError) Reason 

func (e CorsPolicyValidationError) Reason() string

Reason function returns reason value.

type CorsPolicy_FilterEnabled 

type CorsPolicy_FilterEnabled struct {
	// Specifies the % of requests for which the CORS filter is enabled.
	//
	// If neither “enabled“, “filter_enabled“, nor “shadow_enabled“ are specified, the CORS
	// filter will be enabled for 100% of the requests.
	//
	// If :ref:`runtime_key <envoy_v3_api_field_config.core.v3.RuntimeFractionalPercent.runtime_key>` is
	// specified, Envoy will lookup the runtime key to get the percentage of requests to filter.
	FilterEnabled *v31.RuntimeFractionalPercent `protobuf:"bytes,9,opt,name=filter_enabled,json=filterEnabled,proto3,oneof"`
}

type Decorator 

type Decorator struct {

	// The operation name associated with the request matched to this route. If tracing is
	// enabled, this information will be used as the span name reported for this request.
	//
	// .. note::
	//
	//   For ingress (inbound) requests, or egress (outbound) responses, this value may be overridden
	//   by the :ref:`x-envoy-decorator-operation
	//   <config_http_filters_router_x-envoy-decorator-operation>` header.
	Operation string `protobuf:"bytes,1,opt,name=operation,proto3" json:"operation,omitempty"`
	// Whether the decorated details should be propagated to the other party. The default is true.
	Propagate *wrappers.BoolValue `protobuf:"bytes,2,opt,name=propagate,proto3" json:"propagate,omitempty"`
	// contains filtered or unexported fields
}

func (*Decorator) Descriptor deprecated 

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

Deprecated: Use Decorator.ProtoReflect.Descriptor instead.

func (*Decorator) GetOperation 

func (x *Decorator) GetOperation() string

func (*Decorator) GetPropagate 

func (x *Decorator) GetPropagate() *wrappers.BoolValue

func (*Decorator) ProtoMessage 

func (*Decorator) ProtoMessage()

func (*Decorator) ProtoReflect added in v0.9.6 

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

func (*Decorator) Reset 

func (x *Decorator) Reset()

func (*Decorator) String 

func (x *Decorator) String() string

func (*Decorator) Validate 

func (m *Decorator) Validate() error

Validate checks the field values on Decorator 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 (*Decorator) ValidateAll added in v0.10.0 

func (m *Decorator) ValidateAll() error

ValidateAll checks the field values on Decorator 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 DecoratorMultiError, or nil if none found.

type DecoratorMultiError added in v0.10.0 

type DecoratorMultiError []error

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

func (DecoratorMultiError) AllErrors added in v0.10.0 

func (m DecoratorMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (DecoratorMultiError) Error added in v0.10.0 

func (m DecoratorMultiError) Error() string

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

type DecoratorValidationError 

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

DecoratorValidationError is the validation error returned by Decorator.Validate if the designated constraints aren't met.

func (DecoratorValidationError) Cause 

func (e DecoratorValidationError) Cause() error

Cause function returns cause value.

func (DecoratorValidationError) Error 

func (e DecoratorValidationError) Error() string

Error satisfies the builtin error interface

func (DecoratorValidationError) ErrorName 

func (e DecoratorValidationError) ErrorName() string

ErrorName returns error name.

func (DecoratorValidationError) Field 

func (e DecoratorValidationError) Field() string

Field function returns field value.

func (DecoratorValidationError) Key 

func (e DecoratorValidationError) Key() bool

Key function returns key value.

func (DecoratorValidationError) Reason 

func (e DecoratorValidationError) Reason() string

Reason function returns reason value.

type DirectResponseAction 

type DirectResponseAction struct {

	// Specifies the HTTP response status to be returned.
	Status uint32 `protobuf:"varint,1,opt,name=status,proto3" json:"status,omitempty"`
	// Specifies the content of the response body. If this setting is omitted,
	// no body is included in the generated response.
	//
	// .. note::
	//
	//   Headers can be specified using *response_headers_to_add* in the enclosing
	//   :ref:`envoy_v3_api_msg_config.route.v3.Route`, :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` or
	//   :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost`.
	Body *v31.DataSource `protobuf:"bytes,2,opt,name=body,proto3" json:"body,omitempty"`
	// contains filtered or unexported fields
}

func (*DirectResponseAction) Descriptor deprecated 

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

Deprecated: Use DirectResponseAction.ProtoReflect.Descriptor instead.

func (*DirectResponseAction) GetBody 

func (x *DirectResponseAction) GetBody() *v31.DataSource

func (*DirectResponseAction) GetStatus 

func (x *DirectResponseAction) GetStatus() uint32

func (*DirectResponseAction) ProtoMessage 

func (*DirectResponseAction) ProtoMessage()

func (*DirectResponseAction) ProtoReflect added in v0.9.6 

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

func (*DirectResponseAction) Reset 

func (x *DirectResponseAction) Reset()

func (*DirectResponseAction) String 

func (x *DirectResponseAction) String() string

func (*DirectResponseAction) Validate 

func (m *DirectResponseAction) Validate() error

Validate checks the field values on DirectResponseAction 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 (*DirectResponseAction) ValidateAll added in v0.10.0 

func (m *DirectResponseAction) ValidateAll() error

ValidateAll checks the field values on DirectResponseAction 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 DirectResponseActionMultiError, or nil if none found.

type DirectResponseActionMultiError added in v0.10.0 

type DirectResponseActionMultiError []error

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

func (DirectResponseActionMultiError) AllErrors added in v0.10.0 

func (m DirectResponseActionMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (DirectResponseActionMultiError) Error added in v0.10.0 

func (m DirectResponseActionMultiError) Error() string

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

type DirectResponseActionValidationError 

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

DirectResponseActionValidationError is the validation error returned by DirectResponseAction.Validate if the designated constraints aren't met.

func (DirectResponseActionValidationError) Cause 

func (e DirectResponseActionValidationError) Cause() error

Cause function returns cause value.

func (DirectResponseActionValidationError) Error 

func (e DirectResponseActionValidationError) Error() string

Error satisfies the builtin error interface

func (DirectResponseActionValidationError) ErrorName 

func (e DirectResponseActionValidationError) ErrorName() string

ErrorName returns error name.

func (DirectResponseActionValidationError) Field 

func (e DirectResponseActionValidationError) Field() string

Field function returns field value.

func (DirectResponseActionValidationError) Key 

func (e DirectResponseActionValidationError) Key() bool

Key function returns key value.

func (DirectResponseActionValidationError) Reason 

func (e DirectResponseActionValidationError) Reason() string

Reason function returns reason value.

type FilterAction 

type FilterAction struct {
	Action *any.Any `protobuf:"bytes,1,opt,name=action,proto3" json:"action,omitempty"`
	// contains filtered or unexported fields
}

A filter-defined action type.

func (*FilterAction) Descriptor deprecated 

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

Deprecated: Use FilterAction.ProtoReflect.Descriptor instead.

func (*FilterAction) GetAction 

func (x *FilterAction) GetAction() *any.Any

func (*FilterAction) ProtoMessage 

func (*FilterAction) ProtoMessage()

func (*FilterAction) ProtoReflect added in v0.9.6 

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

func (*FilterAction) Reset 

func (x *FilterAction) Reset()

func (*FilterAction) String 

func (x *FilterAction) String() string

func (*FilterAction) Validate 

func (m *FilterAction) Validate() error

Validate checks the field values on FilterAction 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 (*FilterAction) ValidateAll added in v0.10.0 

func (m *FilterAction) ValidateAll() error

ValidateAll checks the field values on FilterAction 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 FilterActionMultiError, or nil if none found.

type FilterActionMultiError added in v0.10.0 

type FilterActionMultiError []error

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

func (FilterActionMultiError) AllErrors added in v0.10.0 

func (m FilterActionMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (FilterActionMultiError) Error added in v0.10.0 

func (m FilterActionMultiError) Error() string

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

type FilterActionValidationError 

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

FilterActionValidationError is the validation error returned by FilterAction.Validate if the designated constraints aren't met.

func (FilterActionValidationError) Cause 

func (e FilterActionValidationError) Cause() error

Cause function returns cause value.

func (FilterActionValidationError) Error 

func (e FilterActionValidationError) Error() string

Error satisfies the builtin error interface

func (FilterActionValidationError) ErrorName 

func (e FilterActionValidationError) ErrorName() string

ErrorName returns error name.

func (FilterActionValidationError) Field 

func (e FilterActionValidationError) Field() string

Field function returns field value.

func (FilterActionValidationError) Key 

func (e FilterActionValidationError) Key() bool

Key function returns key value.

func (FilterActionValidationError) Reason 

func (e FilterActionValidationError) Reason() string

Reason function returns reason value.

type FilterConfig added in v0.9.9 

type FilterConfig struct {

	// The filter config.
	Config *any.Any `protobuf:"bytes,1,opt,name=config,proto3" json:"config,omitempty"`
	// If true, the filter is optional, meaning that if the client does
	// not support the specified filter, it may ignore the map entry rather
	// than rejecting the config.
	IsOptional bool `protobuf:"varint,2,opt,name=is_optional,json=isOptional,proto3" json:"is_optional,omitempty"`
	// contains filtered or unexported fields
}

A simple wrapper for an HTTP filter config. This is intended to be used as a wrapper for the map value in :ref:`VirtualHost.typed_per_filter_config<envoy_v3_api_field_config.route.v3.VirtualHost.typed_per_filter_config>`, :ref:`Route.typed_per_filter_config<envoy_v3_api_field_config.route.v3.Route.typed_per_filter_config>`, or :ref:`WeightedCluster.ClusterWeight.typed_per_filter_config<envoy_v3_api_field_config.route.v3.WeightedCluster.ClusterWeight.typed_per_filter_config>` to add additional flags to the filter. [#not-implemented-hide:]

func (*FilterConfig) Descriptor deprecated added in v0.9.9 

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

Deprecated: Use FilterConfig.ProtoReflect.Descriptor instead.

func (*FilterConfig) GetConfig added in v0.9.9 

func (x *FilterConfig) GetConfig() *any.Any

func (*FilterConfig) GetIsOptional added in v0.9.9 

func (x *FilterConfig) GetIsOptional() bool

func (*FilterConfig) ProtoMessage added in v0.9.9 

func (*FilterConfig) ProtoMessage()

func (*FilterConfig) ProtoReflect added in v0.9.9 

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

func (*FilterConfig) Reset added in v0.9.9 

func (x *FilterConfig) Reset()

func (*FilterConfig) String added in v0.9.9 

func (x *FilterConfig) String() string

func (*FilterConfig) Validate added in v0.9.9 

func (m *FilterConfig) Validate() error

Validate checks the field values on FilterConfig 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 (*FilterConfig) ValidateAll added in v0.10.0 

func (m *FilterConfig) ValidateAll() error

ValidateAll checks the field values on FilterConfig 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 FilterConfigMultiError, or nil if none found.

type FilterConfigMultiError added in v0.10.0 

type FilterConfigMultiError []error

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

func (FilterConfigMultiError) AllErrors added in v0.10.0 

func (m FilterConfigMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (FilterConfigMultiError) Error added in v0.10.0 

func (m FilterConfigMultiError) Error() string

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

type FilterConfigValidationError added in v0.9.9 

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

FilterConfigValidationError is the validation error returned by FilterConfig.Validate if the designated constraints aren't met.

func (FilterConfigValidationError) Cause added in v0.9.9 

func (e FilterConfigValidationError) Cause() error

Cause function returns cause value.

func (FilterConfigValidationError) Error added in v0.9.9 

func (e FilterConfigValidationError) Error() string

Error satisfies the builtin error interface

func (FilterConfigValidationError) ErrorName added in v0.9.9 

func (e FilterConfigValidationError) ErrorName() string

ErrorName returns error name.

func (FilterConfigValidationError) Field added in v0.9.9 

func (e FilterConfigValidationError) Field() string

Field function returns field value.

func (FilterConfigValidationError) Key added in v0.9.9 

func (e FilterConfigValidationError) Key() bool

Key function returns key value.

func (FilterConfigValidationError) Reason added in v0.9.9 

func (e FilterConfigValidationError) Reason() string

Reason function returns reason value.

type HeaderMatcher 

type HeaderMatcher struct {

	// Specifies the name of the header in the request.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Specifies how the header match will be performed to route the request.
	//
	// Types that are assignable to HeaderMatchSpecifier:
	//	*HeaderMatcher_ExactMatch
	//	*HeaderMatcher_SafeRegexMatch
	//	*HeaderMatcher_RangeMatch
	//	*HeaderMatcher_PresentMatch
	//	*HeaderMatcher_PrefixMatch
	//	*HeaderMatcher_SuffixMatch
	//	*HeaderMatcher_ContainsMatch
	//	*HeaderMatcher_StringMatch
	HeaderMatchSpecifier isHeaderMatcher_HeaderMatchSpecifier `protobuf_oneof:"header_match_specifier"`
	// If specified, the match result will be inverted before checking. Defaults to false.
	//
	// Examples:
	//
	// * The regex “\d{3}“ does not match the value *1234*, so it will match when inverted.
	// * The range [-10,0) will match the value -1, so it will not match when inverted.
	InvertMatch bool `protobuf:"varint,8,opt,name=invert_match,json=invertMatch,proto3" json:"invert_match,omitempty"`
	// contains filtered or unexported fields
}

.. attention:: 

Internally, Envoy always uses the HTTP/2 *:authority* header to represent the HTTP/1 *Host*
header. Thus, if attempting to match on *Host*, match on *:authority* instead.

.. attention:: 

To route on HTTP method, use the special HTTP/2 *:method* header. This works for both
HTTP/1 and HTTP/2 as Envoy normalizes headers. E.g.,

.. code-block:: json

  {
    "name": ":method",
    "exact_match": "POST"
  }

.. attention:: 

 In the absence of any header match specifier, match will default to :ref:`present_match
 <envoy_v3_api_field_config.route.v3.HeaderMatcher.present_match>`. i.e, a request that has the :ref:`name
 <envoy_v3_api_field_config.route.v3.HeaderMatcher.name>` header will match, regardless of the header's
 value.

[#next-major-version: HeaderMatcher should be refactored to use StringMatcher.]

[#next-free-field: 14]

func (*HeaderMatcher) Descriptor deprecated 

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

Deprecated: Use HeaderMatcher.ProtoReflect.Descriptor instead.

func (*HeaderMatcher) GetContainsMatch deprecated added in v0.9.7 

func (x *HeaderMatcher) GetContainsMatch() string

Deprecated: Do not use.

func (*HeaderMatcher) GetExactMatch deprecated 

func (x *HeaderMatcher) GetExactMatch() string

Deprecated: Do not use.

func (*HeaderMatcher) GetHeaderMatchSpecifier 

func (m *HeaderMatcher) GetHeaderMatchSpecifier() isHeaderMatcher_HeaderMatchSpecifier

func (*HeaderMatcher) GetInvertMatch 

func (x *HeaderMatcher) GetInvertMatch() bool

func (*HeaderMatcher) GetName 

func (x *HeaderMatcher) GetName() string

func (*HeaderMatcher) GetPrefixMatch deprecated 

func (x *HeaderMatcher) GetPrefixMatch() string

Deprecated: Do not use.

func (*HeaderMatcher) GetPresentMatch 

func (x *HeaderMatcher) GetPresentMatch() bool

func (*HeaderMatcher) GetRangeMatch 

func (x *HeaderMatcher) GetRangeMatch() *v33.Int64Range

func (*HeaderMatcher) GetSafeRegexMatch deprecated 

func (x *HeaderMatcher) GetSafeRegexMatch() *v32.RegexMatcher

Deprecated: Do not use.

func (*HeaderMatcher) GetStringMatch added in v0.10.0 

func (x *HeaderMatcher) GetStringMatch() *v32.StringMatcher

func (*HeaderMatcher) GetSuffixMatch deprecated 

func (x *HeaderMatcher) GetSuffixMatch() string

Deprecated: Do not use.

func (*HeaderMatcher) ProtoMessage 

func (*HeaderMatcher) ProtoMessage()

func (*HeaderMatcher) ProtoReflect added in v0.9.6 

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

func (*HeaderMatcher) Reset 

func (x *HeaderMatcher) Reset()

func (*HeaderMatcher) String 

func (x *HeaderMatcher) String() string

func (*HeaderMatcher) Validate 

func (m *HeaderMatcher) Validate() error

Validate checks the field values on HeaderMatcher 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 (*HeaderMatcher) ValidateAll added in v0.10.0 

func (m *HeaderMatcher) ValidateAll() error

ValidateAll checks the field values on HeaderMatcher 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 HeaderMatcherMultiError, or nil if none found.

type HeaderMatcherMultiError added in v0.10.0 

type HeaderMatcherMultiError []error

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

func (HeaderMatcherMultiError) AllErrors added in v0.10.0 

func (m HeaderMatcherMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (HeaderMatcherMultiError) Error added in v0.10.0 

func (m HeaderMatcherMultiError) Error() string

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

type HeaderMatcherValidationError 

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

HeaderMatcherValidationError is the validation error returned by HeaderMatcher.Validate if the designated constraints aren't met.

func (HeaderMatcherValidationError) Cause 

func (e HeaderMatcherValidationError) Cause() error

Cause function returns cause value.

func (HeaderMatcherValidationError) Error 

func (e HeaderMatcherValidationError) Error() string

Error satisfies the builtin error interface

func (HeaderMatcherValidationError) ErrorName 

func (e HeaderMatcherValidationError) ErrorName() string

ErrorName returns error name.

func (HeaderMatcherValidationError) Field 

func (e HeaderMatcherValidationError) Field() string

Field function returns field value.

func (HeaderMatcherValidationError) Key 

func (e HeaderMatcherValidationError) Key() bool

Key function returns key value.

func (HeaderMatcherValidationError) Reason 

func (e HeaderMatcherValidationError) Reason() string

Reason function returns reason value.

type HeaderMatcher_ContainsMatch added in v0.9.7 

type HeaderMatcher_ContainsMatch struct {
	// If specified, header match will be performed based on whether the header value contains
	// the given value or not.
	// Note: empty contains match is not allowed, please use present_match instead.
	// This field is deprecated. Please use :ref:`string_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.string_match>`.
	//
	// Examples:
	//
	// * The value *abcd* matches the value *xyzabcdpqr*, but not for *xyzbcdpqr*.
	//
	// Deprecated: Do not use.
	ContainsMatch string `protobuf:"bytes,12,opt,name=contains_match,json=containsMatch,proto3,oneof"`
}

type HeaderMatcher_ExactMatch 

type HeaderMatcher_ExactMatch struct {
	// If specified, header match will be performed based on the value of the header.
	// This field is deprecated. Please use :ref:`string_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.string_match>`.
	//
	// Deprecated: Do not use.
	ExactMatch string `protobuf:"bytes,4,opt,name=exact_match,json=exactMatch,proto3,oneof"`
}

type HeaderMatcher_PrefixMatch 

type HeaderMatcher_PrefixMatch struct {
	// If specified, header match will be performed based on the prefix of the header value.
	// Note: empty prefix is not allowed, please use present_match instead.
	// This field is deprecated. Please use :ref:`string_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.string_match>`.
	//
	// Examples:
	//
	// * The prefix *abcd* matches the value *abcdxyz*, but not for *abcxyz*.
	//
	// Deprecated: Do not use.
	PrefixMatch string `protobuf:"bytes,9,opt,name=prefix_match,json=prefixMatch,proto3,oneof"`
}

type HeaderMatcher_PresentMatch 

type HeaderMatcher_PresentMatch struct {
	// If specified as true, header match will be performed based on whether the header is in the
	// request. If specified as false, header match will be performed based on whether the header is absent.
	PresentMatch bool `protobuf:"varint,7,opt,name=present_match,json=presentMatch,proto3,oneof"`
}

type HeaderMatcher_RangeMatch 

type HeaderMatcher_RangeMatch struct {
	// If specified, header match will be performed based on range.
	// The rule will match if the request header value is within this range.
	// The entire request header value must represent an integer in base 10 notation: consisting of
	// an optional plus or minus sign followed by a sequence of digits. The rule will not match if
	// the header value does not represent an integer. Match will fail for empty values, floating
	// point numbers or if only a subsequence of the header value is an integer.
	//
	// Examples:
	//
	// * For range [-10,0), route will match for header value -1, but not for 0, "somestring", 10.9,
	//   "-1somestring"
	RangeMatch *v33.Int64Range `protobuf:"bytes,6,opt,name=range_match,json=rangeMatch,proto3,oneof"`
}

type HeaderMatcher_SafeRegexMatch 

type HeaderMatcher_SafeRegexMatch struct {
	// If specified, this regex string is a regular expression rule which implies the entire request
	// header value must match the regex. The rule will not match if only a subsequence of the
	// request header value matches the regex.
	// This field is deprecated. Please use :ref:`string_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.string_match>`.
	//
	// Deprecated: Do not use.
	SafeRegexMatch *v32.RegexMatcher `protobuf:"bytes,11,opt,name=safe_regex_match,json=safeRegexMatch,proto3,oneof"`
}

type HeaderMatcher_StringMatch added in v0.10.0 

type HeaderMatcher_StringMatch struct {
	// If specified, header match will be performed based on the string match of the header value.
	StringMatch *v32.StringMatcher `protobuf:"bytes,13,opt,name=string_match,json=stringMatch,proto3,oneof"`
}

type HeaderMatcher_SuffixMatch 

type HeaderMatcher_SuffixMatch struct {
	// If specified, header match will be performed based on the suffix of the header value.
	// Note: empty suffix is not allowed, please use present_match instead.
	// This field is deprecated. Please use :ref:`string_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.string_match>`.
	//
	// Examples:
	//
	// * The suffix *abcd* matches the value *xyzabcd*, but not for *xyzbcd*.
	//
	// Deprecated: Do not use.
	SuffixMatch string `protobuf:"bytes,10,opt,name=suffix_match,json=suffixMatch,proto3,oneof"`
}

type HedgePolicy 

type HedgePolicy struct {

	// Specifies the number of initial requests that should be sent upstream.
	// Must be at least 1.
	// Defaults to 1.
	// [#not-implemented-hide:]
	InitialRequests *wrappers.UInt32Value `protobuf:"bytes,1,opt,name=initial_requests,json=initialRequests,proto3" json:"initial_requests,omitempty"`
	// Specifies a probability that an additional upstream request should be sent
	// on top of what is specified by initial_requests.
	// Defaults to 0.
	// [#not-implemented-hide:]
	AdditionalRequestChance *v33.FractionalPercent `` /* 132-byte string literal not displayed */
	// Indicates that a hedged request should be sent when the per-try timeout is hit.
	// This means that a retry will be issued without resetting the original request, leaving multiple upstream requests in flight.
	// The first request to complete successfully will be the one returned to the caller.
	//
	// * At any time, a successful response (i.e. not triggering any of the retry-on conditions) would be returned to the client.
	// * Before per-try timeout, an error response (per retry-on conditions) would be retried immediately or returned ot the client
	//   if there are no more retries left.
	// * After per-try timeout, an error response would be discarded, as a retry in the form of a hedged request is already in progress.
	//
	// Note: For this to have effect, you must have a :ref:`RetryPolicy <envoy_v3_api_msg_config.route.v3.RetryPolicy>` that retries at least
	// one error code and specifies a maximum number of retries.
	//
	// Defaults to false.
	HedgeOnPerTryTimeout bool `` /* 128-byte string literal not displayed */
	// contains filtered or unexported fields
}

HTTP request hedging :ref:`architecture overview <arch_overview_http_routing_hedging>`.

func (*HedgePolicy) Descriptor deprecated 

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

Deprecated: Use HedgePolicy.ProtoReflect.Descriptor instead.

func (*HedgePolicy) GetAdditionalRequestChance 

func (x *HedgePolicy) GetAdditionalRequestChance() *v33.FractionalPercent

func (*HedgePolicy) GetHedgeOnPerTryTimeout 

func (x *HedgePolicy) GetHedgeOnPerTryTimeout() bool

func (*HedgePolicy) GetInitialRequests 

func (x *HedgePolicy) GetInitialRequests() *wrappers.UInt32Value

func (*HedgePolicy) ProtoMessage 

func (*HedgePolicy) ProtoMessage()

func (*HedgePolicy) ProtoReflect added in v0.9.6 

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

func (*HedgePolicy) Reset 

func (x *HedgePolicy) Reset()

func (*HedgePolicy) String 

func (x *HedgePolicy) String() string

func (*HedgePolicy) Validate 

func (m *HedgePolicy) Validate() error

Validate checks the field values on HedgePolicy 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 (*HedgePolicy) ValidateAll added in v0.10.0 

func (m *HedgePolicy) ValidateAll() error

ValidateAll checks the field values on HedgePolicy 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 HedgePolicyMultiError, or nil if none found.

type HedgePolicyMultiError added in v0.10.0 

type HedgePolicyMultiError []error

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

func (HedgePolicyMultiError) AllErrors added in v0.10.0 

func (m HedgePolicyMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (HedgePolicyMultiError) Error added in v0.10.0 

func (m HedgePolicyMultiError) Error() string

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

type HedgePolicyValidationError 

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

HedgePolicyValidationError is the validation error returned by HedgePolicy.Validate if the designated constraints aren't met.

func (HedgePolicyValidationError) Cause 

func (e HedgePolicyValidationError) Cause() error

Cause function returns cause value.

func (HedgePolicyValidationError) Error 

func (e HedgePolicyValidationError) Error() string

Error satisfies the builtin error interface

func (HedgePolicyValidationError) ErrorName 

func (e HedgePolicyValidationError) ErrorName() string

ErrorName returns error name.

func (HedgePolicyValidationError) Field 

func (e HedgePolicyValidationError) Field() string

Field function returns field value.

func (HedgePolicyValidationError) Key 

func (e HedgePolicyValidationError) Key() bool

Key function returns key value.

func (HedgePolicyValidationError) Reason 

func (e HedgePolicyValidationError) Reason() string

Reason function returns reason value.

type InternalRedirectPolicy added in v0.9.6 

type InternalRedirectPolicy struct {

	// An internal redirect is not handled, unless the number of previous internal redirects that a
	// downstream request has encountered is lower than this value.
	// In the case where a downstream request is bounced among multiple routes by internal redirect,
	// the first route that hits this threshold, or does not set :ref:`internal_redirect_policy
	// <envoy_v3_api_field_config.route.v3.RouteAction.internal_redirect_policy>`
	// will pass the redirect back to downstream.
	//
	// If not specified, at most one redirect will be followed.
	MaxInternalRedirects *wrappers.UInt32Value `protobuf:"bytes,1,opt,name=max_internal_redirects,json=maxInternalRedirects,proto3" json:"max_internal_redirects,omitempty"`
	// Defines what upstream response codes are allowed to trigger internal redirect. If unspecified,
	// only 302 will be treated as internal redirect.
	// Only 301, 302, 303, 307 and 308 are valid values. Any other codes will be ignored.
	RedirectResponseCodes []uint32 `` /* 134-byte string literal not displayed */
	// Specifies a list of predicates that are queried when an upstream response is deemed
	// to trigger an internal redirect by all other criteria. Any predicate in the list can reject
	// the redirect, causing the response to be proxied to downstream.
	// [#extension-category: envoy.internal_redirect_predicates]
	Predicates []*v31.TypedExtensionConfig `protobuf:"bytes,3,rep,name=predicates,proto3" json:"predicates,omitempty"`
	// Allow internal redirect to follow a target URI with a different scheme than the value of
	// x-forwarded-proto. The default is false.
	AllowCrossSchemeRedirect bool `` /* 138-byte string literal not displayed */
	// contains filtered or unexported fields
}

HTTP Internal Redirect :ref:`architecture overview <arch_overview_internal_redirects>`.

func (*InternalRedirectPolicy) Descriptor deprecated added in v0.9.6 

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

Deprecated: Use InternalRedirectPolicy.ProtoReflect.Descriptor instead.

func (*InternalRedirectPolicy) GetAllowCrossSchemeRedirect added in v0.9.6 

func (x *InternalRedirectPolicy) GetAllowCrossSchemeRedirect() bool

func (*InternalRedirectPolicy) GetMaxInternalRedirects added in v0.9.6 

func (x *InternalRedirectPolicy) GetMaxInternalRedirects() *wrappers.UInt32Value

func (*InternalRedirectPolicy) GetPredicates added in v0.9.6 

func (x *InternalRedirectPolicy) GetPredicates() []*v31.TypedExtensionConfig

func (*InternalRedirectPolicy) GetRedirectResponseCodes added in v0.9.6 

func (x *InternalRedirectPolicy) GetRedirectResponseCodes() []uint32

func (*InternalRedirectPolicy) ProtoMessage added in v0.9.6 

func (*InternalRedirectPolicy) ProtoMessage()

func (*InternalRedirectPolicy) ProtoReflect added in v0.9.6 

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

func (*InternalRedirectPolicy) Reset added in v0.9.6 

func (x *InternalRedirectPolicy) Reset()

func (*InternalRedirectPolicy) String added in v0.9.6 

func (x *InternalRedirectPolicy) String() string

func (*InternalRedirectPolicy) Validate added in v0.9.6 

func (m *InternalRedirectPolicy) Validate() error

Validate checks the field values on InternalRedirectPolicy 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 (*InternalRedirectPolicy) ValidateAll added in v0.10.0 

func (m *InternalRedirectPolicy) ValidateAll() error

ValidateAll checks the field values on InternalRedirectPolicy 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 InternalRedirectPolicyMultiError, or nil if none found.

type InternalRedirectPolicyMultiError added in v0.10.0 

type InternalRedirectPolicyMultiError []error

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

func (InternalRedirectPolicyMultiError) AllErrors added in v0.10.0 

func (m InternalRedirectPolicyMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (InternalRedirectPolicyMultiError) Error added in v0.10.0 

func (m InternalRedirectPolicyMultiError) Error() string

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

type InternalRedirectPolicyValidationError added in v0.9.6 

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

InternalRedirectPolicyValidationError is the validation error returned by InternalRedirectPolicy.Validate if the designated constraints aren't met.

func (InternalRedirectPolicyValidationError) Cause added in v0.9.6 

func (e InternalRedirectPolicyValidationError) Cause() error

Cause function returns cause value.

func (InternalRedirectPolicyValidationError) Error added in v0.9.6 

func (e InternalRedirectPolicyValidationError) Error() string

Error satisfies the builtin error interface

func (InternalRedirectPolicyValidationError) ErrorName added in v0.9.6 

func (e InternalRedirectPolicyValidationError) ErrorName() string

ErrorName returns error name.

func (InternalRedirectPolicyValidationError) Field added in v0.9.6 

func (e InternalRedirectPolicyValidationError) Field() string

Field function returns field value.

func (InternalRedirectPolicyValidationError) Key added in v0.9.6 

func (e InternalRedirectPolicyValidationError) Key() bool

Key function returns key value.

func (InternalRedirectPolicyValidationError) Reason added in v0.9.6 

func (e InternalRedirectPolicyValidationError) Reason() string

Reason function returns reason value.

type NonForwardingAction added in v0.9.9 

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

[#not-implemented-hide:]

func (*NonForwardingAction) Descriptor deprecated added in v0.9.9 

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

Deprecated: Use NonForwardingAction.ProtoReflect.Descriptor instead.

func (*NonForwardingAction) ProtoMessage added in v0.9.9 

func (*NonForwardingAction) ProtoMessage()

func (*NonForwardingAction) ProtoReflect added in v0.9.9 

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

func (*NonForwardingAction) Reset added in v0.9.9 

func (x *NonForwardingAction) Reset()

func (*NonForwardingAction) String added in v0.9.9 

func (x *NonForwardingAction) String() string

func (*NonForwardingAction) Validate added in v0.9.9 

func (m *NonForwardingAction) Validate() error

Validate checks the field values on NonForwardingAction 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 (*NonForwardingAction) ValidateAll added in v0.10.0 

func (m *NonForwardingAction) ValidateAll() error

ValidateAll checks the field values on NonForwardingAction 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 NonForwardingActionMultiError, or nil if none found.

type NonForwardingActionMultiError added in v0.10.0 

type NonForwardingActionMultiError []error

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

func (NonForwardingActionMultiError) AllErrors added in v0.10.0 

func (m NonForwardingActionMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (NonForwardingActionMultiError) Error added in v0.10.0 

func (m NonForwardingActionMultiError) Error() string

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

type NonForwardingActionValidationError added in v0.9.9 

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

NonForwardingActionValidationError is the validation error returned by NonForwardingAction.Validate if the designated constraints aren't met.

func (NonForwardingActionValidationError) Cause added in v0.9.9 

func (e NonForwardingActionValidationError) Cause() error

Cause function returns cause value.

func (NonForwardingActionValidationError) Error added in v0.9.9 

func (e NonForwardingActionValidationError) Error() string

Error satisfies the builtin error interface

func (NonForwardingActionValidationError) ErrorName added in v0.9.9 

func (e NonForwardingActionValidationError) ErrorName() string

ErrorName returns error name.

func (NonForwardingActionValidationError) Field added in v0.9.9 

func (e NonForwardingActionValidationError) Field() string

Field function returns field value.

func (NonForwardingActionValidationError) Key added in v0.9.9 

func (e NonForwardingActionValidationError) Key() bool

Key function returns key value.

func (NonForwardingActionValidationError) Reason added in v0.9.9 

func (e NonForwardingActionValidationError) Reason() string

Reason function returns reason value.

type QueryParameterMatcher 

type QueryParameterMatcher struct {

	// Specifies the name of a key that must be present in the requested
	// *path*'s query string.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Types that are assignable to QueryParameterMatchSpecifier:
	//	*QueryParameterMatcher_StringMatch
	//	*QueryParameterMatcher_PresentMatch
	QueryParameterMatchSpecifier isQueryParameterMatcher_QueryParameterMatchSpecifier `protobuf_oneof:"query_parameter_match_specifier"`
	// contains filtered or unexported fields
}

Query parameter matching treats the query string of a request's :path header as an ampersand-separated list of keys and/or key=value elements. [#next-free-field: 7]

func (*QueryParameterMatcher) Descriptor deprecated 

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

Deprecated: Use QueryParameterMatcher.ProtoReflect.Descriptor instead.

func (*QueryParameterMatcher) GetName 

func (x *QueryParameterMatcher) GetName() string

func (*QueryParameterMatcher) GetPresentMatch 

func (x *QueryParameterMatcher) GetPresentMatch() bool

func (*QueryParameterMatcher) GetQueryParameterMatchSpecifier 

func (m *QueryParameterMatcher) GetQueryParameterMatchSpecifier() isQueryParameterMatcher_QueryParameterMatchSpecifier

func (*QueryParameterMatcher) GetStringMatch 

func (x *QueryParameterMatcher) GetStringMatch() *v32.StringMatcher

func (*QueryParameterMatcher) ProtoMessage 

func (*QueryParameterMatcher) ProtoMessage()

func (*QueryParameterMatcher) ProtoReflect added in v0.9.6 

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

func (*QueryParameterMatcher) Reset 

func (x *QueryParameterMatcher) Reset()

func (*QueryParameterMatcher) String 

func (x *QueryParameterMatcher) String() string

func (*QueryParameterMatcher) Validate 

func (m *QueryParameterMatcher) Validate() error

Validate checks the field values on QueryParameterMatcher 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 (*QueryParameterMatcher) ValidateAll added in v0.10.0 

func (m *QueryParameterMatcher) ValidateAll() error

ValidateAll checks the field values on QueryParameterMatcher 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 QueryParameterMatcherMultiError, or nil if none found.

type QueryParameterMatcherMultiError added in v0.10.0 

type QueryParameterMatcherMultiError []error

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

func (QueryParameterMatcherMultiError) AllErrors added in v0.10.0 

func (m QueryParameterMatcherMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (QueryParameterMatcherMultiError) Error added in v0.10.0 

func (m QueryParameterMatcherMultiError) Error() string

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

type QueryParameterMatcherValidationError 

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

QueryParameterMatcherValidationError is the validation error returned by QueryParameterMatcher.Validate if the designated constraints aren't met.

func (QueryParameterMatcherValidationError) Cause 

func (e QueryParameterMatcherValidationError) Cause() error

Cause function returns cause value.

func (QueryParameterMatcherValidationError) Error 

func (e QueryParameterMatcherValidationError) Error() string

Error satisfies the builtin error interface

func (QueryParameterMatcherValidationError) ErrorName 

func (e QueryParameterMatcherValidationError) ErrorName() string

ErrorName returns error name.

func (QueryParameterMatcherValidationError) Field 

func (e QueryParameterMatcherValidationError) Field() string

Field function returns field value.

func (QueryParameterMatcherValidationError) Key 

func (e QueryParameterMatcherValidationError) Key() bool

Key function returns key value.

func (QueryParameterMatcherValidationError) Reason 

func (e QueryParameterMatcherValidationError) Reason() string

Reason function returns reason value.

type QueryParameterMatcher_PresentMatch 

type QueryParameterMatcher_PresentMatch struct {
	// Specifies whether a query parameter should be present.
	PresentMatch bool `protobuf:"varint,6,opt,name=present_match,json=presentMatch,proto3,oneof"`
}

type QueryParameterMatcher_StringMatch 

type QueryParameterMatcher_StringMatch struct {
	// Specifies whether a query parameter value should match against a string.
	StringMatch *v32.StringMatcher `protobuf:"bytes,5,opt,name=string_match,json=stringMatch,proto3,oneof"`
}

type RateLimit 

type RateLimit 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 *wrappers.UInt32Value `protobuf:"bytes,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 []*RateLimit_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 *RateLimit_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>`.

func (*RateLimit) Descriptor deprecated 

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

Deprecated: Use RateLimit.ProtoReflect.Descriptor instead.

func (*RateLimit) GetActions 

func (x *RateLimit) GetActions() []*RateLimit_Action

func (*RateLimit) GetDisableKey 

func (x *RateLimit) GetDisableKey() string

func (*RateLimit) GetLimit added in v0.9.6 

func (x *RateLimit) GetLimit() *RateLimit_Override

func (*RateLimit) GetStage 

func (x *RateLimit) GetStage() *wrappers.UInt32Value

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 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 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_Action 

type RateLimit_Action struct {

	// Types that are assignable to ActionSpecifier:
	//	*RateLimit_Action_SourceCluster_
	//	*RateLimit_Action_DestinationCluster_
	//	*RateLimit_Action_RequestHeaders_
	//	*RateLimit_Action_RemoteAddress_
	//	*RateLimit_Action_GenericKey_
	//	*RateLimit_Action_HeaderValueMatch_
	//	*RateLimit_Action_DynamicMetadata
	//	*RateLimit_Action_Metadata
	//	*RateLimit_Action_Extension
	//	*RateLimit_Action_MaskedRemoteAddress_
	ActionSpecifier isRateLimit_Action_ActionSpecifier `protobuf_oneof:"action_specifier"`
	// contains filtered or unexported fields
}

[#next-free-field: 11]

func (*RateLimit_Action) Descriptor deprecated 

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

Deprecated: Use RateLimit_Action.ProtoReflect.Descriptor instead.

func (*RateLimit_Action) GetActionSpecifier 

func (m *RateLimit_Action) GetActionSpecifier() isRateLimit_Action_ActionSpecifier

func (*RateLimit_Action) GetDestinationCluster 

func (x *RateLimit_Action) GetDestinationCluster() *RateLimit_Action_DestinationCluster

func (*RateLimit_Action) GetDynamicMetadata deprecated added in v0.9.6 

func (x *RateLimit_Action) GetDynamicMetadata() *RateLimit_Action_DynamicMetaData

Deprecated: Do not use.

func (*RateLimit_Action) GetExtension added in v0.9.9 

func (x *RateLimit_Action) GetExtension() *v31.TypedExtensionConfig

func (*RateLimit_Action) GetGenericKey 

func (x *RateLimit_Action) GetGenericKey() *RateLimit_Action_GenericKey

func (*RateLimit_Action) GetHeaderValueMatch 

func (x *RateLimit_Action) GetHeaderValueMatch() *RateLimit_Action_HeaderValueMatch

func (*RateLimit_Action) GetMaskedRemoteAddress added in v0.10.2 

func (x *RateLimit_Action) GetMaskedRemoteAddress() *RateLimit_Action_MaskedRemoteAddress

func (*RateLimit_Action) GetMetadata added in v0.9.8 

func (x *RateLimit_Action) GetMetadata() *RateLimit_Action_MetaData

func (*RateLimit_Action) GetRemoteAddress 

func (x *RateLimit_Action) GetRemoteAddress() *RateLimit_Action_RemoteAddress

func (*RateLimit_Action) GetRequestHeaders 

func (x *RateLimit_Action) GetRequestHeaders() *RateLimit_Action_RequestHeaders

func (*RateLimit_Action) GetSourceCluster 

func (x *RateLimit_Action) GetSourceCluster() *RateLimit_Action_SourceCluster

func (*RateLimit_Action) ProtoMessage 

func (*RateLimit_Action) ProtoMessage()

func (*RateLimit_Action) ProtoReflect added in v0.9.6 

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

func (*RateLimit_Action) Reset 

func (x *RateLimit_Action) Reset()

func (*RateLimit_Action) String 

func (x *RateLimit_Action) String() string

func (*RateLimit_Action) Validate 

func (m *RateLimit_Action) Validate() error

Validate checks the field values on RateLimit_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 (*RateLimit_Action) ValidateAll added in v0.10.0 

func (m *RateLimit_Action) ValidateAll() error

ValidateAll checks the field values on RateLimit_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 RateLimit_ActionMultiError, or nil if none found.

type RateLimit_ActionMultiError added in v0.10.0 

type RateLimit_ActionMultiError []error

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

func (RateLimit_ActionMultiError) AllErrors added in v0.10.0 

func (m RateLimit_ActionMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (RateLimit_ActionMultiError) Error added in v0.10.0 

func (m RateLimit_ActionMultiError) Error() string

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

type RateLimit_ActionValidationError 

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

RateLimit_ActionValidationError is the validation error returned by RateLimit_Action.Validate if the designated constraints aren't met.

func (RateLimit_ActionValidationError) Cause 

func (e RateLimit_ActionValidationError) Cause() error

Cause function returns cause value.

func (RateLimit_ActionValidationError) Error 

func (e RateLimit_ActionValidationError) Error() string

Error satisfies the builtin error interface

func (RateLimit_ActionValidationError) ErrorName 

func (e RateLimit_ActionValidationError) ErrorName() string

ErrorName returns error name.

func (RateLimit_ActionValidationError) Field 

func (e RateLimit_ActionValidationError) Field() string

Field function returns field value.

func (RateLimit_ActionValidationError) Key 

func (e RateLimit_ActionValidationError) Key() bool

Key function returns key value.

func (RateLimit_ActionValidationError) Reason 

func (e RateLimit_ActionValidationError) Reason() string

Reason function returns reason value.

type RateLimit_Action_DestinationCluster 

type RateLimit_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 (*RateLimit_Action_DestinationCluster) Descriptor deprecated 

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

Deprecated: Use RateLimit_Action_DestinationCluster.ProtoReflect.Descriptor instead.

func (*RateLimit_Action_DestinationCluster) ProtoMessage 

func (*RateLimit_Action_DestinationCluster) ProtoMessage()

func (*RateLimit_Action_DestinationCluster) ProtoReflect added in v0.9.6 

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

func (*RateLimit_Action_DestinationCluster) Reset 

func (x *RateLimit_Action_DestinationCluster) Reset()

func (*RateLimit_Action_DestinationCluster) String 

func (x *RateLimit_Action_DestinationCluster) String() string

func (*RateLimit_Action_DestinationCluster) Validate 

func (m *RateLimit_Action_DestinationCluster) Validate() error

Validate checks the field values on RateLimit_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 (*RateLimit_Action_DestinationCluster) ValidateAll added in v0.10.0 

func (m *RateLimit_Action_DestinationCluster) ValidateAll() error

ValidateAll checks the field values on RateLimit_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 RateLimit_Action_DestinationClusterMultiError, or nil if none found.

type RateLimit_Action_DestinationClusterMultiError added in v0.10.0 

type RateLimit_Action_DestinationClusterMultiError []error

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

func (RateLimit_Action_DestinationClusterMultiError) AllErrors added in v0.10.0 

func (m RateLimit_Action_DestinationClusterMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (RateLimit_Action_DestinationClusterMultiError) Error added in v0.10.0 

func (m RateLimit_Action_DestinationClusterMultiError) Error() string

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

type RateLimit_Action_DestinationClusterValidationError 

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

RateLimit_Action_DestinationClusterValidationError is the validation error returned by RateLimit_Action_DestinationCluster.Validate if the designated constraints aren't met.

func (RateLimit_Action_DestinationClusterValidationError) Cause 

func (e RateLimit_Action_DestinationClusterValidationError) Cause() error

Cause function returns cause value.

func (RateLimit_Action_DestinationClusterValidationError) Error 

func (e RateLimit_Action_DestinationClusterValidationError) Error() string

Error satisfies the builtin error interface

func (RateLimit_Action_DestinationClusterValidationError) ErrorName 

func (e RateLimit_Action_DestinationClusterValidationError) ErrorName() string

ErrorName returns error name.

func (RateLimit_Action_DestinationClusterValidationError) Field 

func (e RateLimit_Action_DestinationClusterValidationError) Field() string

Field function returns field value.

func (RateLimit_Action_DestinationClusterValidationError) Key 

func (e RateLimit_Action_DestinationClusterValidationError) Key() bool

Key function returns key value.

func (RateLimit_Action_DestinationClusterValidationError) Reason 

func (e RateLimit_Action_DestinationClusterValidationError) Reason() string

Reason function returns reason value.

type RateLimit_Action_DestinationCluster_ 

type RateLimit_Action_DestinationCluster_ struct {
	// Rate limit on destination cluster.
	DestinationCluster *RateLimit_Action_DestinationCluster `protobuf:"bytes,2,opt,name=destination_cluster,json=destinationCluster,proto3,oneof"`
}

type RateLimit_Action_DynamicMetaData added in v0.9.6 

type RateLimit_Action_DynamicMetaData 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 dynamic metadata is of type string.
	MetadataKey *v35.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 no descriptor is generated.
	DefaultValue string `protobuf:"bytes,3,opt,name=default_value,json=defaultValue,proto3" json:"default_value,omitempty"`
	// contains filtered or unexported fields
}

The following descriptor entry is appended when the :ref:`dynamic metadata <well_known_dynamic_metadata>` contains a key value:

.. code-block:: cpp 

("<descriptor_key>", "<value_queried_from_dynamic_metadata>")

.. attention:: 

This action has been deprecated in favor of the :ref:`metadata <envoy_v3_api_msg_config.route.v3.RateLimit.Action.MetaData>` action

func (*RateLimit_Action_DynamicMetaData) Descriptor deprecated added in v0.9.6 

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

Deprecated: Use RateLimit_Action_DynamicMetaData.ProtoReflect.Descriptor instead.

func (*RateLimit_Action_DynamicMetaData) GetDefaultValue added in v0.9.7 

func (x *RateLimit_Action_DynamicMetaData) GetDefaultValue() string

func (*RateLimit_Action_DynamicMetaData) GetDescriptorKey added in v0.9.6 

func (x *RateLimit_Action_DynamicMetaData) GetDescriptorKey() string

func (*RateLimit_Action_DynamicMetaData) GetMetadataKey added in v0.9.6 

func (x *RateLimit_Action_DynamicMetaData) GetMetadataKey() *v35.MetadataKey

func (*RateLimit_Action_DynamicMetaData) ProtoMessage added in v0.9.6 

func (*RateLimit_Action_DynamicMetaData) ProtoMessage()

func (*RateLimit_Action_DynamicMetaData) ProtoReflect added in v0.9.6 

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

func (*RateLimit_Action_DynamicMetaData) Reset added in v0.9.6 

func (x *RateLimit_Action_DynamicMetaData) Reset()

func (*RateLimit_Action_DynamicMetaData) String added in v0.9.6 

func (x *RateLimit_Action_DynamicMetaData) String() string

func (*RateLimit_Action_DynamicMetaData) Validate added in v0.9.6 

func (m *RateLimit_Action_DynamicMetaData) Validate() error

Validate checks the field values on RateLimit_Action_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 (*RateLimit_Action_DynamicMetaData) ValidateAll added in v0.10.0 

func (m *RateLimit_Action_DynamicMetaData) ValidateAll() error

ValidateAll checks the field values on RateLimit_Action_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 RateLimit_Action_DynamicMetaDataMultiError, or nil if none found.

type RateLimit_Action_DynamicMetaDataMultiError added in v0.10.0 

type RateLimit_Action_DynamicMetaDataMultiError []error

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

func (RateLimit_Action_DynamicMetaDataMultiError) AllErrors added in v0.10.0 

func (m RateLimit_Action_DynamicMetaDataMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (RateLimit_Action_DynamicMetaDataMultiError) Error added in v0.10.0 

func (m RateLimit_Action_DynamicMetaDataMultiError) Error() string

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

type RateLimit_Action_DynamicMetaDataValidationError added in v0.9.6 

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

RateLimit_Action_DynamicMetaDataValidationError is the validation error returned by RateLimit_Action_DynamicMetaData.Validate if the designated constraints aren't met.

func (RateLimit_Action_DynamicMetaDataValidationError) Cause added in v0.9.6 

func (e RateLimit_Action_DynamicMetaDataValidationError) Cause() error

Cause function returns cause value.

func (RateLimit_Action_DynamicMetaDataValidationError) Error added in v0.9.6 

func (e RateLimit_Action_DynamicMetaDataValidationError) Error() string

Error satisfies the builtin error interface

func (RateLimit_Action_DynamicMetaDataValidationError) ErrorName added in v0.9.6 

func (e RateLimit_Action_DynamicMetaDataValidationError) ErrorName() string

ErrorName returns error name.

func (RateLimit_Action_DynamicMetaDataValidationError) Field added in v0.9.6 

func (e RateLimit_Action_DynamicMetaDataValidationError) Field() string

Field function returns field value.

func (RateLimit_Action_DynamicMetaDataValidationError) Key added in v0.9.6 

func (e RateLimit_Action_DynamicMetaDataValidationError) Key() bool

Key function returns key value.

func (RateLimit_Action_DynamicMetaDataValidationError) Reason added in v0.9.6 

func (e RateLimit_Action_DynamicMetaDataValidationError) Reason() string

Reason function returns reason value.

type RateLimit_Action_DynamicMetadata added in v0.9.6 

type RateLimit_Action_DynamicMetadata struct {
	// Rate limit on dynamic metadata.
	//
	// .. attention::
	//   This field has been deprecated in favor of the :ref:`metadata <envoy_v3_api_field_config.route.v3.RateLimit.Action.metadata>` field
	//
	// Deprecated: Do not use.
	DynamicMetadata *RateLimit_Action_DynamicMetaData `protobuf:"bytes,7,opt,name=dynamic_metadata,json=dynamicMetadata,proto3,oneof"`
}

type RateLimit_Action_Extension added in v0.9.9 

type RateLimit_Action_Extension struct {
	// Rate limit descriptor extension. See the rate limit descriptor extensions documentation.
	//
	// :ref:`HTTP matching input functions <arch_overview_matching_api>` are
	// permitted as descriptor extensions. The input functions are only
	// looked up if there is no rate limit descriptor extension matching
	// the type URL.
	//
	// [#extension-category: envoy.rate_limit_descriptors]
	Extension *v31.TypedExtensionConfig `protobuf:"bytes,9,opt,name=extension,proto3,oneof"`
}

type RateLimit_Action_GenericKey 

type RateLimit_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 (*RateLimit_Action_GenericKey) Descriptor deprecated 

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

Deprecated: Use RateLimit_Action_GenericKey.ProtoReflect.Descriptor instead.

func (*RateLimit_Action_GenericKey) GetDescriptorKey added in v0.9.7 

func (x *RateLimit_Action_GenericKey) GetDescriptorKey() string

func (*RateLimit_Action_GenericKey) GetDescriptorValue 

func (x *RateLimit_Action_GenericKey) GetDescriptorValue() string

func (*RateLimit_Action_GenericKey) ProtoMessage 

func (*RateLimit_Action_GenericKey) ProtoMessage()

func (*RateLimit_Action_GenericKey) ProtoReflect added in v0.9.6 

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

func (*RateLimit_Action_GenericKey) Reset 

func (x *RateLimit_Action_GenericKey) Reset()

func (*RateLimit_Action_GenericKey) String 

func (x *RateLimit_Action_GenericKey) String() string

func (*RateLimit_Action_GenericKey) Validate 

func (m *RateLimit_Action_GenericKey) Validate() error

Validate checks the field values on RateLimit_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 (*RateLimit_Action_GenericKey) ValidateAll added in v0.10.0 

func (m *RateLimit_Action_GenericKey) ValidateAll() error

ValidateAll checks the field values on RateLimit_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 RateLimit_Action_GenericKeyMultiError, or nil if none found.

type RateLimit_Action_GenericKeyMultiError added in v0.10.0 

type RateLimit_Action_GenericKeyMultiError []error

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

func (RateLimit_Action_GenericKeyMultiError) AllErrors added in v0.10.0 

func (m RateLimit_Action_GenericKeyMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (RateLimit_Action_GenericKeyMultiError) Error added in v0.10.0 

func (m RateLimit_Action_GenericKeyMultiError) Error() string

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

type RateLimit_Action_GenericKeyValidationError 

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

RateLimit_Action_GenericKeyValidationError is the validation error returned by RateLimit_Action_GenericKey.Validate if the designated constraints aren't met.

func (RateLimit_Action_GenericKeyValidationError) Cause 

func (e RateLimit_Action_GenericKeyValidationError) Cause() error

Cause function returns cause value.

func (RateLimit_Action_GenericKeyValidationError) Error 

func (e RateLimit_Action_GenericKeyValidationError) Error() string

Error satisfies the builtin error interface

func (RateLimit_Action_GenericKeyValidationError) ErrorName 

func (e RateLimit_Action_GenericKeyValidationError) ErrorName() string

ErrorName returns error name.

func (RateLimit_Action_GenericKeyValidationError) Field 

func (e RateLimit_Action_GenericKeyValidationError) Field() string

Field function returns field value.

func (RateLimit_Action_GenericKeyValidationError) Key 

func (e RateLimit_Action_GenericKeyValidationError) Key() bool

Key function returns key value.

func (RateLimit_Action_GenericKeyValidationError) Reason 

func (e RateLimit_Action_GenericKeyValidationError) Reason() string

Reason function returns reason value.

type RateLimit_Action_GenericKey_ 

type RateLimit_Action_GenericKey_ struct {
	// Rate limit on a generic key.
	GenericKey *RateLimit_Action_GenericKey `protobuf:"bytes,5,opt,name=generic_key,json=genericKey,proto3,oneof"`
}

type RateLimit_Action_HeaderValueMatch 

type RateLimit_Action_HeaderValueMatch struct {

	// The key to use in the descriptor entry. Defaults to `header_match`.
	DescriptorKey string `protobuf:"bytes,4,opt,name=descriptor_key,json=descriptorKey,proto3" json:"descriptor_key,omitempty"`
	// 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 *wrappers.BoolValue `protobuf:"bytes,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 []*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 (*RateLimit_Action_HeaderValueMatch) Descriptor deprecated 

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

Deprecated: Use RateLimit_Action_HeaderValueMatch.ProtoReflect.Descriptor instead.

func (*RateLimit_Action_HeaderValueMatch) GetDescriptorKey added in v0.10.2 

func (x *RateLimit_Action_HeaderValueMatch) GetDescriptorKey() string

func (*RateLimit_Action_HeaderValueMatch) GetDescriptorValue 

func (x *RateLimit_Action_HeaderValueMatch) GetDescriptorValue() string

func (*RateLimit_Action_HeaderValueMatch) GetExpectMatch 

func (x *RateLimit_Action_HeaderValueMatch) GetExpectMatch() *wrappers.BoolValue

func (*RateLimit_Action_HeaderValueMatch) GetHeaders 

func (x *RateLimit_Action_HeaderValueMatch) GetHeaders() []*HeaderMatcher

func (*RateLimit_Action_HeaderValueMatch) ProtoMessage 

func (*RateLimit_Action_HeaderValueMatch) ProtoMessage()

func (*RateLimit_Action_HeaderValueMatch) ProtoReflect added in v0.9.6 

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

func (*RateLimit_Action_HeaderValueMatch) Reset 

func (x *RateLimit_Action_HeaderValueMatch) Reset()

func (*RateLimit_Action_HeaderValueMatch) String 

func (x *RateLimit_Action_HeaderValueMatch) String() string

func (*RateLimit_Action_HeaderValueMatch) Validate 

func (m *RateLimit_Action_HeaderValueMatch) Validate() error

Validate checks the field values on RateLimit_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 (*RateLimit_Action_HeaderValueMatch) ValidateAll added in v0.10.0 

func (m *RateLimit_Action_HeaderValueMatch) ValidateAll() error

ValidateAll checks the field values on RateLimit_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 RateLimit_Action_HeaderValueMatchMultiError, or nil if none found.

type RateLimit_Action_HeaderValueMatchMultiError added in v0.10.0 

type RateLimit_Action_HeaderValueMatchMultiError []error

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

func (RateLimit_Action_HeaderValueMatchMultiError) AllErrors added in v0.10.0 

func (m RateLimit_Action_HeaderValueMatchMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (RateLimit_Action_HeaderValueMatchMultiError) Error added in v0.10.0 

func (m RateLimit_Action_HeaderValueMatchMultiError) Error() string

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

type RateLimit_Action_HeaderValueMatchValidationError 

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

RateLimit_Action_HeaderValueMatchValidationError is the validation error returned by RateLimit_Action_HeaderValueMatch.Validate if the designated constraints aren't met.

func (RateLimit_Action_HeaderValueMatchValidationError) Cause 

func (e RateLimit_Action_HeaderValueMatchValidationError) Cause() error

Cause function returns cause value.

func (RateLimit_Action_HeaderValueMatchValidationError) Error 

func (e RateLimit_Action_HeaderValueMatchValidationError) Error() string

Error satisfies the builtin error interface

func (RateLimit_Action_HeaderValueMatchValidationError) ErrorName 

func (e RateLimit_Action_HeaderValueMatchValidationError) ErrorName() string

ErrorName returns error name.

func (RateLimit_Action_HeaderValueMatchValidationError) Field 

func (e RateLimit_Action_HeaderValueMatchValidationError) Field() string

Field function returns field value.

func (RateLimit_Action_HeaderValueMatchValidationError) Key 

func (e RateLimit_Action_HeaderValueMatchValidationError) Key() bool

Key function returns key value.

func (RateLimit_Action_HeaderValueMatchValidationError) Reason 

func (e RateLimit_Action_HeaderValueMatchValidationError) Reason() string

Reason function returns reason value.

type RateLimit_Action_HeaderValueMatch_ 

type RateLimit_Action_HeaderValueMatch_ struct {
	// Rate limit on the existence of request headers.
	HeaderValueMatch *RateLimit_Action_HeaderValueMatch `protobuf:"bytes,6,opt,name=header_value_match,json=headerValueMatch,proto3,oneof"`
}

type RateLimit_Action_MaskedRemoteAddress added in v0.10.2 

type RateLimit_Action_MaskedRemoteAddress struct {

	// Length of prefix mask len for IPv4 (e.g. 0, 32).
	// Defaults to 32 when unset.
	// For example, trusted address from x-forwarded-for is `192.168.1.1`,
	// the descriptor entry is ("masked_remote_address", "192.168.1.1/32");
	// if mask len is 24, the descriptor entry is ("masked_remote_address", "192.168.1.0/24").
	V4PrefixMaskLen *wrappers.UInt32Value `protobuf:"bytes,1,opt,name=v4_prefix_mask_len,json=v4PrefixMaskLen,proto3" json:"v4_prefix_mask_len,omitempty"`
	// Length of prefix mask len for IPv6 (e.g. 0, 128).
	// Defaults to 128 when unset.
	// For example, trusted address from x-forwarded-for is `2001:abcd:ef01:2345:6789:abcd:ef01:234`,
	// the descriptor entry is ("masked_remote_address", "2001:abcd:ef01:2345:6789:abcd:ef01:234/128");
	// if mask len is 64, the descriptor entry is ("masked_remote_address", "2001:abcd:ef01:2345::/64").
	V6PrefixMaskLen *wrappers.UInt32Value `protobuf:"bytes,2,opt,name=v6_prefix_mask_len,json=v6PrefixMaskLen,proto3" json:"v6_prefix_mask_len,omitempty"`
	// contains filtered or unexported fields
}

The following descriptor entry is appended to the descriptor and is populated using the masked address from :ref:`x-forwarded-for <config_http_conn_man_headers_x-forwarded-for>`:

.. code-block:: cpp 

("masked_remote_address", "<masked address from x-forwarded-for>")

func (*RateLimit_Action_MaskedRemoteAddress) Descriptor deprecated added in v0.10.2 

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

Deprecated: Use RateLimit_Action_MaskedRemoteAddress.ProtoReflect.Descriptor instead.

func (*RateLimit_Action_MaskedRemoteAddress) GetV4PrefixMaskLen added in v0.10.2 

func (x *RateLimit_Action_MaskedRemoteAddress) GetV4PrefixMaskLen() *wrappers.UInt32Value

func (*RateLimit_Action_MaskedRemoteAddress) GetV6PrefixMaskLen added in v0.10.2 

func (x *RateLimit_Action_MaskedRemoteAddress) GetV6PrefixMaskLen() *wrappers.UInt32Value

func (*RateLimit_Action_MaskedRemoteAddress) ProtoMessage added in v0.10.2 

func (*RateLimit_Action_MaskedRemoteAddress) ProtoMessage()

func (*RateLimit_Action_MaskedRemoteAddress) ProtoReflect added in v0.10.2 

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

func (*RateLimit_Action_MaskedRemoteAddress) Reset added in v0.10.2 

func (x *RateLimit_Action_MaskedRemoteAddress) Reset()

func (*RateLimit_Action_MaskedRemoteAddress) String added in v0.10.2 

func (x *RateLimit_Action_MaskedRemoteAddress) String() string

func (*RateLimit_Action_MaskedRemoteAddress) Validate added in v0.10.2 

func (m *RateLimit_Action_MaskedRemoteAddress) Validate() error

Validate checks the field values on RateLimit_Action_MaskedRemoteAddress 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_Action_MaskedRemoteAddress) ValidateAll added in v0.10.2 

func (m *RateLimit_Action_MaskedRemoteAddress) ValidateAll() error

ValidateAll checks the field values on RateLimit_Action_MaskedRemoteAddress 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 RateLimit_Action_MaskedRemoteAddressMultiError, or nil if none found.

type RateLimit_Action_MaskedRemoteAddressMultiError added in v0.10.2 

type RateLimit_Action_MaskedRemoteAddressMultiError []error

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

func (RateLimit_Action_MaskedRemoteAddressMultiError) AllErrors added in v0.10.2 

func (m RateLimit_Action_MaskedRemoteAddressMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (RateLimit_Action_MaskedRemoteAddressMultiError) Error added in v0.10.2 

func (m RateLimit_Action_MaskedRemoteAddressMultiError) Error() string

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

type RateLimit_Action_MaskedRemoteAddressValidationError added in v0.10.2 

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

RateLimit_Action_MaskedRemoteAddressValidationError is the validation error returned by RateLimit_Action_MaskedRemoteAddress.Validate if the designated constraints aren't met.

func (RateLimit_Action_MaskedRemoteAddressValidationError) Cause added in v0.10.2 

func (e RateLimit_Action_MaskedRemoteAddressValidationError) Cause() error

Cause function returns cause value.

func (RateLimit_Action_MaskedRemoteAddressValidationError) Error added in v0.10.2 

func (e RateLimit_Action_MaskedRemoteAddressValidationError) Error() string

Error satisfies the builtin error interface

func (RateLimit_Action_MaskedRemoteAddressValidationError) ErrorName added in v0.10.2 

func (e RateLimit_Action_MaskedRemoteAddressValidationError) ErrorName() string

ErrorName returns error name.

func (RateLimit_Action_MaskedRemoteAddressValidationError) Field added in v0.10.2 

func (e RateLimit_Action_MaskedRemoteAddressValidationError) Field() string

Field function returns field value.

func (RateLimit_Action_MaskedRemoteAddressValidationError) Key added in v0.10.2 

func (e RateLimit_Action_MaskedRemoteAddressValidationError) Key() bool

Key function returns key value.

func (RateLimit_Action_MaskedRemoteAddressValidationError) Reason added in v0.10.2 

func (e RateLimit_Action_MaskedRemoteAddressValidationError) Reason() string

Reason function returns reason value.

type RateLimit_Action_MaskedRemoteAddress_ added in v0.10.2 

type RateLimit_Action_MaskedRemoteAddress_ struct {
	// Rate limit on masked remote address.
	MaskedRemoteAddress *RateLimit_Action_MaskedRemoteAddress `protobuf:"bytes,10,opt,name=masked_remote_address,json=maskedRemoteAddress,proto3,oneof"`
}

type RateLimit_Action_MetaData added in v0.9.8 

type RateLimit_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 *v35.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.