route

package
v1.17.0-beta6 Latest Latest
Warning

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

 Go to latest Published: Feb 1, 2024 License: Apache-2.0 Imports: 26 Imported by: 0

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 (
	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 File_github_com_solo_io_gloo_projects_gloo_api_external_envoy_api_v2_route_route_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type CorsPolicy 

type CorsPolicy struct {

	// Specifies the origins that will be allowed to do CORS requests.
	//
	// An origin is allowed if either allow_origin or allow_origin_regex match.
	AllowOrigin []string `protobuf:"bytes,1,rep,name=allow_origin,json=allowOrigin,proto3" json:"allow_origin,omitempty"`
	// Specifies regex patterns that match allowed origins.
	//
	// An origin is allowed if either allow_origin or allow_origin_regex match.
	AllowOriginRegex []string `protobuf:"bytes,8,rep,name=allow_origin_regex,json=allowOriginRegex,proto3" json:"allow_origin_regex,omitempty"`
	// 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_Enabled
	//	*CorsPolicy_FilterEnabled
	EnabledSpecifier isCorsPolicy_EnabledSpecifier `protobuf_oneof:"enabled_specifier"`
	// Specifies if CORS policies are evaluated and tracked when filter is off but
	// does not enforce any policies.
	//
	// More information on how this can be controlled via runtime can be found
	// `here (cors-runtime)`.
	//
	//	This field defaults to 100/`HUNDRED
	//	(envoy_api_enum_type.FractionalPercent.DenominatorType)`.
	ShadowEnabled *core.RuntimeFractionalPercent `protobuf:"bytes,10,opt,name=shadow_enabled,json=shadowEnabled,proto3" json:"shadow_enabled,omitempty"`
	// contains filtered or unexported fields
}

func (*CorsPolicy) Clone added in v1.8.24 

func (m *CorsPolicy) Clone() proto.Message

Clone function

func (*CorsPolicy) Descriptor deprecated 

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

Deprecated: Use CorsPolicy.ProtoReflect.Descriptor instead.

func (*CorsPolicy) Equal 

func (m *CorsPolicy) Equal(that interface{}) bool

Equal function

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) GetAllowOrigin 

func (x *CorsPolicy) GetAllowOrigin() []string

func (*CorsPolicy) GetAllowOriginRegex 

func (x *CorsPolicy) GetAllowOriginRegex() []string

func (*CorsPolicy) GetEnabled deprecated 

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

Deprecated: Marked as deprecated in github.com/solo-io/gloo/projects/gloo/api/external/envoy/api/v2/route/route.proto.

func (*CorsPolicy) GetEnabledSpecifier 

func (m *CorsPolicy) GetEnabledSpecifier() isCorsPolicy_EnabledSpecifier

func (*CorsPolicy) GetExposeHeaders 

func (x *CorsPolicy) GetExposeHeaders() string

func (*CorsPolicy) GetFilterEnabled 

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

func (*CorsPolicy) GetMaxAge 

func (x *CorsPolicy) GetMaxAge() string

func (*CorsPolicy) GetShadowEnabled 

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

func (*CorsPolicy) Hash added in v1.2.13 

func (m *CorsPolicy) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*CorsPolicy) ProtoMessage 

func (*CorsPolicy) ProtoMessage()

func (*CorsPolicy) ProtoReflect added in v1.6.0 

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

func (*CorsPolicy) Reset 

func (x *CorsPolicy) Reset()

func (*CorsPolicy) String 

func (x *CorsPolicy) String() string

type CorsPolicy_Enabled 

type CorsPolicy_Enabled struct {
	// Specifies if CORS is enabled. Defaults to true. Only effective on route.
	//
	//	**This field is deprecated**. Set the
	//	`filter_enabled (envoy_api_field_route.CorsPolicy.filter_enabled)` field instead.
	//
	// Deprecated: Marked as deprecated in github.com/solo-io/gloo/projects/gloo/api/external/envoy/api/v2/route/route.proto.
	Enabled *wrappers.BoolValue `protobuf:"bytes,7,opt,name=enabled,proto3,oneof"`
}

type CorsPolicy_FilterEnabled 

type CorsPolicy_FilterEnabled struct {
	// Specifies if CORS is enabled.
	//
	// More information on how this can be controlled via runtime can be found
	// `here (cors-runtime)`.
	//
	//	This field defaults to 100/`HUNDRED
	//	(envoy_api_enum_type.FractionalPercent.DenominatorType)`.
	FilterEnabled *core.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.
	//
	//	For ingress (inbound) requests, or egress (outbound) responses, this value may be overridden
	//	by the `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"`
	// contains filtered or unexported fields
}

func (*Decorator) Clone added in v1.8.24 

func (m *Decorator) Clone() proto.Message

Clone function

func (*Decorator) Descriptor deprecated 

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

Deprecated: Use Decorator.ProtoReflect.Descriptor instead.

func (*Decorator) Equal 

func (m *Decorator) Equal(that interface{}) bool

Equal function

func (*Decorator) GetOperation 

func (x *Decorator) GetOperation() string

func (*Decorator) Hash added in v1.2.13 

func (m *Decorator) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*Decorator) ProtoMessage 

func (*Decorator) ProtoMessage()

func (*Decorator) ProtoReflect added in v1.6.0 

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

func (*Decorator) Reset 

func (x *Decorator) Reset()

func (*Decorator) String 

func (x *Decorator) String() string

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.
	//
	//	Headers can be specified using *response_headers_to_add* in the enclosing
	//	`envoy_api_msg_route.Route`, `envoy_api_msg_RouteConfiguration` or
	//	`envoy_api_msg_route.VirtualHost`.
	Body *core.DataSource `protobuf:"bytes,2,opt,name=body,proto3" json:"body,omitempty"`
	// contains filtered or unexported fields
}

func (*DirectResponseAction) Clone added in v1.8.24 

func (m *DirectResponseAction) Clone() proto.Message

Clone function

func (*DirectResponseAction) Descriptor deprecated 

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

Deprecated: Use DirectResponseAction.ProtoReflect.Descriptor instead.

func (*DirectResponseAction) Equal 

func (m *DirectResponseAction) Equal(that interface{}) bool

Equal function

func (*DirectResponseAction) GetBody 

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

func (*DirectResponseAction) GetStatus 

func (x *DirectResponseAction) GetStatus() uint32

func (*DirectResponseAction) Hash added in v1.2.13 

func (m *DirectResponseAction) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*DirectResponseAction) ProtoMessage 

func (*DirectResponseAction) ProtoMessage()

func (*DirectResponseAction) ProtoReflect added in v1.6.0 

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

func (*DirectResponseAction) Reset 

func (x *DirectResponseAction) Reset()

func (*DirectResponseAction) String 

func (x *DirectResponseAction) String() string

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_RegexMatch
	//	*HeaderMatcher_RangeMatch
	//	*HeaderMatcher_PresentMatch
	//	*HeaderMatcher_PrefixMatch
	//	*HeaderMatcher_SuffixMatch
	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
}

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.

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

``` 

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

```

In the absence of any header match specifier, match will default to `present_match (envoy_api_field_route.HeaderMatcher.present_match)`. i.e, a request that has the `name (envoy_api_field_route.HeaderMatcher.name)` header will match, regardless of the header's value.

func (*HeaderMatcher) Clone added in v1.8.24 

func (m *HeaderMatcher) Clone() proto.Message

Clone function

func (*HeaderMatcher) Descriptor deprecated 

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

Deprecated: Use HeaderMatcher.ProtoReflect.Descriptor instead.

func (*HeaderMatcher) Equal 

func (m *HeaderMatcher) Equal(that interface{}) bool

Equal function

func (*HeaderMatcher) GetExactMatch 

func (x *HeaderMatcher) GetExactMatch() string

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 

func (x *HeaderMatcher) GetPrefixMatch() string

func (*HeaderMatcher) GetPresentMatch 

func (x *HeaderMatcher) GetPresentMatch() bool

func (*HeaderMatcher) GetRangeMatch 

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

func (*HeaderMatcher) GetRegexMatch 

func (x *HeaderMatcher) GetRegexMatch() string

func (*HeaderMatcher) GetSuffixMatch 

func (x *HeaderMatcher) GetSuffixMatch() string

func (*HeaderMatcher) Hash added in v1.2.13 

func (m *HeaderMatcher) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*HeaderMatcher) ProtoMessage 

func (*HeaderMatcher) ProtoMessage()

func (*HeaderMatcher) ProtoReflect added in v1.6.0 

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

func (*HeaderMatcher) Reset 

func (x *HeaderMatcher) Reset()

func (*HeaderMatcher) String 

func (x *HeaderMatcher) String() string

type HeaderMatcher_ExactMatch 

type HeaderMatcher_ExactMatch struct {
	// If specified, header match will be performed based on the value of the header.
	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.
	//
	// Examples:
	//
	// * The prefix *abcd* matches the value *abcdxyz*, but not for *abcxyz*.
	PrefixMatch string `protobuf:"bytes,9,opt,name=prefix_match,json=prefixMatch,proto3,oneof"`
}

type HeaderMatcher_PresentMatch 

type HeaderMatcher_PresentMatch struct {
	// If specified, header match will be performed based on whether the header is in the
	// request.
	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 *_type1.Int64Range `protobuf:"bytes,6,opt,name=range_match,json=rangeMatch,proto3,oneof"`
}

type HeaderMatcher_RegexMatch 

type HeaderMatcher_RegexMatch 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. The regex grammar used in the value field is defined
	// `here <https://en.cppreference.com/w/cpp/regex/ecmascript>`_.
	//
	// Examples:
	//
	// * The regex *\d{3}* matches the value *123*
	// * The regex *\d{3}* does not match the value *1234*
	// * The regex *\d{3}* does not match the value *123.456*
	RegexMatch string `protobuf:"bytes,5,opt,name=regex_match,json=regexMatch,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.
	//
	// Examples:
	//
	// * The suffix *abcd* matches the value *xyzabcd*, but not for *xyzbcd*.
	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 *_type.FractionalPercent `` /* 132-byte string literal not displayed */
	// Indicates that a hedged request should be sent when the per-try timeout
	// is hit. This will only occur if the retry policy also indicates that a
	// timed out request should be retried.
	// Once a timed out request is retried due to per try timeout, the router
	// filter will ensure that it is not retried again even if the returned
	// response headers would otherwise be retried according the specified
	// `RetryPolicy (envoy_api_msg_route.RetryPolicy)`.
	// Defaults to false.
	HedgeOnPerTryTimeout bool `` /* 128-byte string literal not displayed */
	// contains filtered or unexported fields
}

HTTP request hedging `architecture overview (arch_overview_http_routing_hedging)`.

func (*HedgePolicy) Clone added in v1.8.24 

func (m *HedgePolicy) Clone() proto.Message

Clone function

func (*HedgePolicy) Descriptor deprecated 

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

Deprecated: Use HedgePolicy.ProtoReflect.Descriptor instead.

func (*HedgePolicy) Equal 

func (m *HedgePolicy) Equal(that interface{}) bool

Equal function

func (*HedgePolicy) GetAdditionalRequestChance 

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

func (*HedgePolicy) GetHedgeOnPerTryTimeout 

func (x *HedgePolicy) GetHedgeOnPerTryTimeout() bool

func (*HedgePolicy) GetInitialRequests 

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

func (*HedgePolicy) Hash added in v1.2.13 

func (m *HedgePolicy) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*HedgePolicy) ProtoMessage 

func (*HedgePolicy) ProtoMessage()

func (*HedgePolicy) ProtoReflect added in v1.6.0 

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

func (*HedgePolicy) Reset 

func (x *HedgePolicy) Reset()

func (*HedgePolicy) String 

func (x *HedgePolicy) String() string

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"`
	// Specifies the value of the key. If the value is absent, a request
	// that contains the key in its query string will match, whether the
	// key appears with a value (e.g., "?debug=true") or not (e.g., "?debug")
	Value string `protobuf:"bytes,3,opt,name=value,proto3" json:"value,omitempty"`
	// Specifies whether the query parameter value is a regular expression.
	// Defaults to false. The entire query parameter value (i.e., the part to
	// the right of the equals sign in "key=value") must match the regex.
	// E.g., the regex "\d+$" will match "123" but not "a123" or "123a".
	Regex *wrappers.BoolValue `protobuf:"bytes,4,opt,name=regex,proto3" json:"regex,omitempty"`
	// 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.

func (*QueryParameterMatcher) Clone added in v1.8.24 

func (m *QueryParameterMatcher) Clone() proto.Message

Clone function

func (*QueryParameterMatcher) Descriptor deprecated 

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

Deprecated: Use QueryParameterMatcher.ProtoReflect.Descriptor instead.

func (*QueryParameterMatcher) Equal 

func (m *QueryParameterMatcher) Equal(that interface{}) bool

Equal function

func (*QueryParameterMatcher) GetName 

func (x *QueryParameterMatcher) GetName() string

func (*QueryParameterMatcher) GetRegex 

func (x *QueryParameterMatcher) GetRegex() *wrappers.BoolValue

func (*QueryParameterMatcher) GetValue 

func (x *QueryParameterMatcher) GetValue() string

func (*QueryParameterMatcher) Hash added in v1.2.13 

func (m *QueryParameterMatcher) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*QueryParameterMatcher) ProtoMessage 

func (*QueryParameterMatcher) ProtoMessage()

func (*QueryParameterMatcher) ProtoReflect added in v1.6.0 

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

func (*QueryParameterMatcher) Reset 

func (x *QueryParameterMatcher) Reset()

func (*QueryParameterMatcher) String 

func (x *QueryParameterMatcher) String() string

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.
	//
	//	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 `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"`
	// contains filtered or unexported fields
}

Global rate limiting `architecture overview (arch_overview_rate_limit)`.

func (*RateLimit) Clone added in v1.8.24 

func (m *RateLimit) Clone() proto.Message

Clone function

func (*RateLimit) Descriptor deprecated 

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

Deprecated: Use RateLimit.ProtoReflect.Descriptor instead.

func (*RateLimit) Equal 

func (m *RateLimit) Equal(that interface{}) bool

Equal function

func (*RateLimit) GetActions 

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

func (*RateLimit) GetDisableKey 

func (x *RateLimit) GetDisableKey() string

func (*RateLimit) GetStage 

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

func (*RateLimit) Hash added in v1.2.13 

func (m *RateLimit) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*RateLimit) ProtoMessage 

func (*RateLimit) ProtoMessage()

func (*RateLimit) ProtoReflect added in v1.6.0 

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

func (*RateLimit) Reset 

func (x *RateLimit) Reset()

func (*RateLimit) String 

func (x *RateLimit) String() string

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_
	ActionSpecifier isRateLimit_Action_ActionSpecifier `protobuf_oneof:"action_specifier"`
	// contains filtered or unexported fields
}

func (*RateLimit_Action) Clone added in v1.8.24 

func (m *RateLimit_Action) Clone() proto.Message

Clone function

func (*RateLimit_Action) Descriptor deprecated 

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

Deprecated: Use RateLimit_Action.ProtoReflect.Descriptor instead.

func (*RateLimit_Action) Equal 

func (m *RateLimit_Action) Equal(that interface{}) bool

Equal function

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) GetGenericKey 

func (x *RateLimit_Action) GetGenericKey() *RateLimit_Action_GenericKey

func (*RateLimit_Action) GetHeaderValueMatch 

func (x *RateLimit_Action) GetHeaderValueMatch() *RateLimit_Action_HeaderValueMatch

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) Hash added in v1.2.13 

func (m *RateLimit_Action) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*RateLimit_Action) ProtoMessage 

func (*RateLimit_Action) ProtoMessage()

func (*RateLimit_Action) ProtoReflect added in v1.6.0 

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

type RateLimit_Action_DestinationCluster 

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

The following descriptor entry is appended to the descriptor:

``` 

("destination_cluster", "<routed target cluster>")

```

Once a request matches against a route table rule, a routed cluster is determined by one of the following `route table configuration (envoy_api_msg_RouteConfiguration)` settings:

  • `cluster (envoy_api_field_route.RouteAction.cluster)` indicates the upstream cluster to route to.
  • `weighted_clusters (envoy_api_field_route.RouteAction.weighted_clusters)` chooses a cluster randomly from a set of clusters with attributed weight.
  • `cluster_header (envoy_api_field_route.RouteAction.cluster_header)` indicates which header in the request contains the target cluster.

func (*RateLimit_Action_DestinationCluster) Clone added in v1.8.24 

func (m *RateLimit_Action_DestinationCluster) Clone() proto.Message

Clone function

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) Equal 

func (m *RateLimit_Action_DestinationCluster) Equal(that interface{}) bool

Equal function

func (*RateLimit_Action_DestinationCluster) Hash added in v1.2.13 

func (m *RateLimit_Action_DestinationCluster) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*RateLimit_Action_DestinationCluster) ProtoMessage 

func (*RateLimit_Action_DestinationCluster) ProtoMessage()

func (*RateLimit_Action_DestinationCluster) ProtoReflect added in v1.6.0 

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

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_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"`
	// contains filtered or unexported fields
}

The following descriptor entry is appended to the descriptor:

``` 

("generic_key", "<descriptor_value>")

```

func (*RateLimit_Action_GenericKey) Clone added in v1.8.24 

func (m *RateLimit_Action_GenericKey) Clone() proto.Message

Clone function

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) Equal 

func (m *RateLimit_Action_GenericKey) Equal(that interface{}) bool

Equal function

func (*RateLimit_Action_GenericKey) GetDescriptorValue 

func (x *RateLimit_Action_GenericKey) GetDescriptorValue() string

func (*RateLimit_Action_GenericKey) Hash added in v1.2.13 

func (m *RateLimit_Action_GenericKey) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*RateLimit_Action_GenericKey) ProtoMessage 

func (*RateLimit_Action_GenericKey) ProtoMessage()

func (*RateLimit_Action_GenericKey) ProtoReflect added in v1.6.0 

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

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

``` 

("header_match", "<descriptor_value>")

```

func (*RateLimit_Action_HeaderValueMatch) Clone added in v1.8.24 

func (m *RateLimit_Action_HeaderValueMatch) Clone() proto.Message

Clone function

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) Equal 

func (m *RateLimit_Action_HeaderValueMatch) Equal(that interface{}) bool

Equal function

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) Hash added in v1.2.13 

func (m *RateLimit_Action_HeaderValueMatch) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*RateLimit_Action_HeaderValueMatch) ProtoMessage 

func (*RateLimit_Action_HeaderValueMatch) ProtoMessage()

func (*RateLimit_Action_HeaderValueMatch) ProtoReflect added in v1.6.0 

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

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_RemoteAddress 

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

The following descriptor entry is appended to the descriptor and is populated using the trusted address from `x-forwarded-for (config_http_conn_man_headers_x-forwarded-for)`:

``` 

("remote_address", "<trusted address from x-forwarded-for>")

```

func (*RateLimit_Action_RemoteAddress) Clone added in v1.8.24 

func (m *RateLimit_Action_RemoteAddress) Clone() proto.Message

Clone function

func (*RateLimit_Action_RemoteAddress) Descriptor deprecated 

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

Deprecated: Use RateLimit_Action_RemoteAddress.ProtoReflect.Descriptor instead.

func (*RateLimit_Action_RemoteAddress) Equal 

func (m *RateLimit_Action_RemoteAddress) Equal(that interface{}) bool

Equal function

func (*RateLimit_Action_RemoteAddress) Hash added in v1.2.13 

func (m *RateLimit_Action_RemoteAddress) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*RateLimit_Action_RemoteAddress) ProtoMessage 

func (*RateLimit_Action_RemoteAddress) ProtoMessage()

func (*RateLimit_Action_RemoteAddress) ProtoReflect added in v1.6.0 

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

func (*RateLimit_Action_RemoteAddress) Reset 

func (x *RateLimit_Action_RemoteAddress) Reset()

func (*RateLimit_Action_RemoteAddress) String 

func (x *RateLimit_Action_RemoteAddress) String() string

type RateLimit_Action_RemoteAddress_ 

type RateLimit_Action_RemoteAddress_ struct {
	// Rate limit on remote address.
	RemoteAddress *RateLimit_Action_RemoteAddress `protobuf:"bytes,4,opt,name=remote_address,json=remoteAddress,proto3,oneof"`
}

type RateLimit_Action_RequestHeaders 

type RateLimit_Action_RequestHeaders struct {

	// The header name to be queried from the request headers. The header’s
	// value is used to populate the value of the descriptor entry for the
	// descriptor_key.
	HeaderName string `protobuf:"bytes,1,opt,name=header_name,json=headerName,proto3" json:"header_name,omitempty"`
	// The key to use in the descriptor entry.
	DescriptorKey string `protobuf:"bytes,2,opt,name=descriptor_key,json=descriptorKey,proto3" json:"descriptor_key,omitempty"`
	// contains filtered or unexported fields
}

The following descriptor entry is appended when a header contains a key that matches the *header_name*:

``` 

("<descriptor_key>", "<header_value_queried_from_header>")

```

func (*RateLimit_Action_RequestHeaders) Clone added in v1.8.24 

func (m *RateLimit_Action_RequestHeaders) Clone() proto.Message

Clone function

func (*RateLimit_Action_RequestHeaders) Descriptor deprecated 

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

Deprecated: Use RateLimit_Action_RequestHeaders.ProtoReflect.Descriptor instead.

func (*RateLimit_Action_RequestHeaders) Equal 

func (m *RateLimit_Action_RequestHeaders) Equal(that interface{}) bool

Equal function

func (*RateLimit_Action_RequestHeaders) GetDescriptorKey 

func (x *RateLimit_Action_RequestHeaders) GetDescriptorKey() string

func (*RateLimit_Action_RequestHeaders) GetHeaderName 

func (x *RateLimit_Action_RequestHeaders) GetHeaderName() string

func (*RateLimit_Action_RequestHeaders) Hash added in v1.2.13 

func (m *RateLimit_Action_RequestHeaders) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*RateLimit_Action_RequestHeaders) ProtoMessage 

func (*RateLimit_Action_RequestHeaders) ProtoMessage()

func (*RateLimit_Action_RequestHeaders) ProtoReflect added in v1.6.0 

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

func (*RateLimit_Action_RequestHeaders) Reset 

func (x *RateLimit_Action_RequestHeaders) Reset()

func (*RateLimit_Action_RequestHeaders) String 

func (x *RateLimit_Action_RequestHeaders) String() string

type RateLimit_Action_RequestHeaders_ 

type RateLimit_Action_RequestHeaders_ struct {
	// Rate limit on request headers.
	RequestHeaders *RateLimit_Action_RequestHeaders `protobuf:"bytes,3,opt,name=request_headers,json=requestHeaders,proto3,oneof"`
}

type RateLimit_Action_SourceCluster 

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

The following descriptor entry is appended to the descriptor:

``` 

("source_cluster", "<local service cluster>")

```

<local service cluster> is derived from the :option:`--service-cluster` option.

func (*RateLimit_Action_SourceCluster) Clone added in v1.8.24 

func (m *RateLimit_Action_SourceCluster) Clone() proto.Message

Clone function

func (*RateLimit_Action_SourceCluster) Descriptor deprecated 

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

Deprecated: Use RateLimit_Action_SourceCluster.ProtoReflect.Descriptor instead.

func (*RateLimit_Action_SourceCluster) Equal 

func (m *RateLimit_Action_SourceCluster) Equal(that interface{}) bool

Equal function

func (*RateLimit_Action_SourceCluster) Hash added in v1.2.13 

func (m *RateLimit_Action_SourceCluster) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*RateLimit_Action_SourceCluster) ProtoMessage 

func (*RateLimit_Action_SourceCluster) ProtoMessage()

func (*RateLimit_Action_SourceCluster) ProtoReflect added in v1.6.0 

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

func (*RateLimit_Action_SourceCluster) Reset 

func (x *RateLimit_Action_SourceCluster) Reset()

func (*RateLimit_Action_SourceCluster) String 

func (x *RateLimit_Action_SourceCluster) String() string

type RateLimit_Action_SourceCluster_ 

type RateLimit_Action_SourceCluster_ struct {
	// Rate limit on source cluster.
	SourceCluster *RateLimit_Action_SourceCluster `protobuf:"bytes,1,opt,name=source_cluster,json=sourceCluster,proto3,oneof"`
}

type RedirectAction 

type RedirectAction struct {

	// When the scheme redirection take place, the following rules apply:
	//  1. If the source URI scheme is `http` and the port is explicitly
	//     set to `:80`, the port will be removed after the redirection
	//  2. If the source URI scheme is `https` and the port is explicitly
	//     set to `:443`, the port will be removed after the redirection
	//
	// Types that are assignable to SchemeRewriteSpecifier:
	//
	//	*RedirectAction_HttpsRedirect
	//	*RedirectAction_SchemeRedirect
	SchemeRewriteSpecifier isRedirectAction_SchemeRewriteSpecifier `protobuf_oneof:"scheme_rewrite_specifier"`
	// The host portion of the URL will be swapped with this value.
	HostRedirect string `protobuf:"bytes,1,opt,name=host_redirect,json=hostRedirect,proto3" json:"host_redirect,omitempty"`
	// The port value of the URL will be swapped with this value.
	PortRedirect uint32 `protobuf:"varint,8,opt,name=port_redirect,json=portRedirect,proto3" json:"port_redirect,omitempty"`
	// Types that are assignable to PathRewriteSpecifier:
	//
	//	*RedirectAction_PathRedirect
	//	*RedirectAction_PrefixRewrite
	PathRewriteSpecifier isRedirectAction_PathRewriteSpecifier `protobuf_oneof:"path_rewrite_specifier"`
	// The HTTP status code to use in the redirect response. The default response
	// code is MOVED_PERMANENTLY (301).
	ResponseCode RedirectAction_RedirectResponseCode `` /* 166-byte string literal not displayed */
	// Indicates that during redirection, the query portion of the URL will
	// be removed. Default value is false.
	StripQuery bool `protobuf:"varint,6,opt,name=strip_query,json=stripQuery,proto3" json:"strip_query,omitempty"`
	// contains filtered or unexported fields
}

func (*RedirectAction) Clone added in v1.8.24 

func (m *RedirectAction) Clone() proto.Message

Clone function

func (*RedirectAction) Descriptor deprecated 

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

Deprecated: Use RedirectAction.ProtoReflect.Descriptor instead.

func (*RedirectAction) Equal 

func (m *RedirectAction) Equal(that interface{}) bool

Equal function

func (*RedirectAction) GetHostRedirect 

func (x *RedirectAction) GetHostRedirect() string

func (*RedirectAction) GetHttpsRedirect 

func (x *RedirectAction) GetHttpsRedirect() bool

func (*RedirectAction) GetPathRedirect 

func (x *RedirectAction) GetPathRedirect() string

func (*RedirectAction) GetPathRewriteSpecifier 

func (m *RedirectAction) GetPathRewriteSpecifier() isRedirectAction_PathRewriteSpecifier

func (*RedirectAction) GetPortRedirect 

func (x *RedirectAction) GetPortRedirect() uint32

func (*RedirectAction) GetPrefixRewrite 

func (x *RedirectAction) GetPrefixRewrite() string

func (*RedirectAction) GetResponseCode 

func (x *RedirectAction) GetResponseCode() RedirectAction_RedirectResponseCode

func (*RedirectAction) GetSchemeRedirect 

func (x *RedirectAction) GetSchemeRedirect() string

func (*RedirectAction) GetSchemeRewriteSpecifier 

func (m *RedirectAction) GetSchemeRewriteSpecifier() isRedirectAction_SchemeRewriteSpecifier

func (*RedirectAction) GetStripQuery 

func (x *RedirectAction) GetStripQuery() bool

func (*RedirectAction) Hash added in v1.2.13 

func (m *RedirectAction) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*RedirectAction) ProtoMessage 

func (*RedirectAction) ProtoMessage()

func (*RedirectAction) ProtoReflect added in v1.6.0 

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

func (*RedirectAction) Reset 

func (x *RedirectAction) Reset()

func (*RedirectAction) String 

func (x *RedirectAction) String() string

type RedirectAction_HttpsRedirect 

type RedirectAction_HttpsRedirect struct {
	// The scheme portion of the URL will be swapped with "https".
	HttpsRedirect bool `protobuf:"varint,4,opt,name=https_redirect,json=httpsRedirect,proto3,oneof"`
}

type RedirectAction_PathRedirect 

type RedirectAction_PathRedirect struct {
	// The path portion of the URL will be swapped with this value.
	PathRedirect string `protobuf:"bytes,2,opt,name=path_redirect,json=pathRedirect,proto3,oneof"`
}

type RedirectAction_PrefixRewrite 

type RedirectAction_PrefixRewrite struct {
	// Indicates that during redirection, the matched prefix (or path)
	// should be swapped with this value. This option allows redirect URLs be dynamically created
	// based on the request.
	//
	//	Pay attention to the use of trailing slashes as mentioned in
	//	`RouteAction's prefix_rewrite (envoy_api_field_route.RouteAction.prefix_rewrite)`.
	PrefixRewrite string `protobuf:"bytes,5,opt,name=prefix_rewrite,json=prefixRewrite,proto3,oneof"`
}

type RedirectAction_RedirectResponseCode 

type RedirectAction_RedirectResponseCode int32
const (
	// Moved Permanently HTTP Status Code - 301.
	RedirectAction_MOVED_PERMANENTLY RedirectAction_RedirectResponseCode = 0
	// Found HTTP Status Code - 302.
	RedirectAction_FOUND RedirectAction_RedirectResponseCode = 1
	// See Other HTTP Status Code - 303.
	RedirectAction_SEE_OTHER RedirectAction_RedirectResponseCode = 2
	// Temporary Redirect HTTP Status Code - 307.
	RedirectAction_TEMPORARY_REDIRECT RedirectAction_RedirectResponseCode = 3
	// Permanent Redirect HTTP Status Code - 308.
	RedirectAction_PERMANENT_REDIRECT RedirectAction_RedirectResponseCode = 4
)

func (RedirectAction_RedirectResponseCode) Descriptor added in v1.6.0 

func (RedirectAction_RedirectResponseCode) Descriptor() protoreflect.EnumDescriptor

func (RedirectAction_RedirectResponseCode) Enum added in v1.6.0 

func (x RedirectAction_RedirectResponseCode) Enum() *RedirectAction_RedirectResponseCode

func (RedirectAction_RedirectResponseCode) EnumDescriptor deprecated 

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

Deprecated: Use RedirectAction_RedirectResponseCode.Descriptor instead.

func (RedirectAction_RedirectResponseCode) Number added in v1.6.0 

func (x RedirectAction_RedirectResponseCode) Number() protoreflect.EnumNumber

func (RedirectAction_RedirectResponseCode) String 

func (x RedirectAction_RedirectResponseCode) String() string

func (RedirectAction_RedirectResponseCode) Type added in v1.6.0 

func (RedirectAction_RedirectResponseCode) Type() protoreflect.EnumType

type RedirectAction_SchemeRedirect 

type RedirectAction_SchemeRedirect struct {
	// The scheme portion of the URL will be swapped with this value.
	SchemeRedirect string `protobuf:"bytes,7,opt,name=scheme_redirect,json=schemeRedirect,proto3,oneof"`
}

type RetryPolicy 

type RetryPolicy struct {

	// Specifies the conditions under which retry takes place. These are the same
	// conditions documented for `config_http_filters_router_x-envoy-retry-on` and
	// `config_http_filters_router_x-envoy-retry-grpc-on`.
	RetryOn string `protobuf:"bytes,1,opt,name=retry_on,json=retryOn,proto3" json:"retry_on,omitempty"`
	// Specifies the allowed number of retries. This parameter is optional and
	// defaults to 1. These are the same conditions documented for
	// `config_http_filters_router_x-envoy-max-retries`.
	NumRetries *wrappers.UInt32Value `protobuf:"bytes,2,opt,name=num_retries,json=numRetries,proto3" json:"num_retries,omitempty"`
	// Specifies a non-zero upstream timeout per retry attempt. This parameter is optional. The
	// same conditions documented for
	// `config_http_filters_router_x-envoy-upstream-rq-per-try-timeout-ms` apply.
	//
	//	If left unspecified, Envoy will use the global
	//	`route timeout (envoy_api_field_route.RouteAction.timeout)` for the request.
	//	Consequently, when using a `5xx (config_http_filters_router_x-envoy-retry-on)` based
	//	retry policy, a request that times out will not be retried as the total timeout budget
	//	would have been exhausted.
	PerTryTimeout *duration.Duration `protobuf:"bytes,3,opt,name=per_try_timeout,json=perTryTimeout,proto3" json:"per_try_timeout,omitempty"`
	// Specifies an implementation of a RetryPriority which is used to determine the
	// distribution of load across priorities used for retries. Refer to
	// `retry plugin configuration (arch_overview_http_retry_plugins)` for more details.
	RetryPriority *RetryPolicy_RetryPriority `protobuf:"bytes,4,opt,name=retry_priority,json=retryPriority,proto3" json:"retry_priority,omitempty"`
	// Specifies a collection of RetryHostPredicates that will be consulted when selecting a host
	// for retries. If any of the predicates reject the host, host selection will be reattempted.
	// Refer to `retry plugin configuration (arch_overview_http_retry_plugins)` for more
	// details.
	RetryHostPredicate []*RetryPolicy_RetryHostPredicate `protobuf:"bytes,5,rep,name=retry_host_predicate,json=retryHostPredicate,proto3" json:"retry_host_predicate,omitempty"`
	// The maximum number of times host selection will be reattempted before giving up, at which
	// point the host that was last selected will be routed to. If unspecified, this will default to
	// retrying once.
	HostSelectionRetryMaxAttempts int64 `` /* 155-byte string literal not displayed */
	// HTTP status codes that should trigger a retry in addition to those specified by retry_on.
	RetriableStatusCodes []uint32 `` /* 131-byte string literal not displayed */
	// Specifies parameters that control retry back off. This parameter is optional, in which case the
	// default base interval is 25 milliseconds or, if set, the current value of the
	// `upstream.base_retry_backoff_ms` runtime parameter. The default maximum interval is 10 times
	// the base interval. The documentation for `config_http_filters_router_x-envoy-max-retries`
	// describes Envoy's back-off algorithm.
	RetryBackOff *RetryPolicy_RetryBackOff `protobuf:"bytes,8,opt,name=retry_back_off,json=retryBackOff,proto3" json:"retry_back_off,omitempty"`
	// contains filtered or unexported fields
}

HTTP retry `architecture overview (arch_overview_http_routing_retry)`.

func (*RetryPolicy) Clone added in v1.8.24 

func (m *RetryPolicy) Clone() proto.Message

Clone function

func (*RetryPolicy) Descriptor deprecated 

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

Deprecated: Use RetryPolicy.ProtoReflect.Descriptor instead.

func (*RetryPolicy) Equal 

func (m *RetryPolicy) Equal(that interface{}) bool

Equal function

func (*RetryPolicy) GetHostSelectionRetryMaxAttempts 

func (x *RetryPolicy) GetHostSelectionRetryMaxAttempts() int64

func (*RetryPolicy) GetNumRetries 

func (x *RetryPolicy) GetNumRetries() *wrappers.UInt32Value

func (*RetryPolicy) GetPerTryTimeout 

func (x *RetryPolicy) GetPerTryTimeout() *duration.Duration

func (*RetryPolicy) GetRetriableStatusCodes 

func (x *RetryPolicy) GetRetriableStatusCodes() []uint32

func (*RetryPolicy) GetRetryBackOff 

func (x *RetryPolicy) GetRetryBackOff() *RetryPolicy_RetryBackOff

func (*RetryPolicy) GetRetryHostPredicate 

func (x *RetryPolicy) GetRetryHostPredicate() []*RetryPolicy_RetryHostPredicate

func (*RetryPolicy) GetRetryOn 

func (x *RetryPolicy) GetRetryOn() string

func (*RetryPolicy) GetRetryPriority 

func (x *RetryPolicy) GetRetryPriority() *RetryPolicy_RetryPriority

func (*RetryPolicy) Hash added in v1.2.13 

func (m *RetryPolicy) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*RetryPolicy) ProtoMessage 

func (*RetryPolicy) ProtoMessage()

func (*RetryPolicy) ProtoReflect added in v1.6.0 

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

func (*RetryPolicy) Reset 

func (x *RetryPolicy) Reset()

func (*RetryPolicy) String 

func (x *RetryPolicy) String() string

type RetryPolicy_RetryBackOff 

type RetryPolicy_RetryBackOff struct {

	// Specifies the base interval between retries. This parameter is required and must be greater
	// than zero. Values less than 1 ms are rounded up to 1 ms.
	// See `config_http_filters_router_x-envoy-max-retries` for a discussion of Envoy's
	// back-off algorithm.
	BaseInterval *duration.Duration `protobuf:"bytes,1,opt,name=base_interval,json=baseInterval,proto3" json:"base_interval,omitempty"`
	// Specifies the maximum interval between retries. This parameter is optional, but must be
	// greater than or equal to the `base_interval` if set. The default is 10 times the
	// `base_interval`. See `config_http_filters_router_x-envoy-max-retries` for a discussion
	// of Envoy's back-off algorithm.
	MaxInterval *duration.Duration `protobuf:"bytes,2,opt,name=max_interval,json=maxInterval,proto3" json:"max_interval,omitempty"`
	// contains filtered or unexported fields
}

func (*RetryPolicy_RetryBackOff) Clone added in v1.8.24 

func (m *RetryPolicy_RetryBackOff) Clone() proto.Message

Clone function

func (*RetryPolicy_RetryBackOff) Descriptor deprecated 

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

Deprecated: Use RetryPolicy_RetryBackOff.ProtoReflect.Descriptor instead.

func (*RetryPolicy_RetryBackOff) Equal 

func (m *RetryPolicy_RetryBackOff) Equal(that interface{}) bool

Equal function

func (*RetryPolicy_RetryBackOff) GetBaseInterval 

func (x *RetryPolicy_RetryBackOff) GetBaseInterval() *duration.Duration

func (*RetryPolicy_RetryBackOff) GetMaxInterval 

func (x *RetryPolicy_RetryBackOff) GetMaxInterval() *duration.Duration

func (*RetryPolicy_RetryBackOff) Hash added in v1.2.13 

func (m *RetryPolicy_RetryBackOff) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*RetryPolicy_RetryBackOff) ProtoMessage 

func (*RetryPolicy_RetryBackOff) ProtoMessage()

func (*RetryPolicy_RetryBackOff) ProtoReflect added in v1.6.0 

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

func (*RetryPolicy_RetryBackOff) Reset 

func (x *RetryPolicy_RetryBackOff) Reset()

func (*RetryPolicy_RetryBackOff) String 

func (x *RetryPolicy_RetryBackOff) String() string

type RetryPolicy_RetryHostPredicate 

type RetryPolicy_RetryHostPredicate struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Types that are assignable to ConfigType:
	//
	//	*RetryPolicy_RetryHostPredicate_Config
	//	*RetryPolicy_RetryHostPredicate_TypedConfig
	ConfigType isRetryPolicy_RetryHostPredicate_ConfigType `protobuf_oneof:"config_type"`
	// contains filtered or unexported fields
}

func (*RetryPolicy_RetryHostPredicate) Clone added in v1.8.24 

func (m *RetryPolicy_RetryHostPredicate) Clone() proto.Message

Clone function

func (*RetryPolicy_RetryHostPredicate) Descriptor deprecated 

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

Deprecated: Use RetryPolicy_RetryHostPredicate.ProtoReflect.Descriptor instead.

func (*RetryPolicy_RetryHostPredicate) Equal 

func (m *RetryPolicy_RetryHostPredicate) Equal(that interface{}) bool

Equal function

func (*RetryPolicy_RetryHostPredicate) GetConfig 

func (x *RetryPolicy_RetryHostPredicate) GetConfig() *_struct.Struct

func (*RetryPolicy_RetryHostPredicate) GetConfigType 

func (m *RetryPolicy_RetryHostPredicate) GetConfigType() isRetryPolicy_RetryHostPredicate_ConfigType

func (*RetryPolicy_RetryHostPredicate) GetName 

func (x *RetryPolicy_RetryHostPredicate) GetName() string

func (*RetryPolicy_RetryHostPredicate) GetTypedConfig 

func (x *RetryPolicy_RetryHostPredicate) GetTypedConfig() *any1.Any

func (*RetryPolicy_RetryHostPredicate) Hash added in v1.2.13 

func (m *RetryPolicy_RetryHostPredicate) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*RetryPolicy_RetryHostPredicate) ProtoMessage 

func (*RetryPolicy_RetryHostPredicate) ProtoMessage()

func (*RetryPolicy_RetryHostPredicate) ProtoReflect added in v1.6.0 

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

func (*RetryPolicy_RetryHostPredicate) Reset 

func (x *RetryPolicy_RetryHostPredicate) Reset()

func (*RetryPolicy_RetryHostPredicate) String 

func (x *RetryPolicy_RetryHostPredicate) String() string

type RetryPolicy_RetryHostPredicate_Config 

type RetryPolicy_RetryHostPredicate_Config struct {
	Config *_struct.Struct `protobuf:"bytes,2,opt,name=config,proto3,oneof"`
}

type RetryPolicy_RetryHostPredicate_TypedConfig 

type RetryPolicy_RetryHostPredicate_TypedConfig struct {
	TypedConfig *any1.Any `protobuf:"bytes,3,opt,name=typed_config,json=typedConfig,proto3,oneof"`
}

type RetryPolicy_RetryPriority 

type RetryPolicy_RetryPriority struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Types that are assignable to ConfigType:
	//
	//	*RetryPolicy_RetryPriority_Config
	//	*RetryPolicy_RetryPriority_TypedConfig
	ConfigType isRetryPolicy_RetryPriority_ConfigType `protobuf_oneof:"config_type"`
	// contains filtered or unexported fields
}

func (*RetryPolicy_RetryPriority) Clone added in v1.8.24 

func (m *RetryPolicy_RetryPriority) Clone() proto.Message

Clone function

func (*RetryPolicy_RetryPriority) Descriptor deprecated 

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

Deprecated: Use RetryPolicy_RetryPriority.ProtoReflect.Descriptor instead.

func (*RetryPolicy_RetryPriority) Equal 

func (m *RetryPolicy_RetryPriority) Equal(that interface{}) bool

Equal function

func (*RetryPolicy_RetryPriority) GetConfig 

func (x *RetryPolicy_RetryPriority) GetConfig() *_struct.Struct

func (*RetryPolicy_RetryPriority) GetConfigType 

func (m *RetryPolicy_RetryPriority) GetConfigType() isRetryPolicy_RetryPriority_ConfigType

func (*RetryPolicy_RetryPriority) GetName 

func (x *RetryPolicy_RetryPriority) GetName() string

func (*RetryPolicy_RetryPriority) GetTypedConfig 

func (x *RetryPolicy_RetryPriority) GetTypedConfig() *any1.Any

func (*RetryPolicy_RetryPriority) Hash added in v1.2.13 

func (m *RetryPolicy_RetryPriority) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*RetryPolicy_RetryPriority) ProtoMessage 

func (*RetryPolicy_RetryPriority) ProtoMessage()

func (*RetryPolicy_RetryPriority) ProtoReflect added in v1.6.0 

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

func (*RetryPolicy_RetryPriority) Reset 

func (x *RetryPolicy_RetryPriority) Reset()

func (*RetryPolicy_RetryPriority) String 

func (x *RetryPolicy_RetryPriority) String() string

type RetryPolicy_RetryPriority_Config 

type RetryPolicy_RetryPriority_Config struct {
	Config *_struct.Struct `protobuf:"bytes,2,opt,name=config,proto3,oneof"`
}

type RetryPolicy_RetryPriority_TypedConfig 

type RetryPolicy_RetryPriority_TypedConfig struct {
	TypedConfig *any1.Any `protobuf:"bytes,3,opt,name=typed_config,json=typedConfig,proto3,oneof"`
}

type Route 

type Route struct {

	// Name for the route.
	Name string `protobuf:"bytes,14,opt,name=name,proto3" json:"name,omitempty"`
	// Route matching parameters.
	Match *RouteMatch `protobuf:"bytes,1,opt,name=match,proto3" json:"match,omitempty"`
	// Types that are assignable to Action:
	//
	//	*Route_Route
	//	*Route_Redirect
	//	*Route_DirectResponse
	Action isRoute_Action `protobuf_oneof:"action"`
	// The Metadata field can be used to provide additional information
	// about the route. It can be used for configuration, stats, and logging.
	// The metadata should go under the filter namespace that will need it.
	// For instance, if the metadata is intended for the Router filter,
	// the filter name should be specified as *envoy.filters.http.router*.
	Metadata *core.Metadata `protobuf:"bytes,4,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Decorator for the matched route.
	Decorator *Decorator `protobuf:"bytes,5,opt,name=decorator,proto3" json:"decorator,omitempty"`
	// The per_filter_config field can be used to provide route-specific
	// configurations for filters. The key should match the filter name, such as
	// *envoy.filters.http.buffer* for the HTTP buffer filter. Use of this field is filter
	// specific; see the `HTTP filter documentation (config_http_filters)` for
	// if and how it is utilized.
	PerFilterConfig map[string]*_struct.Struct `` /* 196-byte string literal not displayed */
	// The per_filter_config field can be used to provide route-specific
	// configurations for filters. The key should match the filter name, such as
	// *envoy.filters.http.buffer* for the HTTP buffer filter. Use of this field is filter
	// specific; see the `HTTP filter documentation (config_http_filters)` for
	// if and how it is utilized.
	TypedPerFilterConfig map[string]*any1.Any `` /* 214-byte string literal not displayed */
	// Specifies a set of headers that will be added to requests matching this
	// route. Headers specified at this level are applied before headers from the
	// enclosing `envoy_api_msg_route.VirtualHost` and
	// `envoy_api_msg_RouteConfiguration`. For more information, including details on
	// header value syntax, see the documentation on `custom request headers
	// (config_http_conn_man_headers_custom_request_headers)`.
	RequestHeadersToAdd []*core.HeaderValueOption `protobuf:"bytes,9,rep,name=request_headers_to_add,json=requestHeadersToAdd,proto3" json:"request_headers_to_add,omitempty"`
	// Specifies a list of HTTP headers that should be removed from each request
	// matching this route.
	RequestHeadersToRemove []string `` /* 132-byte string literal not displayed */
	// Specifies a set of headers that will be added to responses to requests
	// matching this route. Headers specified at this level are applied before
	// headers from the enclosing `envoy_api_msg_route.VirtualHost` and
	// `envoy_api_msg_RouteConfiguration`. For more information, including
	// details on header value syntax, see the documentation on
	// `custom request headers (config_http_conn_man_headers_custom_request_headers)`.
	ResponseHeadersToAdd []*core.HeaderValueOption `` /* 126-byte string literal not displayed */
	// Specifies a list of HTTP headers that should be removed from each response
	// to requests matching this route.
	ResponseHeadersToRemove []string `` /* 135-byte string literal not displayed */
	// Presence of the object defines whether the connection manager's tracing configuration
	// is overridden by this route specific instance.
	Tracing *Tracing `protobuf:"bytes,15,opt,name=tracing,proto3" json:"tracing,omitempty"`
	// contains filtered or unexported fields
}

A route is both a specification of how to match a request as well as an indication of what to do next (e.g., redirect, forward, rewrite, etc.). 

Envoy supports routing on HTTP method via `header matching
(envoy_api_msg_route.HeaderMatcher)`.

func (*Route) Clone added in v1.8.24 

func (m *Route) Clone() proto.Message

Clone function

func (*Route) Descriptor deprecated 

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

Deprecated: Use Route.ProtoReflect.Descriptor instead.

func (*Route) Equal 

func (m *Route) Equal(that interface{}) bool

Equal function

func (*Route) GetAction 

func (m *Route) GetAction() isRoute_Action

func (*Route) GetDecorator 

func (x *Route) GetDecorator() *Decorator

func (*Route) GetDirectResponse 

func (x *Route) GetDirectResponse() *DirectResponseAction

func (*Route) GetMatch 

func (x *Route) GetMatch() *RouteMatch

func (*Route) GetMetadata 

func (x *Route) GetMetadata() *core.Metadata

func (*Route) GetName 

func (x *Route) GetName() string

func (*Route) GetPerFilterConfig 

func (x *Route) GetPerFilterConfig() map[string]*_struct.Struct

func (*Route) GetRedirect 

func (x *Route) GetRedirect() *RedirectAction

func (*Route) GetRequestHeadersToAdd 

func (x *Route) GetRequestHeadersToAdd() []*core.HeaderValueOption

func (*Route) GetRequestHeadersToRemove 

func (x *Route) GetRequestHeadersToRemove() []string

func (*Route) GetResponseHeadersToAdd 

func (x *Route) GetResponseHeadersToAdd() []*core.HeaderValueOption

func (*Route) GetResponseHeadersToRemove 

func (x *Route) GetResponseHeadersToRemove() []string

func (*Route) GetRoute 

func (x *Route) GetRoute() *RouteAction

func (*Route) GetTracing 

func (x *Route) GetTracing() *Tracing

func (*Route) GetTypedPerFilterConfig 

func (x *Route) GetTypedPerFilterConfig() map[string]*any1.Any

func (*Route) Hash added in v1.2.13 

func (m *Route) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*Route) ProtoMessage 

func (*Route) ProtoMessage()

func (*Route) ProtoReflect added in v1.6.0 

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

func (*Route) Reset 

func (x *Route) Reset()

func (*Route) String 

func (x *Route) String() string

type RouteAction 

type RouteAction struct {

	// Types that are assignable to ClusterSpecifier:
	//
	//	*RouteAction_Cluster
	//	*RouteAction_ClusterHeader
	//	*RouteAction_WeightedClusters
	ClusterSpecifier isRouteAction_ClusterSpecifier `protobuf_oneof:"cluster_specifier"`
	// The HTTP status code to use when configured cluster is not found.
	// The default response code is 503 Service Unavailable.
	ClusterNotFoundResponseCode RouteAction_ClusterNotFoundResponseCode `` /* 222-byte string literal not displayed */
	// Optional endpoint metadata match criteria used by the subset load balancer. Only endpoints
	// in the upstream cluster with metadata matching what's set in this field will be considered
	// for load balancing. If using `weighted_clusters
	// (envoy_api_field_route.RouteAction.weighted_clusters)`, metadata will be merged, with values
	// provided there taking precedence. The filter name should be specified as *envoy.lb*.
	MetadataMatch *core.Metadata `protobuf:"bytes,4,opt,name=metadata_match,json=metadataMatch,proto3" json:"metadata_match,omitempty"`
	// Indicates that during forwarding, the matched prefix (or path) should be
	// swapped with this value. This option allows application URLs to be rooted
	// at a different path from those exposed at the reverse proxy layer. The router filter will
	// place the original path before rewrite into the `x-envoy-original-path
	// (config_http_filters_router_x-envoy-original-path)` header.
	//
	//	Pay careful attention to the use of trailing slashes in the
	//	`route's match (envoy_api_field_route.Route.match)` prefix value.
	//	Stripping a prefix from a path requires multiple Routes to handle all cases. For example,
	//	rewriting */prefix* to */* and */prefix/etc* to */etc* cannot be done in a single
	//	`Route (envoy_api_msg_route.Route)`, as shown by the below config entries:
	//
	//	“`
	//	  - match:
	//	      prefix: "/prefix/"
	//	    route:
	//	      prefix_rewrite: "/"
	//	  - match:
	//	      prefix: "/prefix"
	//	    route:
	//	      prefix_rewrite: "/"
	//	“`
	//	Having above entries in the config, requests to */prefix* will be stripped to */*, while
	//	requests to */prefix/etc* will be stripped to */etc*.
	PrefixRewrite string `protobuf:"bytes,5,opt,name=prefix_rewrite,json=prefixRewrite,proto3" json:"prefix_rewrite,omitempty"`
	// Types that are assignable to HostRewriteSpecifier:
	//
	//	*RouteAction_HostRewrite
	//	*RouteAction_AutoHostRewrite
	//	*RouteAction_AutoHostRewriteHeader
	HostRewriteSpecifier isRouteAction_HostRewriteSpecifier `protobuf_oneof:"host_rewrite_specifier"`
	// Specifies the upstream timeout for the route. If not specified, the default is 15s. This
	// spans between the point at which the entire downstream request (i.e. end-of-stream) has been
	// processed and when the upstream response has been completely processed.
	//
	//	This timeout includes all retries. See also
	//	`config_http_filters_router_x-envoy-upstream-rq-timeout-ms`,
	//	`config_http_filters_router_x-envoy-upstream-rq-per-try-timeout-ms`, and the
	//	`retry overview (arch_overview_http_routing_retry)`.
	Timeout *duration.Duration `protobuf:"bytes,8,opt,name=timeout,proto3" json:"timeout,omitempty"`
	// Specifies the idle timeout for the route. If not specified, there is no per-route idle timeout,
	// although the connection manager wide `stream_idle_timeout
	// (envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.stream_idle_timeout)`
	// will still apply. A value of 0 will completely disable the route's idle timeout, even if a
	// connection manager stream idle timeout is configured.
	//
	// The idle timeout is distinct to `timeout
	// (envoy_api_field_route.RouteAction.timeout)`, which provides an upper bound
	// on the upstream response time; `idle_timeout
	// (envoy_api_field_route.RouteAction.idle_timeout)` instead bounds the amount
	// of time the request's stream may be idle.
	//
	// After header decoding, the idle timeout will apply on downstream and
	// upstream request events. Each time an encode/decode event for headers or
	// data is processed for the stream, the timer will be reset. If the timeout
	// fires, the stream is terminated with a 408 Request Timeout error code if no
	// upstream response header has been received, otherwise a stream reset
	// occurs.
	IdleTimeout *duration.Duration `protobuf:"bytes,24,opt,name=idle_timeout,json=idleTimeout,proto3" json:"idle_timeout,omitempty"`
	// Indicates that the route has a retry policy. Note that if this is set,
	// it'll take precedence over the virtual host level retry policy entirely
	// (e.g.: policies are not merged, most internal one becomes the enforced policy).
	RetryPolicy *RetryPolicy `protobuf:"bytes,9,opt,name=retry_policy,json=retryPolicy,proto3" json:"retry_policy,omitempty"`
	// Indicates that the route has a request mirroring policy.
	RequestMirrorPolicy *RouteAction_RequestMirrorPolicy `protobuf:"bytes,10,opt,name=request_mirror_policy,json=requestMirrorPolicy,proto3" json:"request_mirror_policy,omitempty"`
	// Optionally specifies the `routing priority (arch_overview_http_routing_priority)`.
	// https://github.com/lyft/protoc-gen-validate/issues/42 is resolved.]
	Priority core.RoutingPriority `protobuf:"varint,11,opt,name=priority,proto3,enum=solo.io.envoy.api.v2.core.RoutingPriority" json:"priority,omitempty"`
	// Specifies a set of rate limit configurations that could be applied to the
	// route.
	RateLimits []*RateLimit `protobuf:"bytes,13,rep,name=rate_limits,json=rateLimits,proto3" json:"rate_limits,omitempty"`
	// Specifies if the rate limit filter should include the virtual host rate
	// limits. By default, if the route configured rate limits, the virtual host
	// `rate_limits (envoy_api_field_route.VirtualHost.rate_limits)` are not applied to the
	// request.
	IncludeVhRateLimits *wrappers.BoolValue `protobuf:"bytes,14,opt,name=include_vh_rate_limits,json=includeVhRateLimits,proto3" json:"include_vh_rate_limits,omitempty"`
	// Specifies a list of hash policies to use for ring hash load balancing. Each
	// hash policy is evaluated individually and the combined result is used to
	// route the request. The method of combination is deterministic such that
	// identical lists of hash policies will produce the same hash. Since a hash
	// policy examines specific parts of a request, it can fail to produce a hash
	// (i.e. if the hashed header is not present). If (and only if) all configured
	// hash policies fail to generate a hash, no hash will be produced for
	// the route. In this case, the behavior is the same as if no hash policies
	// were specified (i.e. the ring hash load balancer will choose a random
	// backend). If a hash policy has the "terminal" attribute set to true, and
	// there is already a hash generated, the hash is returned immediately,
	// ignoring the rest of the hash policy list.
	HashPolicy []*RouteAction_HashPolicy `protobuf:"bytes,15,rep,name=hash_policy,json=hashPolicy,proto3" json:"hash_policy,omitempty"`
	// Indicates that the route has a CORS policy.
	Cors *CorsPolicy `protobuf:"bytes,17,opt,name=cors,proto3" json:"cors,omitempty"`
	// If present, and the request is a gRPC request, use the
	// `grpc-timeout header <https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md>`_,
	// or its default value (infinity) instead of
	// `timeout (envoy_api_field_route.RouteAction.timeout)`, but limit the applied timeout
	// to the maximum value specified here. If configured as 0, the maximum allowed timeout for
	// gRPC requests is infinity. If not configured at all, the `grpc-timeout` header is not used
	// and gRPC requests time out like any other requests using
	// `timeout (envoy_api_field_route.RouteAction.timeout)` or its default.
	// This can be used to prevent unexpected upstream request timeouts due to potentially long
	// time gaps between gRPC request and response in gRPC streaming mode.
	MaxGrpcTimeout *duration.Duration `protobuf:"bytes,23,opt,name=max_grpc_timeout,json=maxGrpcTimeout,proto3" json:"max_grpc_timeout,omitempty"`
	// If present, Envoy will adjust the timeout provided by the `grpc-timeout` header by subtracting
	// the provided duration from the header. This is useful in allowing Envoy to set its global
	// timeout to be less than that of the deadline imposed by the calling client, which makes it more
	// likely that Envoy will handle the timeout instead of having the call canceled by the client.
	// The offset will only be applied if the provided grpc_timeout is greater than the offset. This
	// ensures that the offset will only ever decrease the timeout and never set it to 0 (meaning
	// infinity).
	GrpcTimeoutOffset      *duration.Duration                 `protobuf:"bytes,28,opt,name=grpc_timeout_offset,json=grpcTimeoutOffset,proto3" json:"grpc_timeout_offset,omitempty"`
	UpgradeConfigs         []*RouteAction_UpgradeConfig       `protobuf:"bytes,25,rep,name=upgrade_configs,json=upgradeConfigs,proto3" json:"upgrade_configs,omitempty"`
	InternalRedirectAction RouteAction_InternalRedirectAction `` /* 198-byte string literal not displayed */
	// Indicates that the route has a hedge policy. Note that if this is set,
	// it'll take precedence over the virtual host level hedge policy entirely
	// (e.g.: policies are not merged, most internal one becomes the enforced policy).
	HedgePolicy *HedgePolicy `protobuf:"bytes,27,opt,name=hedge_policy,json=hedgePolicy,proto3" json:"hedge_policy,omitempty"`
	// contains filtered or unexported fields
}

func (*RouteAction) Clone added in v1.8.24 

func (m *RouteAction) Clone() proto.Message

Clone function

func (*RouteAction) Descriptor deprecated 

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

Deprecated: Use RouteAction.ProtoReflect.Descriptor instead.

func (*RouteAction) Equal 

func (m *RouteAction) Equal(that interface{}) bool

Equal function

func (*RouteAction) GetAutoHostRewrite 

func (x *RouteAction) GetAutoHostRewrite() *wrappers.BoolValue

func (*RouteAction) GetAutoHostRewriteHeader 

func (x *RouteAction) GetAutoHostRewriteHeader() string

func (*RouteAction) GetCluster 

func (x *RouteAction) GetCluster() string

func (*RouteAction) GetClusterHeader 

func (x *RouteAction) GetClusterHeader() string

func (*RouteAction) GetClusterNotFoundResponseCode 

func (x *RouteAction) GetClusterNotFoundResponseCode() RouteAction_ClusterNotFoundResponseCode

func (*RouteAction) GetClusterSpecifier 

func (m *RouteAction) GetClusterSpecifier() isRouteAction_ClusterSpecifier

func (*RouteAction) GetCors 

func (x *RouteAction) GetCors() *CorsPolicy

func (*RouteAction) GetGrpcTimeoutOffset 

func (x *RouteAction) GetGrpcTimeoutOffset() *duration.Duration

func (*RouteAction) GetHashPolicy 

func (x *RouteAction) GetHashPolicy() []*RouteAction_HashPolicy

func (*RouteAction) GetHedgePolicy 

func (x *RouteAction) GetHedgePolicy() *HedgePolicy

func (*RouteAction) GetHostRewrite 

func (x *RouteAction) GetHostRewrite() string

func (*RouteAction) GetHostRewriteSpecifier 

func (m *RouteAction) GetHostRewriteSpecifier() isRouteAction_HostRewriteSpecifier

func (*RouteAction) GetIdleTimeout 

func (x *RouteAction) GetIdleTimeout() *duration.Duration

func (*RouteAction) GetIncludeVhRateLimits 

func (x *RouteAction) GetIncludeVhRateLimits() *wrappers.BoolValue

func (*RouteAction) GetInternalRedirectAction 

func (x *RouteAction) GetInternalRedirectAction() RouteAction_InternalRedirectAction

func (*RouteAction) GetMaxGrpcTimeout 

func (x *RouteAction) GetMaxGrpcTimeout() *duration.Duration

func (*RouteAction) GetMetadataMatch 

func (x *RouteAction) GetMetadataMatch() *core.Metadata

func (*RouteAction) GetPrefixRewrite 

func (x *RouteAction) GetPrefixRewrite() string

func (*RouteAction) GetPriority 

func (x *RouteAction) GetPriority() core.RoutingPriority

func (*RouteAction) GetRateLimits 

func (x *RouteAction) GetRateLimits() []*RateLimit

func (*RouteAction) GetRequestMirrorPolicy 

func (x *RouteAction) GetRequestMirrorPolicy() *RouteAction_RequestMirrorPolicy

func (*RouteAction) GetRetryPolicy 

func (x *RouteAction) GetRetryPolicy() *RetryPolicy

func (*RouteAction) GetTimeout 

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

func (*RouteAction) GetUpgradeConfigs 

func (x *RouteAction) GetUpgradeConfigs() []*RouteAction_UpgradeConfig

func (*RouteAction) GetWeightedClusters 

func (x *RouteAction) GetWeightedClusters() *WeightedCluster

func (*RouteAction) Hash added in v1.2.13 

func (m *RouteAction) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*RouteAction) ProtoMessage 

func (*RouteAction) ProtoMessage()

func (*RouteAction) ProtoReflect added in v1.6.0 

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

func (*RouteAction) Reset 

func (x *RouteAction) Reset()

func (*RouteAction) String 

func (x *RouteAction) String() string

type RouteAction_AutoHostRewrite 

type RouteAction_AutoHostRewrite struct {
	// Indicates that during forwarding, the host header will be swapped with
	// the hostname of the upstream host chosen by the cluster manager. This
	// option is applicable only when the destination cluster for a route is of
	// type *strict_dns* or *logical_dns*. Setting this to true with other cluster
	// types has no effect.
	AutoHostRewrite *wrappers.BoolValue `protobuf:"bytes,7,opt,name=auto_host_rewrite,json=autoHostRewrite,proto3,oneof"`
}

type RouteAction_AutoHostRewriteHeader 

type RouteAction_AutoHostRewriteHeader struct {
	// Indicates that during forwarding, the host header will be swapped with the content of given
	// downstream or `custom (config_http_conn_man_headers_custom_request_headers)` header.
	// If header value is empty, host header is left intact.
	//
	//	Pay attention to the potential security implications of using this option. Provided header
	//	must come from trusted source.
	AutoHostRewriteHeader string `protobuf:"bytes,29,opt,name=auto_host_rewrite_header,json=autoHostRewriteHeader,proto3,oneof"`
}

type RouteAction_Cluster 

type RouteAction_Cluster struct {
	// Indicates the upstream cluster to which the request should be routed
	// to.
	Cluster string `protobuf:"bytes,1,opt,name=cluster,proto3,oneof"`
}

type RouteAction_ClusterHeader 

type RouteAction_ClusterHeader struct {
	// Envoy will determine the cluster to route to by reading the value of the
	// HTTP header named by cluster_header from the request headers. If the
	// header is not found or the referenced cluster does not exist, Envoy will
	// return a 404 response.
	//
	//	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.
	ClusterHeader string `protobuf:"bytes,2,opt,name=cluster_header,json=clusterHeader,proto3,oneof"`
}

type RouteAction_ClusterNotFoundResponseCode 

type RouteAction_ClusterNotFoundResponseCode int32
const (
	// HTTP status code - 503 Service Unavailable.
	RouteAction_SERVICE_UNAVAILABLE RouteAction_ClusterNotFoundResponseCode = 0
	// HTTP status code - 404 Not Found.
	RouteAction_NOT_FOUND RouteAction_ClusterNotFoundResponseCode = 1
)

func (RouteAction_ClusterNotFoundResponseCode) Descriptor added in v1.6.0 

func (RouteAction_ClusterNotFoundResponseCode) Descriptor() protoreflect.EnumDescriptor

func (RouteAction_ClusterNotFoundResponseCode) Enum added in v1.6.0 

func (x RouteAction_ClusterNotFoundResponseCode) Enum() *RouteAction_ClusterNotFoundResponseCode

func (RouteAction_ClusterNotFoundResponseCode) EnumDescriptor deprecated 

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

Deprecated: Use RouteAction_ClusterNotFoundResponseCode.Descriptor instead.

func (RouteAction_ClusterNotFoundResponseCode) Number added in v1.6.0 

func (x RouteAction_ClusterNotFoundResponseCode) Number() protoreflect.EnumNumber

func (RouteAction_ClusterNotFoundResponseCode) String 

func (x RouteAction_ClusterNotFoundResponseCode) String() string

func (RouteAction_ClusterNotFoundResponseCode) Type added in v1.6.0 

func (RouteAction_ClusterNotFoundResponseCode) Type() protoreflect.EnumType

type RouteAction_HashPolicy 

type RouteAction_HashPolicy struct {

	// Types that are assignable to PolicySpecifier:
	//
	//	*RouteAction_HashPolicy_Header_
	//	*RouteAction_HashPolicy_Cookie_
	//	*RouteAction_HashPolicy_ConnectionProperties_
	PolicySpecifier isRouteAction_HashPolicy_PolicySpecifier `protobuf_oneof:"policy_specifier"`
	// The flag that shortcircuits the hash computing. This field provides a
	// 'fallback' style of configuration: "if a terminal policy doesn't work,
	// fallback to rest of the policy list", it saves time when the terminal
	// policy works.
	//
	// If true, and there is already a hash computed, ignore rest of the
	// list of hash polices.
	// For example, if the following hash methods are configured:
	//
	//	========= ========
	//	specifier terminal
	//	========= ========
	//	Header A  true
	//	Header B  false
	//	Header C  false
	//	========= ========
	//
	// The generateHash process ends if policy "header A" generates a hash, as
	// it's a terminal policy.
	Terminal bool `protobuf:"varint,4,opt,name=terminal,proto3" json:"terminal,omitempty"`
	// contains filtered or unexported fields
}

Specifies the route's hashing policy if the upstream cluster uses a hashing `load balancer (arch_overview_load_balancing_types)`.

func (*RouteAction_HashPolicy) Clone added in v1.8.24 

func (m *RouteAction_HashPolicy) Clone() proto.Message

Clone function

func (*RouteAction_HashPolicy) Descriptor deprecated 

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

Deprecated: Use RouteAction_HashPolicy.ProtoReflect.Descriptor instead.

func (*RouteAction_HashPolicy) Equal 

func (m *RouteAction_HashPolicy) Equal(that interface{}) bool

Equal function

func (*RouteAction_HashPolicy) GetConnectionProperties 

func (x *RouteAction_HashPolicy) GetConnectionProperties() *RouteAction_HashPolicy_ConnectionProperties

func (*RouteAction_HashPolicy) GetCookie 

func (x *RouteAction_HashPolicy) GetCookie() *RouteAction_HashPolicy_Cookie

func (*RouteAction_HashPolicy) GetHeader 

func (x *RouteAction_HashPolicy) GetHeader() *RouteAction_HashPolicy_Header

func (*RouteAction_HashPolicy) GetPolicySpecifier 

func (m *RouteAction_HashPolicy) GetPolicySpecifier() isRouteAction_HashPolicy_PolicySpecifier

func (*RouteAction_HashPolicy) GetTerminal 

func (x *RouteAction_HashPolicy) GetTerminal() bool

func (*RouteAction_HashPolicy) Hash added in v1.2.13 

func (m *RouteAction_HashPolicy) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*RouteAction_HashPolicy) ProtoMessage 

func (*RouteAction_HashPolicy) ProtoMessage()

func (*RouteAction_HashPolicy) ProtoReflect added in v1.6.0 

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

func (*RouteAction_HashPolicy) Reset 

func (x *RouteAction_HashPolicy) Reset()

func (*RouteAction_HashPolicy) String 

func (x *RouteAction_HashPolicy) String() string

type RouteAction_HashPolicy_ConnectionProperties 

type RouteAction_HashPolicy_ConnectionProperties struct {

	// Hash on source IP address.
	SourceIp bool `protobuf:"varint,1,opt,name=source_ip,json=sourceIp,proto3" json:"source_ip,omitempty"`
	// contains filtered or unexported fields
}

func (*RouteAction_HashPolicy_ConnectionProperties) Clone added in v1.8.24 

func (m *RouteAction_HashPolicy_ConnectionProperties) Clone() proto.Message

Clone function

func (*RouteAction_HashPolicy_ConnectionProperties) Descriptor deprecated 

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

Deprecated: Use RouteAction_HashPolicy_ConnectionProperties.ProtoReflect.Descriptor instead.

func (*RouteAction_HashPolicy_ConnectionProperties) Equal 

func (m *RouteAction_HashPolicy_ConnectionProperties) Equal(that interface{}) bool

Equal function

func (*RouteAction_HashPolicy_ConnectionProperties) GetSourceIp 

func (x *RouteAction_HashPolicy_ConnectionProperties) GetSourceIp() bool

func (*RouteAction_HashPolicy_ConnectionProperties) Hash added in v1.2.13 

func (m *RouteAction_HashPolicy_ConnectionProperties) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*RouteAction_HashPolicy_ConnectionProperties) ProtoMessage 

func (*RouteAction_HashPolicy_ConnectionProperties) ProtoMessage()

func (*RouteAction_HashPolicy_ConnectionProperties) ProtoReflect added in v1.6.0 

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

func (*RouteAction_HashPolicy_ConnectionProperties) Reset 

func (x *RouteAction_HashPolicy_ConnectionProperties) Reset()

func (*RouteAction_HashPolicy_ConnectionProperties) String 

func (x *RouteAction_HashPolicy_ConnectionProperties) String() string

type RouteAction_HashPolicy_ConnectionProperties_ 

type RouteAction_HashPolicy_ConnectionProperties_ struct {
	// Connection properties hash policy.
	ConnectionProperties *RouteAction_HashPolicy_ConnectionProperties `protobuf:"bytes,3,opt,name=connection_properties,json=connectionProperties,proto3,oneof"`
}
type RouteAction_HashPolicy_Cookie struct {

	// The name of the cookie that will be used to obtain the hash key. If the
	// cookie is not present and ttl below is not set, no hash will be
	// produced.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// If specified, a cookie with the TTL will be generated if the cookie is
	// not present. If the TTL is present and zero, the generated cookie will
	// be a session cookie.
	Ttl *duration.Duration `protobuf:"bytes,2,opt,name=ttl,proto3" json:"ttl,omitempty"`
	// The name of the path for the cookie. If no path is specified here, no path
	// will be set for the cookie.
	Path string `protobuf:"bytes,3,opt,name=path,proto3" json:"path,omitempty"`
	// contains filtered or unexported fields
}

Envoy supports two types of cookie affinity:

  1. Passive. Envoy takes a cookie that's present in the cookies header and hashes on its value.

  2. Generated. Envoy generates and sets a cookie with an expiration (TTL) on the first request from the client in its response to the client, based on the endpoint the request gets sent to. The client then presents this on the next and all subsequent requests. The hash of this is sufficient to ensure these requests get sent to the same endpoint. The cookie is generated by hashing the source and destination ports and addresses so that multiple independent HTTP2 streams on the same connection will independently receive the same cookie, even if they arrive at the Envoy simultaneously.

func (*RouteAction_HashPolicy_Cookie) Clone added in v1.8.24 

func (m *RouteAction_HashPolicy_Cookie) Clone() proto.Message

Clone function

func (*RouteAction_HashPolicy_Cookie) Descriptor deprecated 

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

Deprecated: Use RouteAction_HashPolicy_Cookie.ProtoReflect.Descriptor instead.

func (*RouteAction_HashPolicy_Cookie) Equal 

func (m *RouteAction_HashPolicy_Cookie) Equal(that interface{}) bool

Equal function

func (*RouteAction_HashPolicy_Cookie) GetName 

func (x *RouteAction_HashPolicy_Cookie) GetName() string

func (*RouteAction_HashPolicy_Cookie) GetPath 

func (x *RouteAction_HashPolicy_Cookie) GetPath() string

func (*RouteAction_HashPolicy_Cookie) GetTtl 

func (x *RouteAction_HashPolicy_Cookie) GetTtl() *duration.Duration

func (*RouteAction_HashPolicy_Cookie) Hash added in v1.2.13 

func (m *RouteAction_HashPolicy_Cookie) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*RouteAction_HashPolicy_Cookie) ProtoMessage 

func (*RouteAction_HashPolicy_Cookie) ProtoMessage()

func (*RouteAction_HashPolicy_Cookie) ProtoReflect added in v1.6.0 

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

func (*RouteAction_HashPolicy_Cookie) Reset 

func (x *RouteAction_HashPolicy_Cookie) Reset()

func (*RouteAction_HashPolicy_Cookie) String 

func (x *RouteAction_HashPolicy_Cookie) String() string

type RouteAction_HashPolicy_Cookie_ 

type RouteAction_HashPolicy_Cookie_ struct {
	// Cookie hash policy.
	Cookie *RouteAction_HashPolicy_Cookie `protobuf:"bytes,2,opt,name=cookie,proto3,oneof"`
}

type RouteAction_HashPolicy_Header 

type RouteAction_HashPolicy_Header struct {

	// The name of the request header that will be used to obtain the hash
	// key. If the request header is not present, no hash will be produced.
	HeaderName string `protobuf:"bytes,1,opt,name=header_name,json=headerName,proto3" json:"header_name,omitempty"`
	// contains filtered or unexported fields
}

func (*RouteAction_HashPolicy_Header) Clone added in v1.8.24 

func (m *RouteAction_HashPolicy_Header) Clone() proto.Message

Clone function

func (*RouteAction_HashPolicy_Header) Descriptor deprecated 

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

Deprecated: Use RouteAction_HashPolicy_Header.ProtoReflect.Descriptor instead.

func (*RouteAction_HashPolicy_Header) Equal 

func (m *RouteAction_HashPolicy_Header) Equal(that interface{}) bool

Equal function

func (*RouteAction_HashPolicy_Header) GetHeaderName 

func (x *RouteAction_HashPolicy_Header) GetHeaderName() string

func (*RouteAction_HashPolicy_Header) Hash added in v1.2.13 

func (m *RouteAction_HashPolicy_Header) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*RouteAction_HashPolicy_Header) ProtoMessage 

func (*RouteAction_HashPolicy_Header) ProtoMessage()

func (*RouteAction_HashPolicy_Header) ProtoReflect added in v1.6.0 

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

func (*RouteAction_HashPolicy_Header) Reset 

func (x *RouteAction_HashPolicy_Header) Reset()

func (*RouteAction_HashPolicy_Header) String 

func (x *RouteAction_HashPolicy_Header) String() string

type RouteAction_HashPolicy_Header_ 

type RouteAction_HashPolicy_Header_ struct {
	// Header hash policy.
	Header *RouteAction_HashPolicy_Header `protobuf:"bytes,1,opt,name=header,proto3,oneof"`
}

type RouteAction_HostRewrite 

type RouteAction_HostRewrite struct {
	// Indicates that during forwarding, the host header will be swapped with
	// this value.
	HostRewrite string `protobuf:"bytes,6,opt,name=host_rewrite,json=hostRewrite,proto3,oneof"`
}

type RouteAction_InternalRedirectAction 

type RouteAction_InternalRedirectAction int32

Configures `internal redirect (arch_overview_internal_redirects)` behavior. 

const (
	RouteAction_PASS_THROUGH_INTERNAL_REDIRECT RouteAction_InternalRedirectAction = 0
	RouteAction_HANDLE_INTERNAL_REDIRECT       RouteAction_InternalRedirectAction = 1
)

func (RouteAction_InternalRedirectAction) Descriptor added in v1.6.0 

func (RouteAction_InternalRedirectAction) Descriptor() protoreflect.EnumDescriptor

func (RouteAction_InternalRedirectAction) Enum added in v1.6.0 

func (x RouteAction_InternalRedirectAction) Enum() *RouteAction_InternalRedirectAction

func (RouteAction_InternalRedirectAction) EnumDescriptor deprecated 

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

Deprecated: Use RouteAction_InternalRedirectAction.Descriptor instead.

func (RouteAction_InternalRedirectAction) Number added in v1.6.0 

func (x RouteAction_InternalRedirectAction) Number() protoreflect.EnumNumber

func (RouteAction_InternalRedirectAction) String 

func (x RouteAction_InternalRedirectAction) String() string

func (RouteAction_InternalRedirectAction) Type added in v1.6.0 

func (RouteAction_InternalRedirectAction) Type() protoreflect.EnumType

type RouteAction_RequestMirrorPolicy 

type RouteAction_RequestMirrorPolicy struct {

	// Specifies the cluster that requests will be mirrored to. The cluster must
	// exist in the cluster manager configuration.
	Cluster string `protobuf:"bytes,1,opt,name=cluster,proto3" json:"cluster,omitempty"`
	// If not specified, all requests to the target cluster will be mirrored. If
	// specified, Envoy will lookup the runtime key to get the % of requests to
	// mirror. Valid values are from 0 to 10000, allowing for increments of
	// 0.01% of requests to be mirrored. If the runtime key is specified in the
	// configuration but not present in runtime, 0 is the default and thus 0% of
	// requests will be mirrored.
	//
	//	**This field is deprecated**. Set the
	//	`runtime_fraction
	//	(envoy_api_field_route.RouteAction.RequestMirrorPolicy.runtime_fraction)` field instead.
	//
	// Deprecated: Marked as deprecated in github.com/solo-io/gloo/projects/gloo/api/external/envoy/api/v2/route/route.proto.
	RuntimeKey string `protobuf:"bytes,2,opt,name=runtime_key,json=runtimeKey,proto3" json:"runtime_key,omitempty"`
	// If both `runtime_key
	// (envoy_api_field_route.RouteAction.RequestMirrorPolicy.runtime_key)` and this field are not
	// specified, all requests to the target cluster will be mirrored.
	//
	// If specified, this field takes precedence over the `runtime_key` field and requests must also
	// fall under the percentage of matches indicated by this field.
	//
	// For some fraction N/D, a random number in the range [0,D) is selected. If the
	// number is <= the value of the numerator N, or if the key is not present, the default
	// value, the request will be mirrored.
	//
	//	Parsing this field is implemented such that the runtime key's data may be represented
	//	as a `FractionalPercent (envoy_api_msg_type.FractionalPercent)` proto represented
	//	as JSON/YAML and may also be represented as an integer with the assumption that the value
	//	is an integral percentage out of 100. For instance, a runtime key lookup returning the
	//	value "42" would parse as a `FractionalPercent` whose numerator is 42 and denominator is
	//	HUNDRED. This is behaviour is different to that of the deprecated `runtime_key` field,
	//	where the implicit denominator is 10000.
	RuntimeFraction *core.RuntimeFractionalPercent `protobuf:"bytes,3,opt,name=runtime_fraction,json=runtimeFraction,proto3" json:"runtime_fraction,omitempty"`
	// contains filtered or unexported fields
}

The router is capable of shadowing traffic from one cluster to another. The current implementation is "fire and forget," meaning Envoy will not wait for the shadow cluster to respond before returning the response from the primary cluster. All normal statistics are collected for the shadow cluster making this feature useful for testing.

During shadowing, the host/authority header is altered such that *-shadow* is appended. This is useful for logging. For example, *cluster1* becomes *cluster1-shadow*.

func (*RouteAction_RequestMirrorPolicy) Clone added in v1.8.24 

func (m *RouteAction_RequestMirrorPolicy) Clone() proto.Message

Clone function

func (*RouteAction_RequestMirrorPolicy) Descriptor deprecated 

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

Deprecated: Use RouteAction_RequestMirrorPolicy.ProtoReflect.Descriptor instead.

func (*RouteAction_RequestMirrorPolicy) Equal 

func (m *RouteAction_RequestMirrorPolicy) Equal(that interface{}) bool

Equal function

func (*RouteAction_RequestMirrorPolicy) GetCluster 

func (x *RouteAction_RequestMirrorPolicy) GetCluster() string

func (*RouteAction_RequestMirrorPolicy) GetRuntimeFraction 

func (x *RouteAction_RequestMirrorPolicy) GetRuntimeFraction() *core.RuntimeFractionalPercent

func (*RouteAction_RequestMirrorPolicy) GetRuntimeKey deprecated 

func (x *RouteAction_RequestMirrorPolicy) GetRuntimeKey() string

Deprecated: Marked as deprecated in github.com/solo-io/gloo/projects/gloo/api/external/envoy/api/v2/route/route.proto.

func (*RouteAction_RequestMirrorPolicy) Hash added in v1.2.13 

func (m *RouteAction_RequestMirrorPolicy) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*RouteAction_RequestMirrorPolicy) ProtoMessage 

func (*RouteAction_RequestMirrorPolicy) ProtoMessage()

func (*RouteAction_RequestMirrorPolicy) ProtoReflect added in v1.6.0 

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

func (*RouteAction_RequestMirrorPolicy) Reset 

func (x *RouteAction_RequestMirrorPolicy) Reset()

func (*RouteAction_RequestMirrorPolicy) String 

func (x *RouteAction_RequestMirrorPolicy) String() string

type RouteAction_UpgradeConfig 

type RouteAction_UpgradeConfig struct {

	// The case-insensitive name of this upgrade, e.g. "websocket".
	// For each upgrade type present in upgrade_configs, requests with
	// Upgrade: [upgrade_type] will be proxied upstream.
	UpgradeType string `protobuf:"bytes,1,opt,name=upgrade_type,json=upgradeType,proto3" json:"upgrade_type,omitempty"`
	// Determines if upgrades are available on this route. Defaults to true.
	Enabled *wrappers.BoolValue `protobuf:"bytes,2,opt,name=enabled,proto3" json:"enabled,omitempty"`
	// contains filtered or unexported fields
}

Allows enabling and disabling upgrades on a per-route basis. This overrides any enabled/disabled upgrade filter chain specified in the HttpConnectionManager `upgrade_configs (envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.upgrade_configs)` but does not affect any custom filter chain specified there.

func (*RouteAction_UpgradeConfig) Clone added in v1.8.24 

func (m *RouteAction_UpgradeConfig) Clone() proto.Message

Clone function

func (*RouteAction_UpgradeConfig) Descriptor deprecated 

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

Deprecated: Use RouteAction_UpgradeConfig.ProtoReflect.Descriptor instead.

func (*RouteAction_UpgradeConfig) Equal 

func (m *RouteAction_UpgradeConfig) Equal(that interface{}) bool

Equal function

func (*RouteAction_UpgradeConfig) GetEnabled 

func (x *RouteAction_UpgradeConfig) GetEnabled() *wrappers.BoolValue

func (*RouteAction_UpgradeConfig) GetUpgradeType 

func (x *RouteAction_UpgradeConfig) GetUpgradeType() string

func (*RouteAction_UpgradeConfig) Hash added in v1.2.13 

func (m *RouteAction_UpgradeConfig) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*RouteAction_UpgradeConfig) ProtoMessage 

func (*RouteAction_UpgradeConfig) ProtoMessage()

func (*RouteAction_UpgradeConfig) ProtoReflect added in v1.6.0 

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

func (*RouteAction_UpgradeConfig) Reset 

func (x *RouteAction_UpgradeConfig) Reset()

func (*RouteAction_UpgradeConfig) String 

func (x *RouteAction_UpgradeConfig) String() string

type RouteAction_WeightedClusters 

type RouteAction_WeightedClusters struct {
	// Multiple upstream clusters can be specified for a given route. The
	// request is routed to one of the upstream clusters based on weights
	// assigned to each cluster. See
	// `traffic splitting (config_http_conn_man_route_table_traffic_splitting_split)`
	// for additional documentation.
	WeightedClusters *WeightedCluster `protobuf:"bytes,3,opt,name=weighted_clusters,json=weightedClusters,proto3,oneof"`
}

type RouteMatch 

type RouteMatch struct {

	// Types that are assignable to PathSpecifier:
	//
	//	*RouteMatch_Prefix
	//	*RouteMatch_Path
	//	*RouteMatch_Regex
	//	*RouteMatch_ConnectMatcher_
	PathSpecifier isRouteMatch_PathSpecifier `protobuf_oneof:"path_specifier"`
	// Indicates that prefix/path matching should be case insensitive. The default
	// is true.
	CaseSensitive *wrappers.BoolValue `protobuf:"bytes,4,opt,name=case_sensitive,json=caseSensitive,proto3" json:"case_sensitive,omitempty"`
	// Indicates that the route should additionally match on a runtime key. Every time the route
	// is considered for a match, it must also fall under the percentage of matches indicated by
	// this field. For some fraction N/D, a random number in the range [0,D) is selected. If the
	// number is <= the value of the numerator N, or if the key is not present, the default
	// value, the router continues to evaluate the remaining match criteria. A runtime_fraction
	// route configuration can be used to roll out route changes in a gradual manner without full
	// code/config deploys. Refer to the `traffic shifting
	// (config_http_conn_man_route_table_traffic_splitting_shift)` docs for additional documentation.
	//
	//	Parsing this field is implemented such that the runtime key's data may be represented
	//	as a FractionalPercent proto represented as JSON/YAML and may also be represented as an
	//	integer with the assumption that the value is an integral percentage out of 100. For
	//	instance, a runtime key lookup returning the value "42" would parse as a FractionalPercent
	//	whose numerator is 42 and denominator is HUNDRED. This preserves legacy semantics.
	RuntimeFraction *core.RuntimeFractionalPercent `protobuf:"bytes,9,opt,name=runtime_fraction,json=runtimeFraction,proto3" json:"runtime_fraction,omitempty"`
	// Specifies a set of headers that the route should match on. The router will
	// check the request’s headers against all the specified headers in the route
	// config. A match will happen if all the headers in the route 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,6,rep,name=headers,proto3" json:"headers,omitempty"`
	// Specifies a set of URL query parameters on which the route should
	// match. The router will check the query string from the *path* header
	// against all the specified query parameters. If the number of specified
	// query parameters is nonzero, they all must match the *path* header's
	// query string for a match to occur.
	QueryParameters []*QueryParameterMatcher `protobuf:"bytes,7,rep,name=query_parameters,json=queryParameters,proto3" json:"query_parameters,omitempty"`
	// If specified, only gRPC requests will be matched. The router will check
	// that the content-type header has a application/grpc or one of the various
	// application/grpc+ values.
	Grpc *RouteMatch_GrpcRouteMatchOptions `protobuf:"bytes,8,opt,name=grpc,proto3" json:"grpc,omitempty"`
	// contains filtered or unexported fields
}

func (*RouteMatch) Clone added in v1.8.24 

func (m *RouteMatch) Clone() proto.Message

Clone function

func (*RouteMatch) Descriptor deprecated 

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

Deprecated: Use RouteMatch.ProtoReflect.Descriptor instead.

func (*RouteMatch) Equal 

func (m *RouteMatch) Equal(that interface{}) bool

Equal function

func (*RouteMatch) GetCaseSensitive 

func (x *RouteMatch) GetCaseSensitive() *wrappers.BoolValue

func (*RouteMatch) GetConnectMatcher added in v1.14.0 

func (x *RouteMatch) GetConnectMatcher() *RouteMatch_ConnectMatcher

func (*RouteMatch) GetGrpc 

func (x *RouteMatch) GetGrpc() *RouteMatch_GrpcRouteMatchOptions

func (*RouteMatch) GetHeaders 

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

func (*RouteMatch) GetPath 

func (x *RouteMatch) GetPath() string

func (*RouteMatch) GetPathSpecifier 

func (m *RouteMatch) GetPathSpecifier() isRouteMatch_PathSpecifier

func (*RouteMatch) GetPrefix 

func (x *RouteMatch) GetPrefix() string

func (*RouteMatch) GetQueryParameters 

func (x *RouteMatch) GetQueryParameters() []*QueryParameterMatcher

func (*RouteMatch) GetRegex 

func (x *RouteMatch) GetRegex() string

func (*RouteMatch) GetRuntimeFraction 

func (x *RouteMatch) GetRuntimeFraction() *core.RuntimeFractionalPercent

func (*RouteMatch) Hash added in v1.2.13 

func (m *RouteMatch) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*RouteMatch) ProtoMessage 

func (*RouteMatch) ProtoMessage()

func (*RouteMatch) ProtoReflect added in v1.6.0 

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

func (*RouteMatch) Reset 

func (x *RouteMatch) Reset()

func (*RouteMatch) String 

func (x *RouteMatch) String() string

type RouteMatch_ConnectMatcher added in v1.14.0 

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

func (*RouteMatch_ConnectMatcher) Clone added in v1.14.0 

func (m *RouteMatch_ConnectMatcher) Clone() proto.Message

Clone function

func (*RouteMatch_ConnectMatcher) Descriptor deprecated added in v1.14.0 

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

Deprecated: Use RouteMatch_ConnectMatcher.ProtoReflect.Descriptor instead.

func (*RouteMatch_ConnectMatcher) Equal added in v1.14.0 

func (m *RouteMatch_ConnectMatcher) Equal(that interface{}) bool

Equal function

func (*RouteMatch_ConnectMatcher) Hash added in v1.14.0 

func (m *RouteMatch_ConnectMatcher) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*RouteMatch_ConnectMatcher) ProtoMessage added in v1.14.0 

func (*RouteMatch_ConnectMatcher) ProtoMessage()

func (*RouteMatch_ConnectMatcher) ProtoReflect added in v1.14.0 

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

func (*RouteMatch_ConnectMatcher) Reset added in v1.14.0 

func (x *RouteMatch_ConnectMatcher) Reset()

func (*RouteMatch_ConnectMatcher) String added in v1.14.0 

func (x *RouteMatch_ConnectMatcher) String() string

type RouteMatch_ConnectMatcher_ added in v1.14.0 

type RouteMatch_ConnectMatcher_ struct {
	// If this is used as the matcher, the matcher will only match CONNECT requests.
	// Note that this will not match HTTP/2 upgrade-style CONNECT requests
	// (WebSocket and the like) as they are normalized in Envoy as HTTP/1.1 style
	// upgrades.
	// This is the only way to match CONNECT requests for HTTP/1.1. For HTTP/2,
	// where CONNECT requests may have a path, the path matchers will work if
	// there is a path present.
	// Note that CONNECT support is currently considered alpha in Envoy.
	ConnectMatcher *RouteMatch_ConnectMatcher `protobuf:"bytes,10,opt,name=connect_matcher,json=connectMatcher,proto3,oneof"`
}

type RouteMatch_GrpcRouteMatchOptions 

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

func (*RouteMatch_GrpcRouteMatchOptions) Clone added in v1.8.24 

func (m *RouteMatch_GrpcRouteMatchOptions) Clone() proto.Message

Clone function

func (*RouteMatch_GrpcRouteMatchOptions) Descriptor deprecated 

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

Deprecated: Use RouteMatch_GrpcRouteMatchOptions.ProtoReflect.Descriptor instead.

func (*RouteMatch_GrpcRouteMatchOptions) Equal 

func (m *RouteMatch_GrpcRouteMatchOptions) Equal(that interface{}) bool

Equal function

func (*RouteMatch_GrpcRouteMatchOptions) Hash added in v1.2.13 

func (m *RouteMatch_GrpcRouteMatchOptions) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*RouteMatch_GrpcRouteMatchOptions) ProtoMessage 

func (*RouteMatch_GrpcRouteMatchOptions) ProtoMessage()

func (*RouteMatch_GrpcRouteMatchOptions) ProtoReflect added in v1.6.0 

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

func (*RouteMatch_GrpcRouteMatchOptions) Reset 

func (x *RouteMatch_GrpcRouteMatchOptions) Reset()

func (*RouteMatch_GrpcRouteMatchOptions) String 

func (x *RouteMatch_GrpcRouteMatchOptions) String() string

type RouteMatch_Path 

type RouteMatch_Path struct {
	// If specified, the route is an exact path rule meaning that the path must
	// exactly match the *:path* header once the query string is removed.
	Path string `protobuf:"bytes,2,opt,name=path,proto3,oneof"`
}

type RouteMatch_Prefix 

type RouteMatch_Prefix struct {
	// If specified, the route is a prefix rule meaning that the prefix must
	// match the beginning of the *:path* header.
	Prefix string `protobuf:"bytes,1,opt,name=prefix,proto3,oneof"`
}

type RouteMatch_Regex 

type RouteMatch_Regex struct {
	// If specified, the route is a regular expression rule meaning that the
	// regex must match the *:path* header once the query string is removed. The entire path
	// (without the query string) must match the regex. The rule will not match if only a
	// subsequence of the *:path* header matches the regex. The regex grammar is defined `here
	// <https://en.cppreference.com/w/cpp/regex/ecmascript>`_.
	//
	// Examples:
	//
	// * The regex */b[io]t* matches the path */bit*
	// * The regex */b[io]t* matches the path */bot*
	// * The regex */b[io]t* does not match the path */bite*
	// * The regex */b[io]t* does not match the path */bit/bot*
	Regex string `protobuf:"bytes,3,opt,name=regex,proto3,oneof"`
}

type Route_DirectResponse 

type Route_DirectResponse struct {
	// Return an arbitrary HTTP response directly, without proxying.
	DirectResponse *DirectResponseAction `protobuf:"bytes,7,opt,name=direct_response,json=directResponse,proto3,oneof"`
}

type Route_Redirect 

type Route_Redirect struct {
	// Return a redirect.
	Redirect *RedirectAction `protobuf:"bytes,3,opt,name=redirect,proto3,oneof"`
}

type Route_Route 

type Route_Route struct {
	// Route request to some upstream cluster.
	Route *RouteAction `protobuf:"bytes,2,opt,name=route,proto3,oneof"`
}

type Tracing 

type Tracing struct {

	// Target percentage of requests managed by this HTTP connection manager that will be force
	// traced if the `x-client-trace-id (config_http_conn_man_headers_x-client-trace-id)`
	// header is set. This field is a direct analog for the runtime variable
	// 'tracing.client_sampling' in the `HTTP Connection Manager
	// (config_http_conn_man_runtime)`.
	// Default: 100%
	ClientSampling *_type.FractionalPercent `protobuf:"bytes,1,opt,name=client_sampling,json=clientSampling,proto3" json:"client_sampling,omitempty"`
	// Target percentage of requests managed by this HTTP connection manager that will be randomly
	// selected for trace generation, if not requested by the client or not forced. This field is
	// a direct analog for the runtime variable 'tracing.random_sampling' in the
	// `HTTP Connection Manager (config_http_conn_man_runtime)`.
	// Default: 100%
	RandomSampling *_type.FractionalPercent `protobuf:"bytes,2,opt,name=random_sampling,json=randomSampling,proto3" json:"random_sampling,omitempty"`
	// Target percentage of requests managed by this HTTP connection manager that will be traced
	// after all other sampling checks have been applied (client-directed, force tracing, random
	// sampling). This field functions as an upper limit on the total configured sampling rate. For
	// instance, setting client_sampling to 100% but overall_sampling to 1% will result in only 1%
	// of client requests with the appropriate headers to be force traced. This field is a direct
	// analog for the runtime variable 'tracing.global_enabled' in the
	// `HTTP Connection Manager (config_http_conn_man_runtime)`.
	// Default: 100%
	OverallSampling *_type.FractionalPercent `protobuf:"bytes,3,opt,name=overall_sampling,json=overallSampling,proto3" json:"overall_sampling,omitempty"`
	// contains filtered or unexported fields
}

func (*Tracing) Clone added in v1.8.24 

func (m *Tracing) Clone() proto.Message

Clone function

func (*Tracing) Descriptor deprecated 

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

Deprecated: Use Tracing.ProtoReflect.Descriptor instead.

func (*Tracing) Equal 

func (m *Tracing) Equal(that interface{}) bool

Equal function

func (*Tracing) GetClientSampling 

func (x *Tracing) GetClientSampling() *_type.FractionalPercent

func (*Tracing) GetOverallSampling 

func (x *Tracing) GetOverallSampling() *_type.FractionalPercent

func (*Tracing) GetRandomSampling 

func (x *Tracing) GetRandomSampling() *_type.FractionalPercent

func (*Tracing) Hash added in v1.2.13 

func (m *Tracing) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*Tracing) ProtoMessage 

func (*Tracing) ProtoMessage()

func (*Tracing) ProtoReflect added in v1.6.0 

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

func (*Tracing) Reset 

func (x *Tracing) Reset()

func (*Tracing) String 

func (x *Tracing) String() string

type VirtualCluster 

type VirtualCluster struct {

	// Specifies a regex pattern to use for matching requests. The entire path of the request
	// must match the regex. The regex grammar used is defined `here
	// <https://en.cppreference.com/w/cpp/regex/ecmascript>`_.
	//
	// Examples:
	//
	// * The regex */rides/\d+* matches the path */rides/0*
	// * The regex */rides/\d+* matches the path */rides/123*
	// * The regex */rides/\d+* does not match the path */rides/123/456*
	Pattern string `protobuf:"bytes,1,opt,name=pattern,proto3" json:"pattern,omitempty"`
	//	Specifies the name of the virtual cluster. The virtual cluster name as well
	//
	// as the virtual host name are used when emitting statistics. The statistics are emitted by the
	// router filter and are documented `here (config_http_filters_router_stats)`.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Optionally specifies the HTTP method to match on. For example GET, PUT,
	// etc.
	// https://github.com/lyft/protoc-gen-validate/issues/42 is resolved.]
	Method core.RequestMethod `protobuf:"varint,3,opt,name=method,proto3,enum=solo.io.envoy.api.v2.core.RequestMethod" json:"method,omitempty"`
	// contains filtered or unexported fields
}

A virtual cluster is a way of specifying a regex matching rule against certain important endpoints such that statistics are generated explicitly for the matched requests. The reason this is useful is that when doing prefix/path matching Envoy does not always know what the application considers to be an endpoint. Thus, it’s impossible for Envoy to generically emit per endpoint statistics. However, often systems have highly critical endpoints that they wish to get “perfect” statistics on. Virtual cluster statistics are perfect in the sense that they are emitted on the downstream side such that they include network level failures.

Documentation for `virtual cluster statistics (config_http_filters_router_stats)`. 

Virtual clusters are a useful tool, but we do not recommend setting up a virtual cluster for
every application endpoint. This is both not easily maintainable and as well the matching and
statistics output are not free.

func (*VirtualCluster) Clone added in v1.8.24 

func (m *VirtualCluster) Clone() proto.Message

Clone function

func (*VirtualCluster) Descriptor deprecated 

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

Deprecated: Use VirtualCluster.ProtoReflect.Descriptor instead.

func (*VirtualCluster) Equal 

func (m *VirtualCluster) Equal(that interface{}) bool

Equal function

func (*VirtualCluster) GetMethod 

func (x *VirtualCluster) GetMethod() core.RequestMethod

func (*VirtualCluster) GetName 

func (x *VirtualCluster) GetName() string

func (*VirtualCluster) GetPattern 

func (x *VirtualCluster) GetPattern() string

func (*VirtualCluster) Hash added in v1.2.13 

func (m *VirtualCluster) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*VirtualCluster) ProtoMessage 

func (*VirtualCluster) ProtoMessage()

func (*VirtualCluster) ProtoReflect added in v1.6.0 

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

func (*VirtualCluster) Reset 

func (x *VirtualCluster) Reset()

func (*VirtualCluster) String 

func (x *VirtualCluster) String() string

type VirtualHost 

type VirtualHost struct {

	// The logical name of the virtual host. This is used when emitting certain
	// statistics but is not relevant for routing.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// A list of domains (host/authority header) that will be matched to this
	// virtual host. Wildcard hosts are supported in the suffix or prefix form.
	//
	// Domain search order:
	//
	//  1. Exact domain names: “www.foo.com“.
	//
	//  2. Suffix domain wildcards: “*.foo.com“ or “*-bar.foo.com“.
	//
	//  3. Prefix domain wildcards: “foo.*“ or “foo-*“.
	//
	//  4. Special wildcard “*“ matching any domain.
	//
	//     The wildcard will not match the empty string.
	//     e.g. “*-bar.foo.com“ will match “baz-bar.foo.com“ but not “-bar.foo.com“.
	//     The longest wildcards match first.
	//     Only a single virtual host in the entire route configuration can match on “*“. A domain
	//     must be unique across all virtual hosts or the config will fail to load.
	Domains []string `protobuf:"bytes,2,rep,name=domains,proto3" json:"domains,omitempty"`
	// The list of routes that will be matched, in order, for incoming requests.
	// The first route that matches will be used.
	Routes []*Route `protobuf:"bytes,3,rep,name=routes,proto3" json:"routes,omitempty"`
	// Specifies the type of TLS enforcement the virtual host expects. If this option is not
	// specified, there is no TLS requirement for the virtual host.
	RequireTls VirtualHost_TlsRequirementType `` /* 155-byte string literal not displayed */
	// A list of virtual clusters defined for this virtual host. Virtual clusters
	// are used for additional statistics gathering.
	VirtualClusters []*VirtualCluster `protobuf:"bytes,5,rep,name=virtual_clusters,json=virtualClusters,proto3" json:"virtual_clusters,omitempty"`
	// Specifies a set of rate limit configurations that will be applied to the
	// virtual host.
	RateLimits []*RateLimit `protobuf:"bytes,6,rep,name=rate_limits,json=rateLimits,proto3" json:"rate_limits,omitempty"`
	// Specifies a list of HTTP headers that should be added to each request
	// handled by this virtual host. Headers specified at this level are applied
	// after headers from enclosed `envoy_api_msg_route.Route` and before headers from the
	// enclosing `envoy_api_msg_RouteConfiguration`. For more information, including
	// details on header value syntax, see the documentation on `custom request headers
	// (config_http_conn_man_headers_custom_request_headers)`.
	RequestHeadersToAdd []*core.HeaderValueOption `protobuf:"bytes,7,rep,name=request_headers_to_add,json=requestHeadersToAdd,proto3" json:"request_headers_to_add,omitempty"`
	// Specifies a list of HTTP headers that should be removed from each request
	// handled by this virtual host.
	RequestHeadersToRemove []string `` /* 132-byte string literal not displayed */
	// Specifies a list of HTTP headers that should be added to each response
	// handled by this virtual host. Headers specified at this level are applied
	// after headers from enclosed `envoy_api_msg_route.Route` and before headers from the
	// enclosing `envoy_api_msg_RouteConfiguration`. For more information, including
	// details on header value syntax, see the documentation on `custom request headers
	// (config_http_conn_man_headers_custom_request_headers)`.
	ResponseHeadersToAdd []*core.HeaderValueOption `` /* 126-byte string literal not displayed */
	// Specifies a list of HTTP headers that should be removed from each response
	// handled by this virtual host.
	ResponseHeadersToRemove []string `` /* 135-byte string literal not displayed */
	// Indicates that the virtual host has a CORS policy.
	Cors *CorsPolicy `protobuf:"bytes,8,opt,name=cors,proto3" json:"cors,omitempty"`
	// The per_filter_config field can be used to provide virtual host-specific
	// configurations for filters. The key should match the filter name, such as
	// *envoy.filters.http.buffer* for the HTTP buffer filter. Use of this field is filter
	// specific; see the `HTTP filter documentation (config_http_filters)`
	// for if and how it is utilized.
	PerFilterConfig map[string]*_struct.Struct `` /* 197-byte string literal not displayed */
	// The per_filter_config field can be used to provide virtual host-specific
	// configurations for filters. The key should match the filter name, such as
	// *envoy.filters.http.buffer* for the HTTP buffer filter. Use of this field is filter
	// specific; see the `HTTP filter documentation (config_http_filters)`
	// for if and how it is utilized.
	TypedPerFilterConfig map[string]*any1.Any `` /* 214-byte string literal not displayed */
	// Decides whether the `x-envoy-attempt-count
	// (config_http_filters_router_x-envoy-attempt-count)` header should be included
	// in the upstream request. Setting this option will cause it to override any existing header
	// value, so in the case of two Envoys on the request path with this option enabled, the upstream
	// will see the attempt count as perceived by the second Envoy. Defaults to false.
	// This header is unaffected by the
	// `suppress_envoy_headers
	// (envoy_api_field_config.filter.http.router.v2.Router.suppress_envoy_headers)` flag.
	IncludeRequestAttemptCount bool `` /* 145-byte string literal not displayed */
	// Indicates the retry policy for all routes in this virtual host. Note that setting a
	// route level entry will take precedence over this config and it'll be treated
	// independently (e.g.: values are not inherited).
	RetryPolicy *RetryPolicy `protobuf:"bytes,16,opt,name=retry_policy,json=retryPolicy,proto3" json:"retry_policy,omitempty"`
	// Indicates the hedge policy for all routes in this virtual host. Note that setting a
	// route level entry will take precedence over this config and it'll be treated
	// independently (e.g.: values are not inherited).
	HedgePolicy *HedgePolicy `protobuf:"bytes,17,opt,name=hedge_policy,json=hedgePolicy,proto3" json:"hedge_policy,omitempty"`
	// contains filtered or unexported fields
}

The top level element in the routing configuration is a virtual host. Each virtual host has a logical name as well as a set of domains that get routed to it based on the incoming request's host header. This allows a single listener to service multiple top level domain path trees. Once a virtual host is selected based on the domain, the routes are processed in order to see which upstream cluster to route to or whether to perform a redirect.

func (*VirtualHost) Clone added in v1.8.24 

func (m *VirtualHost) Clone() proto.Message

Clone function

func (*VirtualHost) Descriptor deprecated 

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

Deprecated: Use VirtualHost.ProtoReflect.Descriptor instead.

func (*VirtualHost) Equal 

func (m *VirtualHost) Equal(that interface{}) bool

Equal function

func (*VirtualHost) GetCors 

func (x *VirtualHost) GetCors() *CorsPolicy

func (*VirtualHost) GetDomains 

func (x *VirtualHost) GetDomains() []string

func (*VirtualHost) GetHedgePolicy 

func (x *VirtualHost) GetHedgePolicy() *HedgePolicy

func (*VirtualHost) GetIncludeRequestAttemptCount 

func (x *VirtualHost) GetIncludeRequestAttemptCount() bool

func (*VirtualHost) GetName 

func (x *VirtualHost) GetName() string

func (*VirtualHost) GetPerFilterConfig 

func (x *VirtualHost) GetPerFilterConfig() map[string]*_struct.Struct

func (*VirtualHost) GetRateLimits 

func (x *VirtualHost) GetRateLimits() []*RateLimit

func (*VirtualHost) GetRequestHeadersToAdd 

func (x *VirtualHost) GetRequestHeadersToAdd() []*core.HeaderValueOption

func (*VirtualHost) GetRequestHeadersToRemove 

func (x *VirtualHost) GetRequestHeadersToRemove() []string

func (*VirtualHost) GetRequireTls 

func (x *VirtualHost) GetRequireTls() VirtualHost_TlsRequirementType

func (*VirtualHost) GetResponseHeadersToAdd 

func (x *VirtualHost) GetResponseHeadersToAdd() []*core.HeaderValueOption

func (*VirtualHost) GetResponseHeadersToRemove 

func (x *VirtualHost) GetResponseHeadersToRemove() []string

func (*VirtualHost) GetRetryPolicy 

func (x *VirtualHost) GetRetryPolicy() *RetryPolicy

func (*VirtualHost) GetRoutes 

func (x *VirtualHost) GetRoutes() []*Route

func (*VirtualHost) GetTypedPerFilterConfig 

func (x *VirtualHost) GetTypedPerFilterConfig() map[string]*any1.Any

func (*VirtualHost) GetVirtualClusters 

func (x *VirtualHost) GetVirtualClusters() []*VirtualCluster

func (*VirtualHost) Hash added in v1.2.13 

func (m *VirtualHost) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*VirtualHost) ProtoMessage 

func (*VirtualHost) ProtoMessage()

func (*VirtualHost) ProtoReflect added in v1.6.0 

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

func (*VirtualHost) Reset 

func (x *VirtualHost) Reset()

func (*VirtualHost) String 

func (x *VirtualHost) String() string

type VirtualHost_TlsRequirementType 

type VirtualHost_TlsRequirementType int32
const (
	// No TLS requirement for the virtual host.
	VirtualHost_NONE VirtualHost_TlsRequirementType = 0
	// External requests must use TLS. If a request is external and it is not
	// using TLS, a 301 redirect will be sent telling the client to use HTTPS.
	VirtualHost_EXTERNAL_ONLY VirtualHost_TlsRequirementType = 1
	// All requests must use TLS. If a request is not using TLS, a 301 redirect
	// will be sent telling the client to use HTTPS.
	VirtualHost_ALL VirtualHost_TlsRequirementType = 2
)

func (VirtualHost_TlsRequirementType) Descriptor added in v1.6.0 

func (VirtualHost_TlsRequirementType) Descriptor() protoreflect.EnumDescriptor

func (VirtualHost_TlsRequirementType) Enum added in v1.6.0 

func (x VirtualHost_TlsRequirementType) Enum() *VirtualHost_TlsRequirementType

func (VirtualHost_TlsRequirementType) EnumDescriptor deprecated 

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

Deprecated: Use VirtualHost_TlsRequirementType.Descriptor instead.

func (VirtualHost_TlsRequirementType) Number added in v1.6.0 

func (x VirtualHost_TlsRequirementType) Number() protoreflect.EnumNumber

func (VirtualHost_TlsRequirementType) String 

func (x VirtualHost_TlsRequirementType) String() string

func (VirtualHost_TlsRequirementType) Type added in v1.6.0 

func (VirtualHost_TlsRequirementType) Type() protoreflect.EnumType

type WeightedCluster 

type WeightedCluster struct {

	// Specifies one or more upstream clusters associated with the route.
	Clusters []*WeightedCluster_ClusterWeight `protobuf:"bytes,1,rep,name=clusters,proto3" json:"clusters,omitempty"`
	// Specifies the total weight across all clusters. The sum of all cluster weights must equal this
	// value, which must be greater than 0. Defaults to 100.
	TotalWeight *wrappers.UInt32Value `protobuf:"bytes,3,opt,name=total_weight,json=totalWeight,proto3" json:"total_weight,omitempty"`
	// Specifies the runtime key prefix that should be used to construct the
	// runtime keys associated with each cluster. When the *runtime_key_prefix* is
	// specified, the router will look for weights associated with each upstream
	// cluster under the key *runtime_key_prefix* + "." + *cluster[i].name* where
	// *cluster[i]* denotes an entry in the clusters array field. If the runtime
	// key for the cluster does not exist, the value specified in the
	// configuration file will be used as the default weight. See the `runtime documentation
	// (operations_runtime)` for how key names map to the underlying implementation.
	RuntimeKeyPrefix string `protobuf:"bytes,2,opt,name=runtime_key_prefix,json=runtimeKeyPrefix,proto3" json:"runtime_key_prefix,omitempty"`
	// contains filtered or unexported fields
}

Compared to the `cluster (envoy_api_field_route.RouteAction.cluster)` field that specifies a single upstream cluster as the target of a request, the `weighted_clusters (envoy_api_field_route.RouteAction.weighted_clusters)` option allows for specification of multiple upstream clusters along with weights that indicate the percentage of traffic to be forwarded to each cluster. The router selects an upstream cluster based on the weights.

func (*WeightedCluster) Clone added in v1.8.24 

func (m *WeightedCluster) Clone() proto.Message

Clone function

func (*WeightedCluster) Descriptor deprecated 

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

Deprecated: Use WeightedCluster.ProtoReflect.Descriptor instead.

func (*WeightedCluster) Equal 

func (m *WeightedCluster) Equal(that interface{}) bool

Equal function

func (*WeightedCluster) GetClusters 

func (x *WeightedCluster) GetClusters() []*WeightedCluster_ClusterWeight

func (*WeightedCluster) GetRuntimeKeyPrefix 

func (x *WeightedCluster) GetRuntimeKeyPrefix() string

func (*WeightedCluster) GetTotalWeight 

func (x *WeightedCluster) GetTotalWeight() *wrappers.UInt32Value

func (*WeightedCluster) Hash added in v1.2.13 

func (m *WeightedCluster) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*WeightedCluster) ProtoMessage 

func (*WeightedCluster) ProtoMessage()

func (*WeightedCluster) ProtoReflect added in v1.6.0 

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

func (*WeightedCluster) Reset 

func (x *WeightedCluster) Reset()

func (*WeightedCluster) String 

func (x *WeightedCluster) String() string

type WeightedCluster_ClusterWeight 

type WeightedCluster_ClusterWeight struct {

	// Name of the upstream cluster. The cluster must exist in the
	// `cluster manager configuration (config_cluster_manager)`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// An integer between 0 and `total_weight
	// (envoy_api_field_route.WeightedCluster.total_weight)`. When a request matches the route,
	// the choice of an upstream cluster is determined by its weight. The sum of weights across all
	// entries in the clusters array must add up to the total_weight, which defaults to 100.
	Weight *wrappers.UInt32Value `protobuf:"bytes,2,opt,name=weight,proto3" json:"weight,omitempty"`
	// Optional endpoint metadata match criteria used by the subset load balancer. Only endpoints in
	// the upstream cluster with metadata matching what is set in this field will be considered for
	// load balancing. Note that this will be merged with what's provided in
	// `RouteAction.MetadataMatch (envoy_api_field_route.RouteAction.metadata_match)`, with values
	// here taking precedence. The filter name should be specified as *envoy.lb*.
	MetadataMatch *core.Metadata `protobuf:"bytes,3,opt,name=metadata_match,json=metadataMatch,proto3" json:"metadata_match,omitempty"`
	// Specifies a list of headers to be added to requests when this cluster is selected
	// through the enclosing `envoy_api_msg_route.RouteAction`.
	// Headers specified at this level are applied before headers from the enclosing
	// `envoy_api_msg_route.Route`, `envoy_api_msg_route.VirtualHost`, and
	// `envoy_api_msg_RouteConfiguration`. For more information, including details on
	// header value syntax, see the documentation on `custom request headers
	// (config_http_conn_man_headers_custom_request_headers)`.
	RequestHeadersToAdd []*core.HeaderValueOption `protobuf:"bytes,4,rep,name=request_headers_to_add,json=requestHeadersToAdd,proto3" json:"request_headers_to_add,omitempty"`
	// Specifies a list of HTTP headers that should be removed from each request when
	// this cluster is selected through the enclosing `envoy_api_msg_route.RouteAction`.
	RequestHeadersToRemove []string `` /* 131-byte string literal not displayed */
	// Specifies a list of headers to be added to responses when this cluster is selected
	// through the enclosing `envoy_api_msg_route.RouteAction`.
	// Headers specified at this level are applied before headers from the enclosing
	// `envoy_api_msg_route.Route`, `envoy_api_msg_route.VirtualHost`, and
	// `envoy_api_msg_RouteConfiguration`. For more information, including details on
	// header value syntax, see the documentation on `custom request headers
	// (config_http_conn_man_headers_custom_request_headers)`.
	ResponseHeadersToAdd []*core.HeaderValueOption `protobuf:"bytes,5,rep,name=response_headers_to_add,json=responseHeadersToAdd,proto3" json:"response_headers_to_add,omitempty"`
	// Specifies a list of headers to be removed from responses when this cluster is selected
	// through the enclosing `envoy_api_msg_route.RouteAction`.
	ResponseHeadersToRemove []string `` /* 134-byte string literal not displayed */
	// The per_filter_config field can be used to provide weighted cluster-specific
	// configurations for filters. The key should match the filter name, such as
	// *envoy.filters.http.buffer* for the HTTP buffer filter. Use of this field is filter
	// specific; see the `HTTP filter documentation (config_http_filters)`
	// for if and how it is utilized.
	PerFilterConfig map[string]*_struct.Struct `` /* 196-byte string literal not displayed */
	// The per_filter_config field can be used to provide weighted cluster-specific
	// configurations for filters. The key should match the filter name, such as
	// *envoy.filters.http.buffer* for the HTTP buffer filter. Use of this field is filter
	// specific; see the `HTTP filter documentation (config_http_filters)`
	// for if and how it is utilized.
	TypedPerFilterConfig map[string]*any1.Any `` /* 214-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*WeightedCluster_ClusterWeight) Clone added in v1.8.24 

func (m *WeightedCluster_ClusterWeight) Clone() proto.Message

Clone function

func (*WeightedCluster_ClusterWeight) Descriptor deprecated 

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

Deprecated: Use WeightedCluster_ClusterWeight.ProtoReflect.Descriptor instead.

func (*WeightedCluster_ClusterWeight) Equal 

func (m *WeightedCluster_ClusterWeight) Equal(that interface{}) bool

Equal function

func (*WeightedCluster_ClusterWeight) GetMetadataMatch 

func (x *WeightedCluster_ClusterWeight) GetMetadataMatch() *core.Metadata

func (*WeightedCluster_ClusterWeight) GetName 

func (x *WeightedCluster_ClusterWeight) GetName() string

func (*WeightedCluster_ClusterWeight) GetPerFilterConfig 

func (x *WeightedCluster_ClusterWeight) GetPerFilterConfig() map[string]*_struct.Struct

func (*WeightedCluster_ClusterWeight) GetRequestHeadersToAdd 

func (x *WeightedCluster_ClusterWeight) GetRequestHeadersToAdd() []*core.HeaderValueOption

func (*WeightedCluster_ClusterWeight) GetRequestHeadersToRemove 

func (x *WeightedCluster_ClusterWeight) GetRequestHeadersToRemove() []string

func (*WeightedCluster_ClusterWeight) GetResponseHeadersToAdd 

func (x *WeightedCluster_ClusterWeight) GetResponseHeadersToAdd() []*core.HeaderValueOption

func (*WeightedCluster_ClusterWeight) GetResponseHeadersToRemove 

func (x *WeightedCluster_ClusterWeight) GetResponseHeadersToRemove() []string

func (*WeightedCluster_ClusterWeight) GetTypedPerFilterConfig 

func (x *WeightedCluster_ClusterWeight) GetTypedPerFilterConfig() map[string]*any1.Any

func (*WeightedCluster_ClusterWeight) GetWeight 

func (x *WeightedCluster_ClusterWeight) GetWeight() *wrappers.UInt32Value

func (*WeightedCluster_ClusterWeight) Hash added in v1.2.13 

func (m *WeightedCluster_ClusterWeight) Hash(hasher hash.Hash64) (uint64, error)

Hash function

func (*WeightedCluster_ClusterWeight) ProtoMessage 

func (*WeightedCluster_ClusterWeight) ProtoMessage()

func (*WeightedCluster_ClusterWeight) ProtoReflect added in v1.6.0 

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

func (*WeightedCluster_ClusterWeight) Reset 

func (x *WeightedCluster_ClusterWeight) Reset()

func (*WeightedCluster_ClusterWeight) String 

func (x *WeightedCluster_ClusterWeight) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.