v3

package
v1.13.3 Latest Latest
Warning

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

Go to latest
Published: Jan 13, 2023 License: Apache-2.0 Imports: 29 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_config_route_v3_route_components_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type CorsPolicy

type CorsPolicy struct {

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

[#next-free-field: 12]

func (*CorsPolicy) 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) GetAllowOriginStringMatch

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

func (*CorsPolicy) GetEnabledSpecifier

func (m *CorsPolicy) GetEnabledSpecifier() isCorsPolicy_EnabledSpecifier

func (*CorsPolicy) GetExposeHeaders

func (x *CorsPolicy) GetExposeHeaders() string

func (*CorsPolicy) GetFilterEnabled

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

func (*CorsPolicy) GetMaxAge

func (x *CorsPolicy) GetMaxAge() string

func (*CorsPolicy) GetShadowEnabled

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

func (*CorsPolicy) Hash added in v1.6.0

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_FilterEnabled

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

type Decorator

type Decorator struct {

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

func (*Decorator) 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) GetPropagate

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

func (*Decorator) Hash added in v1.6.0

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.
	//
	// .. note::
	//
	//   Headers can be specified using *response_headers_to_add* in the enclosing
	//   :ref:`envoy_api_msg_config.route.v3.Route`, :ref:`envoy_api_msg_config.route.v3.RouteConfiguration` or
	//   :ref:`envoy_api_msg_config.route.v3.VirtualHost`.
	Body *v3.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() *v3.DataSource

func (*DirectResponseAction) GetStatus

func (x *DirectResponseAction) GetStatus() uint32

func (*DirectResponseAction) Hash added in v1.6.0

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 FilterAction

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

A filter-defined action type.

func (*FilterAction) Clone added in v1.8.24

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

Clone function

func (*FilterAction) Descriptor deprecated

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

Deprecated: Use FilterAction.ProtoReflect.Descriptor instead.

func (*FilterAction) Equal

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

Equal function

func (*FilterAction) GetAction

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

func (*FilterAction) Hash added in v1.6.0

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

Hash function

func (*FilterAction) ProtoMessage

func (*FilterAction) ProtoMessage()

func (*FilterAction) ProtoReflect added in v1.6.0

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

func (*FilterAction) Reset

func (x *FilterAction) Reset()

func (*FilterAction) String

func (x *FilterAction) 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_SafeRegexMatch
	//	*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
}

.. attention::

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

.. attention::

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

.. code-block:: json

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

.. attention::

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

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

[#next-free-field: 12]

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() *v32.Int64Range

func (*HeaderMatcher) GetSafeRegexMatch

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

func (*HeaderMatcher) GetSuffixMatch

func (x *HeaderMatcher) GetSuffixMatch() string

func (*HeaderMatcher) Hash added in v1.6.0

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 *v32.Int64Range `protobuf:"bytes,6,opt,name=range_match,json=rangeMatch,proto3,oneof"`
}

type HeaderMatcher_SafeRegexMatch

type HeaderMatcher_SafeRegexMatch struct {
	// If specified, this regex string is a regular expression rule which implies the entire request
	// header value must match the regex. The rule will not match if only a subsequence of the
	// request header value matches the regex.
	SafeRegexMatch *v31.RegexMatcher `protobuf:"bytes,11,opt,name=safe_regex_match,json=safeRegexMatch,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 *v32.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
	// :ref:`RetryPolicy <envoy_api_msg_config.route.v3.RetryPolicy>`.
	// Defaults to false.
	HedgeOnPerTryTimeout bool `` /* 128-byte string literal not displayed */
	// contains filtered or unexported fields
}

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

func (*HedgePolicy) 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() *v32.FractionalPercent

func (*HedgePolicy) GetHedgeOnPerTryTimeout

func (x *HedgePolicy) GetHedgeOnPerTryTimeout() bool

func (*HedgePolicy) GetInitialRequests

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

func (*HedgePolicy) Hash added in v1.6.0

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 InternalRedirectPolicy

type InternalRedirectPolicy struct {

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

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

func (*InternalRedirectPolicy) Clone added in v1.8.24

Clone function

func (*InternalRedirectPolicy) Descriptor deprecated

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

Deprecated: Use InternalRedirectPolicy.ProtoReflect.Descriptor instead.

func (*InternalRedirectPolicy) Equal

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

Equal function

func (*InternalRedirectPolicy) GetAllowCrossSchemeRedirect

func (x *InternalRedirectPolicy) GetAllowCrossSchemeRedirect() bool

func (*InternalRedirectPolicy) GetMaxInternalRedirects

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

func (*InternalRedirectPolicy) GetPredicates

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

func (*InternalRedirectPolicy) GetRedirectResponseCodes

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

func (*InternalRedirectPolicy) Hash added in v1.6.0

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

Hash function

func (*InternalRedirectPolicy) ProtoMessage

func (*InternalRedirectPolicy) ProtoMessage()

func (*InternalRedirectPolicy) ProtoReflect added in v1.6.0

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

func (*InternalRedirectPolicy) Reset

func (x *InternalRedirectPolicy) Reset()

func (*InternalRedirectPolicy) String

func (x *InternalRedirectPolicy) 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"`
	// Types that are assignable to QueryParameterMatchSpecifier:
	//	*QueryParameterMatcher_StringMatch
	//	*QueryParameterMatcher_PresentMatch
	QueryParameterMatchSpecifier isQueryParameterMatcher_QueryParameterMatchSpecifier `protobuf_oneof:"query_parameter_match_specifier"`
	// contains filtered or unexported fields
}

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

func (*QueryParameterMatcher) 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) GetPresentMatch

func (x *QueryParameterMatcher) GetPresentMatch() bool

func (*QueryParameterMatcher) GetQueryParameterMatchSpecifier

func (m *QueryParameterMatcher) GetQueryParameterMatchSpecifier() isQueryParameterMatcher_QueryParameterMatchSpecifier

func (*QueryParameterMatcher) GetStringMatch

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

func (*QueryParameterMatcher) Hash added in v1.6.0

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 QueryParameterMatcher_PresentMatch

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

type QueryParameterMatcher_StringMatch

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

type RateLimit

type RateLimit struct {

	// Refers to the stage set in the filter. The rate limit configuration only
	// applies to filters with the same stage number. The default stage number is
	// 0.
	//
	// .. note::
	//
	//   The filter supports a range of 0 - 10 inclusively for stage numbers.
	Stage *wrappers.UInt32Value `protobuf:"bytes,1,opt,name=stage,proto3" json:"stage,omitempty"`
	// The key to be set in runtime to disable this rate limit configuration.
	DisableKey string `protobuf:"bytes,2,opt,name=disable_key,json=disableKey,proto3" json:"disable_key,omitempty"`
	// A list of actions that are to be applied for this rate limit configuration.
	// Order matters as the actions are processed sequentially and the descriptor
	// is composed by appending descriptor entries in that sequence. If an action
	// cannot append a descriptor entry, no descriptor is generated for the
	// configuration. See :ref:`composing actions
	// <config_http_filters_rate_limit_composing_actions>` for additional documentation.
	Actions []*RateLimit_Action `protobuf:"bytes,3,rep,name=actions,proto3" json:"actions,omitempty"`
	// An optional limit override to be appended to the descriptor produced by this
	// rate limit configuration. If the override value is invalid or cannot be resolved
	// from metadata, no override is provided. See :ref:`rate limit override
	// <config_http_filters_rate_limit_rate_limit_override>` for more information.
	Limit *RateLimit_Override `protobuf:"bytes,4,opt,name=limit,proto3" json:"limit,omitempty"`
	// contains filtered or unexported fields
}

Global rate limiting :ref:`architecture overview <arch_overview_global_rate_limit>`.

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

func (x *RateLimit) GetLimit() *RateLimit_Override

func (*RateLimit) GetStage

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

func (*RateLimit) Hash added in v1.6.0

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

[#next-free-field: 8]

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

func (x *RateLimit_Action) GetDynamicMetadata() *RateLimit_Action_DynamicMetaData

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

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:

.. code-block:: cpp

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

Once a request matches against a route table rule, a routed cluster is determined by one of the following :ref:`route table configuration <envoy_api_msg_config.route.v3.RouteConfiguration>` settings:

  • :ref:`cluster <envoy_api_field_config.route.v3.RouteAction.cluster>` indicates the upstream cluster to route to.
  • :ref:`weighted_clusters <envoy_api_field_config.route.v3.RouteAction.weighted_clusters>` chooses a cluster randomly from a set of clusters with attributed weight.
  • :ref:`cluster_header <envoy_api_field_config.route.v3.RouteAction.cluster_header>` indicates which header in the request contains the target cluster.

func (*RateLimit_Action_DestinationCluster) Clone added in v1.8.24

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

Hash function

func (*RateLimit_Action_DestinationCluster) ProtoMessage

func (*RateLimit_Action_DestinationCluster) ProtoMessage()

func (*RateLimit_Action_DestinationCluster) ProtoReflect added in v1.6.0

func (*RateLimit_Action_DestinationCluster) Reset

func (*RateLimit_Action_DestinationCluster) 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_DynamicMetaData

type RateLimit_Action_DynamicMetaData struct {

	// The key to use in the descriptor entry.
	DescriptorKey string `protobuf:"bytes,1,opt,name=descriptor_key,json=descriptorKey,proto3" json:"descriptor_key,omitempty"`
	// Metadata struct that defines the key and path to retrieve the string value. A match will
	// only happen if the value in the dynamic metadata is of type string.
	MetadataKey *v34.MetadataKey `protobuf:"bytes,2,opt,name=metadata_key,json=metadataKey,proto3" json:"metadata_key,omitempty"`
	// contains filtered or unexported fields
}

The following descriptor entry is appended when the dynamic metadata contains a key value:

.. code-block:: cpp

("<descriptor_key>", "<value_queried_from_metadata>")

func (*RateLimit_Action_DynamicMetaData) Clone added in v1.8.24

Clone function

func (*RateLimit_Action_DynamicMetaData) Descriptor deprecated

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

Deprecated: Use RateLimit_Action_DynamicMetaData.ProtoReflect.Descriptor instead.

func (*RateLimit_Action_DynamicMetaData) Equal

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

Equal function

func (*RateLimit_Action_DynamicMetaData) GetDescriptorKey

func (x *RateLimit_Action_DynamicMetaData) GetDescriptorKey() string

func (*RateLimit_Action_DynamicMetaData) GetMetadataKey

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

func (*RateLimit_Action_DynamicMetaData) Hash added in v1.6.0

Hash function

func (*RateLimit_Action_DynamicMetaData) ProtoMessage

func (*RateLimit_Action_DynamicMetaData) ProtoMessage()

func (*RateLimit_Action_DynamicMetaData) ProtoReflect added in v1.6.0

func (*RateLimit_Action_DynamicMetaData) Reset

func (*RateLimit_Action_DynamicMetaData) String

type RateLimit_Action_DynamicMetadata

type RateLimit_Action_DynamicMetadata struct {
	// Rate limit on dynamic metadata.
	DynamicMetadata *RateLimit_Action_DynamicMetaData `protobuf:"bytes,7,opt,name=dynamic_metadata,json=dynamicMetadata,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:

.. code-block:: cpp

("generic_key", "<descriptor_value>")

func (*RateLimit_Action_GenericKey) Clone added in v1.8.24

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

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

.. code-block:: cpp

("header_match", "<descriptor_value>")

func (*RateLimit_Action_HeaderValueMatch) Clone added in v1.8.24

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 (*RateLimit_Action_HeaderValueMatch) GetHeaders

func (*RateLimit_Action_HeaderValueMatch) Hash added in v1.6.0

Hash function

func (*RateLimit_Action_HeaderValueMatch) ProtoMessage

func (*RateLimit_Action_HeaderValueMatch) ProtoMessage()

func (*RateLimit_Action_HeaderValueMatch) ProtoReflect added in v1.6.0

func (*RateLimit_Action_HeaderValueMatch) Reset

func (*RateLimit_Action_HeaderValueMatch) 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 :ref:`x-forwarded-for <config_http_conn_man_headers_x-forwarded-for>`:

.. code-block:: cpp

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

func (*RateLimit_Action_RemoteAddress) Clone added in v1.8.24

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

Hash function

func (*RateLimit_Action_RemoteAddress) ProtoMessage

func (*RateLimit_Action_RemoteAddress) ProtoMessage()

func (*RateLimit_Action_RemoteAddress) ProtoReflect added in v1.6.0

func (*RateLimit_Action_RemoteAddress) Reset

func (x *RateLimit_Action_RemoteAddress) Reset()

func (*RateLimit_Action_RemoteAddress) 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"`
	// If set to true, Envoy skips the descriptor while calling rate limiting service
	// when header is not present in the request. By default it skips calling the
	// rate limiting service if this header is not present in the request.
	SkipIfAbsent bool `protobuf:"varint,3,opt,name=skip_if_absent,json=skipIfAbsent,proto3" json:"skip_if_absent,omitempty"`
	// contains filtered or unexported fields
}

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

.. code-block:: cpp

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

func (*RateLimit_Action_RequestHeaders) Clone added in v1.8.24

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

func (x *RateLimit_Action_RequestHeaders) GetSkipIfAbsent() bool

func (*RateLimit_Action_RequestHeaders) Hash added in v1.6.0

Hash function

func (*RateLimit_Action_RequestHeaders) ProtoMessage

func (*RateLimit_Action_RequestHeaders) ProtoMessage()

func (*RateLimit_Action_RequestHeaders) ProtoReflect added in v1.6.0

func (*RateLimit_Action_RequestHeaders) Reset

func (*RateLimit_Action_RequestHeaders) 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:

.. code-block:: cpp

("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

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

Hash function

func (*RateLimit_Action_SourceCluster) ProtoMessage

func (*RateLimit_Action_SourceCluster) ProtoMessage()

func (*RateLimit_Action_SourceCluster) ProtoReflect added in v1.6.0

func (*RateLimit_Action_SourceCluster) Reset

func (x *RateLimit_Action_SourceCluster) Reset()

func (*RateLimit_Action_SourceCluster) 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 RateLimit_Override

type RateLimit_Override struct {

	// Types that are assignable to OverrideSpecifier:
	//	*RateLimit_Override_DynamicMetadata_
	OverrideSpecifier isRateLimit_Override_OverrideSpecifier `protobuf_oneof:"override_specifier"`
	// contains filtered or unexported fields
}

func (*RateLimit_Override) Clone added in v1.8.24

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

Clone function

func (*RateLimit_Override) Descriptor deprecated

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

Deprecated: Use RateLimit_Override.ProtoReflect.Descriptor instead.

func (*RateLimit_Override) Equal

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

Equal function

func (*RateLimit_Override) GetDynamicMetadata

func (x *RateLimit_Override) GetDynamicMetadata() *RateLimit_Override_DynamicMetadata

func (*RateLimit_Override) GetOverrideSpecifier

func (m *RateLimit_Override) GetOverrideSpecifier() isRateLimit_Override_OverrideSpecifier

func (*RateLimit_Override) Hash added in v1.6.0

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

Hash function

func (*RateLimit_Override) ProtoMessage

func (*RateLimit_Override) ProtoMessage()

func (*RateLimit_Override) ProtoReflect added in v1.6.0

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

func (*RateLimit_Override) Reset

func (x *RateLimit_Override) Reset()

func (*RateLimit_Override) String

func (x *RateLimit_Override) String() string

type RateLimit_Override_DynamicMetadata

type RateLimit_Override_DynamicMetadata struct {

	// Metadata struct that defines the key and path to retrieve the struct value.
	// The value must be a struct containing an integer "requests_per_unit" property
	// and a "unit" property with a value parseable to :ref:`RateLimitUnit
	// enum <envoy_api_enum_type.v3.RateLimitUnit>`
	MetadataKey *v34.MetadataKey `protobuf:"bytes,1,opt,name=metadata_key,json=metadataKey,proto3" json:"metadata_key,omitempty"`
	// contains filtered or unexported fields
}

Fetches the override from the dynamic metadata.

func (*RateLimit_Override_DynamicMetadata) Clone added in v1.8.24

Clone function

func (*RateLimit_Override_DynamicMetadata) Descriptor deprecated

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

Deprecated: Use RateLimit_Override_DynamicMetadata.ProtoReflect.Descriptor instead.

func (*RateLimit_Override_DynamicMetadata) Equal

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

Equal function

func (*RateLimit_Override_DynamicMetadata) GetMetadataKey

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

func (*RateLimit_Override_DynamicMetadata) Hash added in v1.6.0

Hash function

func (*RateLimit_Override_DynamicMetadata) ProtoMessage

func (*RateLimit_Override_DynamicMetadata) ProtoMessage()

func (*RateLimit_Override_DynamicMetadata) ProtoReflect added in v1.6.0

func (*RateLimit_Override_DynamicMetadata) Reset

func (*RateLimit_Override_DynamicMetadata) String

type RateLimit_Override_DynamicMetadata_

type RateLimit_Override_DynamicMetadata_ struct {
	// Limit override from dynamic metadata.
	DynamicMetadata *RateLimit_Override_DynamicMetadata `protobuf:"bytes,1,opt,name=dynamic_metadata,json=dynamicMetadata,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 `` /* 169-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
}

[#next-free-field: 9]

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 (*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.6.0

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.
	// Please note that query string in path_redirect will override the
	// request's query string and will not be stripped.
	//
	// For example, let's say we have the following routes:
	//
	// - match: { path: "/old-path-1" }
	//   redirect: { path_redirect: "/new-path-1" }
	// - match: { path: "/old-path-2" }
	//   redirect: { path_redirect: "/new-path-2", strip-query: "true" }
	// - match: { path: "/old-path-3" }
	//   redirect: { path_redirect: "/new-path-3?foo=1", strip_query: "true" }
	//
	// 1. if request uri is "/old-path-1?bar=1", users will be redirected to "/new-path-1?bar=1"
	// 2. if request uri is "/old-path-2?bar=1", users will be redirected to "/new-path-2"
	// 3. if request uri is "/old-path-3?bar=1", users will be redirected to "/new-path-3?foo=1"
	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.
	//
	// .. attention::
	//
	//   Pay attention to the use of trailing slashes as mentioned in
	//   :ref:`RouteAction's prefix_rewrite <envoy_api_field_config.route.v3.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) Enum added in v1.6.0

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 (RedirectAction_RedirectResponseCode) String

func (RedirectAction_RedirectResponseCode) Type added in v1.6.0

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 :ref:`config_http_filters_router_x-envoy-retry-on` and
	// :ref:`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
	// :ref:`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
	// :ref:`config_http_filters_router_x-envoy-upstream-rq-per-try-timeout-ms` apply.
	//
	// .. note::
	//
	//   If left unspecified, Envoy will use the global
	//   :ref:`route timeout <envoy_api_field_config.route.v3.RouteAction.timeout>` for the request.
	//   Consequently, when using a :ref:`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
	// :ref:`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 :ref:`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 :ref:`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"`
	// HTTP response headers that trigger a retry if present in the response. A retry will be
	// triggered if any of the header matches match the upstream response headers.
	// The field is only consulted if 'retriable-headers' retry policy is active.
	RetriableHeaders []*HeaderMatcher `protobuf:"bytes,9,rep,name=retriable_headers,json=retriableHeaders,proto3" json:"retriable_headers,omitempty"`
	// HTTP headers which must be present in the request for retries to be attempted.
	RetriableRequestHeaders []*HeaderMatcher `` /* 133-byte string literal not displayed */
	// contains filtered or unexported fields
}

HTTP retry :ref:`architecture overview <arch_overview_http_routing_retry>`. [#next-free-field: 11]

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

func (x *RetryPolicy) GetRetriableHeaders() []*HeaderMatcher

func (*RetryPolicy) GetRetriableRequestHeaders

func (x *RetryPolicy) GetRetriableRequestHeaders() []*HeaderMatcher

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

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

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

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_TypedConfig
	ConfigType isRetryPolicy_RetryHostPredicate_ConfigType `protobuf_oneof:"config_type"`
	// contains filtered or unexported fields
}

func (*RetryPolicy_RetryHostPredicate) Clone added in v1.8.24

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

func (m *RetryPolicy_RetryHostPredicate) GetConfigType() isRetryPolicy_RetryHostPredicate_ConfigType

func (*RetryPolicy_RetryHostPredicate) GetName

func (*RetryPolicy_RetryHostPredicate) GetTypedConfig

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

func (*RetryPolicy_RetryHostPredicate) Hash added in v1.6.0

Hash function

func (*RetryPolicy_RetryHostPredicate) ProtoMessage

func (*RetryPolicy_RetryHostPredicate) ProtoMessage()

func (*RetryPolicy_RetryHostPredicate) ProtoReflect added in v1.6.0

func (*RetryPolicy_RetryHostPredicate) Reset

func (x *RetryPolicy_RetryHostPredicate) Reset()

func (*RetryPolicy_RetryHostPredicate) String

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_TypedConfig
	ConfigType isRetryPolicy_RetryPriority_ConfigType `protobuf_oneof:"config_type"`
	// contains filtered or unexported fields
}

func (*RetryPolicy_RetryPriority) Clone added in v1.8.24

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) 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.6.0

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 (*RetryPolicy_RetryPriority) Reset

func (x *RetryPolicy_RetryPriority) Reset()

func (*RetryPolicy_RetryPriority) String

func (x *RetryPolicy_RetryPriority) String() string

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
	//	*Route_FilterAction
	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 *v3.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 typed_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 :ref:`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 :ref:`envoy_api_msg_config.route.v3.VirtualHost` and
	// :ref:`envoy_api_msg_config.route.v3.RouteConfiguration`. For more information, including details on
	// header value syntax, see the documentation on :ref:`custom request headers
	// <config_http_conn_man_headers_custom_request_headers>`.
	RequestHeadersToAdd []*v3.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 :ref:`envoy_api_msg_config.route.v3.VirtualHost` and
	// :ref:`envoy_api_msg_config.route.v3.RouteConfiguration`. For more information, including
	// details on header value syntax, see the documentation on
	// :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
	ResponseHeadersToAdd []*v3.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"`
	// The maximum bytes which will be buffered for retries and shadowing.
	// If set, the bytes actually buffered will be the minimum value of this and the
	// listener per_connection_buffer_limit_bytes.
	PerRequestBufferLimitBytes *wrappers.UInt32Value `` /* 146-byte string literal not displayed */
	// 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.).

.. attention::

Envoy supports routing on HTTP method via :ref:`header matching
<envoy_api_msg_config.route.v3.HeaderMatcher>`.

[#next-free-field: 18]

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

func (x *Route) GetFilterAction() *FilterAction

func (*Route) GetMatch

func (x *Route) GetMatch() *RouteMatch

func (*Route) GetMetadata

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

func (*Route) GetName

func (x *Route) GetName() string

func (*Route) GetPerRequestBufferLimitBytes

func (x *Route) GetPerRequestBufferLimitBytes() *wrappers.UInt32Value

func (*Route) GetRedirect

func (x *Route) GetRedirect() *RedirectAction

func (*Route) GetRequestHeadersToAdd

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

func (*Route) GetRequestHeadersToRemove

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

func (*Route) GetResponseHeadersToAdd

func (x *Route) GetResponseHeadersToAdd() []*v3.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.6.0

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 `` /* 225-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 :ref:`weighted_clusters
	// <envoy_api_field_config.route.v3.RouteAction.weighted_clusters>`, metadata will be merged, with values
	// provided there taking precedence. The filter name should be specified as *envoy.lb*.
	MetadataMatch *v3.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 :ref:`x-envoy-original-path
	// <config_http_filters_router_x-envoy-original-path>` header.
	//
	// Only one of *prefix_rewrite* or
	// :ref:`regex_rewrite <envoy_api_field_config.route.v3.RouteAction.regex_rewrite>`
	// may be specified.
	//
	// .. attention::
	//
	//   Pay careful attention to the use of trailing slashes in the
	//   :ref:`route's match <envoy_api_field_config.route.v3.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
	//   :ref:`Route <envoy_api_msg_config.route.v3.Route>`, as shown by the below config entries:
	//
	//   .. code-block:: yaml
	//
	//     - 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"`
	// Indicates that during forwarding, portions of the path that match the
	// pattern should be rewritten, even allowing the substitution of capture
	// groups from the pattern into the new path as specified by the rewrite
	// substitution string. This is useful to allow application paths to be
	// rewritten in a way that is aware of segments with variable content like
	// identifiers. The router filter will place the original path as it was
	// before the rewrite into the :ref:`x-envoy-original-path
	// <config_http_filters_router_x-envoy-original-path>` header.
	//
	// Only one of :ref:`prefix_rewrite <envoy_api_field_config.route.v3.RouteAction.prefix_rewrite>`
	// or *regex_rewrite* may be specified.
	//
	// Examples using Google's `RE2 <https://github.com/google/re2>`_ engine:
	//
	// * The path pattern “^/service/([^/]+)(/.*)$“ paired with a substitution
	//   string of “\2/instance/\1“ would transform “/service/foo/v1/api“
	//   into “/v1/api/instance/foo“.
	//
	// * The pattern “one“ paired with a substitution string of “two“ would
	//   transform “/xxx/one/yyy/one/zzz“ into “/xxx/two/yyy/two/zzz“.
	//
	// * The pattern “^(.*?)one(.*)$“ paired with a substitution string of
	//   “\1two\2“ would replace only the first occurrence of “one“,
	//   transforming path “/xxx/one/yyy/one/zzz“ into “/xxx/two/yyy/one/zzz“.
	//
	// * The pattern “(?i)/xxx/“ paired with a substitution string of “/yyy/“
	//   would do a case-insensitive match and transform path “/aaa/XxX/bbb“ to
	//   “/aaa/yyy/bbb“.
	RegexRewrite *v31.RegexMatchAndSubstitute `protobuf:"bytes,32,opt,name=regex_rewrite,json=regexRewrite,proto3" json:"regex_rewrite,omitempty"`
	// Types that are assignable to HostRewriteSpecifier:
	//	*RouteAction_HostRewriteLiteral
	//	*RouteAction_AutoHostRewrite
	//	*RouteAction_HostRewriteHeader
	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. A value of 0 will
	// disable the route's timeout.
	//
	// .. note::
	//
	//   This timeout includes all retries. See also
	//   :ref:`config_http_filters_router_x-envoy-upstream-rq-timeout-ms`,
	//   :ref:`config_http_filters_router_x-envoy-upstream-rq-per-try-timeout-ms`, and the
	//   :ref:`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 :ref:`stream_idle_timeout
	// <envoy_api_field_extensions.filters.network.http_connection_manager.v3.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 :ref:`timeout
	// <envoy_api_field_config.route.v3.RouteAction.timeout>`, which provides an upper bound
	// on the upstream response time; :ref:`idle_timeout
	// <envoy_api_field_config.route.v3.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"`
	// [#not-implemented-hide:]
	// Specifies the configuration for retry policy extension. 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). :ref:`Retry policy <envoy_api_field_config.route.v3.VirtualHost.retry_policy>`
	// should not be set if this field is used.
	RetryPolicyTypedConfig *any1.Any `` /* 132-byte string literal not displayed */
	// Indicates that the route has request mirroring policies.
	RequestMirrorPolicies []*RouteAction_RequestMirrorPolicy `` /* 127-byte string literal not displayed */
	// Optionally specifies the :ref:`routing priority <arch_overview_http_routing_priority>`.
	Priority v3.RoutingPriority `protobuf:"varint,11,opt,name=priority,proto3,enum=solo.io.envoy.config.core.v3.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
	// :ref:`rate_limits <envoy_api_field_config.route.v3.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
	// :ref:`timeout <envoy_api_field_config.route.v3.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
	// :ref:`timeout <envoy_api_field_config.route.v3.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.
	//
	// .. note::
	//
	//    If a timeout is specified using :ref:`config_http_filters_router_x-envoy-upstream-rq-timeout-ms`, it takes
	//    precedence over `grpc-timeout header <https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md>`_, when
	//    both are present. See also
	//    :ref:`config_http_filters_router_x-envoy-upstream-rq-timeout-ms`,
	//    :ref:`config_http_filters_router_x-envoy-upstream-rq-per-try-timeout-ms`, and the
	//    :ref:`retry overview <arch_overview_http_routing_retry>`.
	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"`
	// If present, Envoy will try to follow an upstream redirect response instead of proxying the
	// response back to the downstream. An upstream redirect response is defined
	// by :ref:`redirect_response_codes
	// <envoy_api_field_config.route.v3.InternalRedirectPolicy.redirect_response_codes>`.
	InternalRedirectPolicy *InternalRedirectPolicy `` /* 130-byte string literal not displayed */
	// Deprecated: Do not use.
	InternalRedirectAction RouteAction_InternalRedirectAction `` /* 201-byte string literal not displayed */
	// An internal redirect is handled, iff the number of previous internal redirects that a
	// downstream request has encountered is lower than this value, and
	// :ref:`internal_redirect_action <envoy_api_field_config.route.v3.RouteAction.internal_redirect_action>`
	// is set to :ref:`HANDLE_INTERNAL_REDIRECT
	// <envoy_api_enum_value_config.route.v3.RouteAction.InternalRedirectAction.HANDLE_INTERNAL_REDIRECT>`
	// In the case where a downstream request is bounced among multiple routes by internal redirect,
	// the first route that hits this threshold, or has
	// :ref:`internal_redirect_action <envoy_api_field_config.route.v3.RouteAction.internal_redirect_action>`
	// set to
	// :ref:`PASS_THROUGH_INTERNAL_REDIRECT
	// <envoy_api_enum_value_config.route.v3.RouteAction.InternalRedirectAction.PASS_THROUGH_INTERNAL_REDIRECT>`
	// will pass the redirect back to downstream.
	//
	// If not specified, at most one redirect will be followed.
	//
	// Deprecated: Do not use.
	MaxInternalRedirects *wrappers.UInt32Value `protobuf:"bytes,31,opt,name=max_internal_redirects,json=maxInternalRedirects,proto3" json:"max_internal_redirects,omitempty"`
	// 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
}

[#next-free-field: 35]

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

func (x *RouteAction) GetHostRewriteHeader() string

func (*RouteAction) GetHostRewriteLiteral

func (x *RouteAction) GetHostRewriteLiteral() 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 deprecated

func (x *RouteAction) GetInternalRedirectAction() RouteAction_InternalRedirectAction

Deprecated: Do not use.

func (*RouteAction) GetInternalRedirectPolicy

func (x *RouteAction) GetInternalRedirectPolicy() *InternalRedirectPolicy

func (*RouteAction) GetMaxGrpcTimeout

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

func (*RouteAction) GetMaxInternalRedirects deprecated

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

Deprecated: Do not use.

func (*RouteAction) GetMetadataMatch

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

func (*RouteAction) GetPrefixRewrite

func (x *RouteAction) GetPrefixRewrite() string

func (*RouteAction) GetPriority

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

func (*RouteAction) GetRateLimits

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

func (*RouteAction) GetRegexRewrite

func (x *RouteAction) GetRegexRewrite() *v31.RegexMatchAndSubstitute

func (*RouteAction) GetRequestMirrorPolicies

func (x *RouteAction) GetRequestMirrorPolicies() []*RouteAction_RequestMirrorPolicy

func (*RouteAction) GetRetryPolicy

func (x *RouteAction) GetRetryPolicy() *RetryPolicy

func (*RouteAction) GetRetryPolicyTypedConfig

func (x *RouteAction) GetRetryPolicyTypedConfig() *any1.Any

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

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_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.
	//
	// .. attention::
	//
	//   Internally, Envoy always uses the HTTP/2 *:authority* header to represent the HTTP/1
	//   *Host* header. Thus, if attempting to match on *Host*, match on *:authority* instead.
	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) Enum added in v1.6.0

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 (RouteAction_ClusterNotFoundResponseCode) String

func (RouteAction_ClusterNotFoundResponseCode) Type added in v1.6.0

type RouteAction_HashPolicy

type RouteAction_HashPolicy struct {

	// Types that are assignable to PolicySpecifier:
	//	*RouteAction_HashPolicy_Header_
	//	*RouteAction_HashPolicy_Cookie_
	//	*RouteAction_HashPolicy_ConnectionProperties_
	//	*RouteAction_HashPolicy_QueryParameter_
	//	*RouteAction_HashPolicy_FilterState_
	PolicySpecifier isRouteAction_HashPolicy_PolicySpecifier `protobuf_oneof:"policy_specifier"`
	// The flag that short-circuits 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 :ref:`load balancer <arch_overview_load_balancing_types>`. [#next-free-field: 7]

func (*RouteAction_HashPolicy) Clone added in v1.8.24

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 (*RouteAction_HashPolicy) GetCookie

func (*RouteAction_HashPolicy) GetFilterState

func (*RouteAction_HashPolicy) GetHeader

func (*RouteAction_HashPolicy) GetPolicySpecifier

func (m *RouteAction_HashPolicy) GetPolicySpecifier() isRouteAction_HashPolicy_PolicySpecifier

func (*RouteAction_HashPolicy) GetQueryParameter

func (*RouteAction_HashPolicy) GetTerminal

func (x *RouteAction_HashPolicy) GetTerminal() bool

func (*RouteAction_HashPolicy) Hash added in v1.6.0

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

Clone function

func (*RouteAction_HashPolicy_ConnectionProperties) Descriptor deprecated

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 (*RouteAction_HashPolicy_ConnectionProperties) Hash added in v1.6.0

Hash function

func (*RouteAction_HashPolicy_ConnectionProperties) ProtoMessage

func (*RouteAction_HashPolicy_ConnectionProperties) ProtoReflect added in v1.6.0

func (*RouteAction_HashPolicy_ConnectionProperties) Reset

func (*RouteAction_HashPolicy_ConnectionProperties) 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.
  1. 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

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 (*RouteAction_HashPolicy_Cookie) GetPath

func (*RouteAction_HashPolicy_Cookie) GetTtl

func (*RouteAction_HashPolicy_Cookie) Hash added in v1.6.0

Hash function

func (*RouteAction_HashPolicy_Cookie) ProtoMessage

func (*RouteAction_HashPolicy_Cookie) ProtoMessage()

func (*RouteAction_HashPolicy_Cookie) ProtoReflect added in v1.6.0

func (*RouteAction_HashPolicy_Cookie) Reset

func (x *RouteAction_HashPolicy_Cookie) Reset()

func (*RouteAction_HashPolicy_Cookie) String

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

type RouteAction_HashPolicy_FilterState

type RouteAction_HashPolicy_FilterState struct {

	// The name of the Object in the per-request filterState, which is an
	// Envoy::Http::Hashable object. If there is no data associated with the key,
	// or the stored object is not Envoy::Http::Hashable, no hash will be produced.
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// contains filtered or unexported fields
}

func (*RouteAction_HashPolicy_FilterState) Clone added in v1.8.24

Clone function

func (*RouteAction_HashPolicy_FilterState) Descriptor deprecated

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

Deprecated: Use RouteAction_HashPolicy_FilterState.ProtoReflect.Descriptor instead.

func (*RouteAction_HashPolicy_FilterState) Equal

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

Equal function

func (*RouteAction_HashPolicy_FilterState) GetKey

func (*RouteAction_HashPolicy_FilterState) Hash added in v1.6.0

Hash function

func (*RouteAction_HashPolicy_FilterState) ProtoMessage

func (*RouteAction_HashPolicy_FilterState) ProtoMessage()

func (*RouteAction_HashPolicy_FilterState) ProtoReflect added in v1.6.0

func (*RouteAction_HashPolicy_FilterState) Reset

func (*RouteAction_HashPolicy_FilterState) String

type RouteAction_HashPolicy_FilterState_

type RouteAction_HashPolicy_FilterState_ struct {
	// Filter state hash policy.
	FilterState *RouteAction_HashPolicy_FilterState `protobuf:"bytes,6,opt,name=filter_state,json=filterState,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"`
	// If specified, the request header value will be rewritten and used
	// to produce the hash key.
	RegexRewrite *v31.RegexMatchAndSubstitute `protobuf:"bytes,2,opt,name=regex_rewrite,json=regexRewrite,proto3" json:"regex_rewrite,omitempty"`
	// contains filtered or unexported fields
}

func (*RouteAction_HashPolicy_Header) Clone added in v1.8.24

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

func (*RouteAction_HashPolicy_Header) Hash added in v1.6.0

Hash function

func (*RouteAction_HashPolicy_Header) ProtoMessage

func (*RouteAction_HashPolicy_Header) ProtoMessage()

func (*RouteAction_HashPolicy_Header) ProtoReflect added in v1.6.0

func (*RouteAction_HashPolicy_Header) Reset

func (x *RouteAction_HashPolicy_Header) Reset()

func (*RouteAction_HashPolicy_Header) 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_HashPolicy_QueryParameter

type RouteAction_HashPolicy_QueryParameter struct {

	// The name of the URL query parameter that will be used to obtain the hash
	// key. If the parameter is not present, no hash will be produced. Query
	// parameter names are case-sensitive.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*RouteAction_HashPolicy_QueryParameter) Clone added in v1.8.24

Clone function

func (*RouteAction_HashPolicy_QueryParameter) Descriptor deprecated

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

Deprecated: Use RouteAction_HashPolicy_QueryParameter.ProtoReflect.Descriptor instead.

func (*RouteAction_HashPolicy_QueryParameter) Equal

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

Equal function

func (*RouteAction_HashPolicy_QueryParameter) GetName

func (*RouteAction_HashPolicy_QueryParameter) Hash added in v1.6.0

Hash function

func (*RouteAction_HashPolicy_QueryParameter) ProtoMessage

func (*RouteAction_HashPolicy_QueryParameter) ProtoMessage()

func (*RouteAction_HashPolicy_QueryParameter) ProtoReflect added in v1.6.0

func (*RouteAction_HashPolicy_QueryParameter) Reset

func (*RouteAction_HashPolicy_QueryParameter) String

type RouteAction_HashPolicy_QueryParameter_

type RouteAction_HashPolicy_QueryParameter_ struct {
	// Query parameter hash policy.
	QueryParameter *RouteAction_HashPolicy_QueryParameter `protobuf:"bytes,5,opt,name=query_parameter,json=queryParameter,proto3,oneof"`
}

type RouteAction_HostRewriteHeader

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

type RouteAction_HostRewriteLiteral

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

type RouteAction_InternalRedirectAction deprecated

type RouteAction_InternalRedirectAction int32

Configures :ref:`internal redirect <arch_overview_internal_redirects>` behavior. [#next-major-version: remove this definition - it's defined in the InternalRedirectPolicy message.]

Deprecated: Do not use.

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) Enum added in v1.6.0

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 (RouteAction_InternalRedirectAction) String

func (RouteAction_InternalRedirectAction) Type added in v1.6.0

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, 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.
	RuntimeFraction *v3.RuntimeFractionalPercent `protobuf:"bytes,3,opt,name=runtime_fraction,json=runtimeFraction,proto3" json:"runtime_fraction,omitempty"`
	// Determines if the trace span should be sampled. Defaults to true.
	TraceSampled *wrappers.BoolValue `protobuf:"bytes,4,opt,name=trace_sampled,json=traceSampled,proto3" json:"trace_sampled,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*.

.. note::

Shadowing will not be triggered if the primary cluster does not exist.

func (*RouteAction_RequestMirrorPolicy) Clone added in v1.8.24

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 (*RouteAction_RequestMirrorPolicy) GetTraceSampled

func (x *RouteAction_RequestMirrorPolicy) GetTraceSampled() *wrappers.BoolValue

func (*RouteAction_RequestMirrorPolicy) Hash added in v1.6.0

Hash function

func (*RouteAction_RequestMirrorPolicy) ProtoMessage

func (*RouteAction_RequestMirrorPolicy) ProtoMessage()

func (*RouteAction_RequestMirrorPolicy) ProtoReflect added in v1.6.0

func (*RouteAction_RequestMirrorPolicy) Reset

func (*RouteAction_RequestMirrorPolicy) 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"`
	// Configuration for sending data upstream as a raw data payload. This is used for
	// CONNECT requests, when forwarding CONNECT payload as raw TCP.
	// Note that CONNECT support is currently considered alpha in Envoy.
	// [#comment:TODO(htuch): Replace the above comment with an alpha tag.
	ConnectConfig *RouteAction_UpgradeConfig_ConnectConfig `protobuf:"bytes,3,opt,name=connect_config,json=connectConfig,proto3" json:"connect_config,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 :ref:`upgrade_configs <envoy_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.upgrade_configs>` but does not affect any custom filter chain specified there.

func (*RouteAction_UpgradeConfig) Clone added in v1.8.24

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

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

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 (*RouteAction_UpgradeConfig) Reset

func (x *RouteAction_UpgradeConfig) Reset()

func (*RouteAction_UpgradeConfig) String

func (x *RouteAction_UpgradeConfig) String() string

type RouteAction_UpgradeConfig_ConnectConfig

type RouteAction_UpgradeConfig_ConnectConfig struct {

	// If present, the proxy protocol header will be prepended to the CONNECT payload sent upstream.
	ProxyProtocolConfig *v3.ProxyProtocolConfig `protobuf:"bytes,1,opt,name=proxy_protocol_config,json=proxyProtocolConfig,proto3" json:"proxy_protocol_config,omitempty"`
	// contains filtered or unexported fields
}

Configuration for sending data upstream as a raw data payload. This is used for CONNECT requests, when forwarding CONNECT payload as raw TCP.

func (*RouteAction_UpgradeConfig_ConnectConfig) Clone added in v1.8.24

Clone function

func (*RouteAction_UpgradeConfig_ConnectConfig) Descriptor deprecated

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

Deprecated: Use RouteAction_UpgradeConfig_ConnectConfig.ProtoReflect.Descriptor instead.

func (*RouteAction_UpgradeConfig_ConnectConfig) Equal

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

Equal function

func (*RouteAction_UpgradeConfig_ConnectConfig) GetProxyProtocolConfig

func (x *RouteAction_UpgradeConfig_ConnectConfig) GetProxyProtocolConfig() *v3.ProxyProtocolConfig

func (*RouteAction_UpgradeConfig_ConnectConfig) Hash added in v1.6.0

Hash function

func (*RouteAction_UpgradeConfig_ConnectConfig) ProtoMessage

func (*RouteAction_UpgradeConfig_ConnectConfig) ProtoReflect added in v1.6.0

func (*RouteAction_UpgradeConfig_ConnectConfig) Reset

func (*RouteAction_UpgradeConfig_ConnectConfig) 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
	// :ref:`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_SafeRegex
	//	*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 :ref:`traffic shifting
	// <config_http_conn_man_route_table_traffic_splitting_shift>` docs for additional documentation.
	//
	// .. note::
	//
	//    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 *v3.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"`
	// If specified, the client tls context will be matched against the defined
	// match options.
	//
	// [#next-major-version: unify with RBAC]
	TlsContext *RouteMatch_TlsContextMatchOptions `protobuf:"bytes,11,opt,name=tls_context,json=tlsContext,proto3" json:"tls_context,omitempty"`
	// contains filtered or unexported fields
}

[#next-free-field: 13]

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

func (x *RouteMatch) GetConnectMatcher() *RouteMatch_ConnectMatcher

func (*RouteMatch) GetGrpc

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

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

func (*RouteMatch) GetSafeRegex

func (x *RouteMatch) GetSafeRegex() *v31.RegexMatcher

func (*RouteMatch) GetTlsContext

func (x *RouteMatch) GetTlsContext() *RouteMatch_TlsContextMatchOptions

func (*RouteMatch) Hash added in v1.6.0

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

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

An extensible message for matching CONNECT requests.

func (*RouteMatch_ConnectMatcher) Clone added in v1.8.24

Clone function

func (*RouteMatch_ConnectMatcher) Descriptor deprecated

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

Deprecated: Use RouteMatch_ConnectMatcher.ProtoReflect.Descriptor instead.

func (*RouteMatch_ConnectMatcher) Equal

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

Equal function

func (*RouteMatch_ConnectMatcher) Hash added in v1.6.0

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

Hash function

func (*RouteMatch_ConnectMatcher) ProtoMessage

func (*RouteMatch_ConnectMatcher) ProtoMessage()

func (*RouteMatch_ConnectMatcher) ProtoReflect added in v1.6.0

func (*RouteMatch_ConnectMatcher) Reset

func (x *RouteMatch_ConnectMatcher) Reset()

func (*RouteMatch_ConnectMatcher) String

func (x *RouteMatch_ConnectMatcher) String() string

type RouteMatch_ConnectMatcher_

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.
	// [#comment:TODO(htuch): Replace the above comment with an alpha tag.
	ConnectMatcher *RouteMatch_ConnectMatcher `protobuf:"bytes,12,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

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

Hash function

func (*RouteMatch_GrpcRouteMatchOptions) ProtoMessage

func (*RouteMatch_GrpcRouteMatchOptions) ProtoMessage()

func (*RouteMatch_GrpcRouteMatchOptions) ProtoReflect added in v1.6.0

func (*RouteMatch_GrpcRouteMatchOptions) Reset

func (*RouteMatch_GrpcRouteMatchOptions) 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_SafeRegex

type RouteMatch_SafeRegex 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.
	//
	// [#next-major-version: In the v3 API we should redo how path specification works such
	// that we utilize StringMatcher, and additionally have consistent options around whether we
	// strip query strings, do a case sensitive match, etc. In the interim it will be too disruptive
	// to deprecate the existing options. We should even consider whether we want to do away with
	// path_specifier entirely and just rely on a set of header matchers which can already match
	// on :path, etc. The issue with that is it is unclear how to generically deal with query string
	// stripping. This needs more thought.]
	SafeRegex *v31.RegexMatcher `protobuf:"bytes,10,opt,name=safe_regex,json=safeRegex,proto3,oneof"`
}

type RouteMatch_TlsContextMatchOptions

type RouteMatch_TlsContextMatchOptions struct {

	// If specified, the route will match against whether or not a certificate is presented.
	// If not specified, certificate presentation status (true or false) will not be considered when route matching.
	Presented *wrappers.BoolValue `protobuf:"bytes,1,opt,name=presented,proto3" json:"presented,omitempty"`
	// If specified, the route will match against whether or not a certificate is validated.
	// If not specified, certificate validation status (true or false) will not be considered when route matching.
	Validated *wrappers.BoolValue `protobuf:"bytes,2,opt,name=validated,proto3" json:"validated,omitempty"`
	// contains filtered or unexported fields
}

func (*RouteMatch_TlsContextMatchOptions) Clone added in v1.8.24

Clone function

func (*RouteMatch_TlsContextMatchOptions) Descriptor deprecated

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

Deprecated: Use RouteMatch_TlsContextMatchOptions.ProtoReflect.Descriptor instead.

func (*RouteMatch_TlsContextMatchOptions) Equal

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

Equal function

func (*RouteMatch_TlsContextMatchOptions) GetPresented

func (*RouteMatch_TlsContextMatchOptions) GetValidated

func (*RouteMatch_TlsContextMatchOptions) Hash added in v1.6.0

Hash function

func (*RouteMatch_TlsContextMatchOptions) ProtoMessage

func (*RouteMatch_TlsContextMatchOptions) ProtoMessage()

func (*RouteMatch_TlsContextMatchOptions) ProtoReflect added in v1.6.0

func (*RouteMatch_TlsContextMatchOptions) Reset

func (*RouteMatch_TlsContextMatchOptions) String

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_FilterAction

type Route_FilterAction struct {
	// [#not-implemented-hide:]
	// If true, a filter will define the action (e.g., it could dynamically generate the
	// RouteAction).
	// [#comment: TODO(samflattery): Remove cleanup in route_fuzz_test.cc when
	// implemented]
	FilterAction *FilterAction `protobuf:"bytes,17,opt,name=filter_action,json=filterAction,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 :ref:`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 :ref:`HTTP Connection Manager
	// <config_http_conn_man_runtime>`.
	// Default: 100%
	ClientSampling *v32.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
	// :ref:`HTTP Connection Manager <config_http_conn_man_runtime>`.
	// Default: 100%
	RandomSampling *v32.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
	// :ref:`HTTP Connection Manager <config_http_conn_man_runtime>`.
	// Default: 100%
	OverallSampling *v32.FractionalPercent `protobuf:"bytes,3,opt,name=overall_sampling,json=overallSampling,proto3" json:"overall_sampling,omitempty"`
	// A list of custom tags with unique tag name to create tags for the active span.
	// It will take effect after merging with the :ref:`corresponding configuration
	// <envoy_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing.custom_tags>`
	// configured in the HTTP connection manager. If two tags with the same name are configured
	// each in the HTTP connection manager and the route level, the one configured here takes
	// priority.
	CustomTags []*v33.CustomTag `protobuf:"bytes,4,rep,name=custom_tags,json=customTags,proto3" json:"custom_tags,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() *v32.FractionalPercent

func (*Tracing) GetCustomTags

func (x *Tracing) GetCustomTags() []*v33.CustomTag

func (*Tracing) GetOverallSampling

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

func (*Tracing) GetRandomSampling

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

func (*Tracing) Hash added in v1.6.0

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 list of header matchers to use for matching requests. Each specified header must
	// match. The pseudo-headers `:path` and `:method` can be used to match the request path and
	// method, respectively.
	Headers []*HeaderMatcher `protobuf:"bytes,4,rep,name=headers,proto3" json:"headers,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 :ref:`here <config_http_filters_router_stats>`.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,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 :ref:`virtual cluster statistics <config_http_filters_router_vcluster_stats>`.

.. note::

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

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

func (*VirtualCluster) GetName

func (x *VirtualCluster) GetName() string

func (*VirtualCluster) Hash added in v1.6.0

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.
	//
	// .. note::
	//
	//   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 cannot contain control characters. This is validated by the well_known_regex HTTP_HEADER_VALUE.
	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 `` /* 158-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 :ref:`envoy_api_msg_config.route.v3.Route` and before headers from the
	// enclosing :ref:`envoy_api_msg_config.route.v3.RouteConfiguration`. For more information, including
	// details on header value syntax, see the documentation on :ref:`custom request headers
	// <config_http_conn_man_headers_custom_request_headers>`.
	RequestHeadersToAdd []*v3.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 :ref:`envoy_api_msg_config.route.v3.Route` and before headers from the
	// enclosing :ref:`envoy_api_msg_config.route.v3.RouteConfiguration`. For more information, including
	// details on header value syntax, see the documentation on :ref:`custom request headers
	// <config_http_conn_man_headers_custom_request_headers>`.
	ResponseHeadersToAdd []*v3.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 :ref:`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 :ref:`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
	// :ref:`suppress_envoy_headers
	// <envoy_api_field_extensions.filters.http.router.v3.Router.suppress_envoy_headers>` flag.
	//
	// [#next-major-version: rename to include_attempt_count_in_request.]
	IncludeRequestAttemptCount bool `` /* 145-byte string literal not displayed */
	// Decides whether the :ref:`x-envoy-attempt-count
	// <config_http_filters_router_x-envoy-attempt-count>` header should be included
	// in the downstream response. Setting this option will cause the router to override any existing header
	// value, so in the case of two Envoys on the request path with this option enabled, the downstream
	// will see the attempt count as perceived by the Envoy closest upstream from itself. Defaults to false.
	// This header is unaffected by the
	// :ref:`suppress_envoy_headers
	// <envoy_api_field_extensions.filters.http.router.v3.Router.suppress_envoy_headers>` flag.
	IncludeAttemptCountInResponse bool `` /* 156-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"`
	// [#not-implemented-hide:]
	// Specifies the configuration for retry policy extension. 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). :ref:`Retry policy <envoy_api_field_config.route.v3.VirtualHost.retry_policy>` should not be
	// set if this field is used.
	RetryPolicyTypedConfig *any1.Any `` /* 132-byte string literal not displayed */
	// 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"`
	// The maximum bytes which will be buffered for retries and shadowing.
	// If set and a route-specific limit is not set, the bytes actually buffered will be the minimum
	// value of this and the listener per_connection_buffer_limit_bytes.
	PerRequestBufferLimitBytes *wrappers.UInt32Value `` /* 146-byte string literal not displayed */
	// 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. [#next-free-field: 21]

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

func (x *VirtualHost) GetIncludeAttemptCountInResponse() bool

func (*VirtualHost) GetIncludeRequestAttemptCount

func (x *VirtualHost) GetIncludeRequestAttemptCount() bool

func (*VirtualHost) GetName

func (x *VirtualHost) GetName() string

func (*VirtualHost) GetPerRequestBufferLimitBytes

func (x *VirtualHost) GetPerRequestBufferLimitBytes() *wrappers.UInt32Value

func (*VirtualHost) GetRateLimits

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

func (*VirtualHost) GetRequestHeadersToAdd

func (x *VirtualHost) GetRequestHeadersToAdd() []*v3.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() []*v3.HeaderValueOption

func (*VirtualHost) GetResponseHeadersToRemove

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

func (*VirtualHost) GetRetryPolicy

func (x *VirtualHost) GetRetryPolicy() *RetryPolicy

func (*VirtualHost) GetRetryPolicyTypedConfig

func (x *VirtualHost) GetRetryPolicyTypedConfig() *any1.Any

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

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) Enum added in v1.6.0

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 (VirtualHost_TlsRequirementType) String

func (VirtualHost_TlsRequirementType) Type added in v1.6.0

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 :ref:`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 :ref:`cluster <envoy_api_field_config.route.v3.RouteAction.cluster>` field that specifies a single upstream cluster as the target of a request, the :ref:`weighted_clusters <envoy_api_field_config.route.v3.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.6.0

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
	// :ref:`cluster manager configuration <config_cluster_manager>`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// An integer between 0 and :ref:`total_weight
	// <envoy_api_field_config.route.v3.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
	// :ref:`RouteAction.metadata_match <envoy_api_field_config.route.v3.RouteAction.metadata_match>`, with
	// values here taking precedence. The filter name should be specified as *envoy.lb*.
	MetadataMatch *v3.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 :ref:`envoy_api_msg_config.route.v3.RouteAction`.
	// Headers specified at this level are applied before headers from the enclosing
	// :ref:`envoy_api_msg_config.route.v3.Route`, :ref:`envoy_api_msg_config.route.v3.VirtualHost`, and
	// :ref:`envoy_api_msg_config.route.v3.RouteConfiguration`. For more information, including details on
	// header value syntax, see the documentation on :ref:`custom request headers
	// <config_http_conn_man_headers_custom_request_headers>`.
	RequestHeadersToAdd []*v3.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 :ref:`envoy_api_msg_config.route.v3.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 :ref:`envoy_api_msg_config.route.v3.RouteAction`.
	// Headers specified at this level are applied before headers from the enclosing
	// :ref:`envoy_api_msg_config.route.v3.Route`, :ref:`envoy_api_msg_config.route.v3.VirtualHost`, and
	// :ref:`envoy_api_msg_config.route.v3.RouteConfiguration`. For more information, including details on
	// header value syntax, see the documentation on :ref:`custom request headers
	// <config_http_conn_man_headers_custom_request_headers>`.
	ResponseHeadersToAdd []*v3.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 :ref:`envoy_api_msg_config.route.v3.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 :ref:`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
}

[#next-free-field: 11]

func (*WeightedCluster_ClusterWeight) Clone added in v1.8.24

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() *v3.Metadata

func (*WeightedCluster_ClusterWeight) GetName

func (*WeightedCluster_ClusterWeight) GetRequestHeadersToAdd

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

func (*WeightedCluster_ClusterWeight) GetRequestHeadersToRemove

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

func (*WeightedCluster_ClusterWeight) GetResponseHeadersToAdd

func (x *WeightedCluster_ClusterWeight) GetResponseHeadersToAdd() []*v3.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 (*WeightedCluster_ClusterWeight) Hash added in v1.6.0

Hash function

func (*WeightedCluster_ClusterWeight) ProtoMessage

func (*WeightedCluster_ClusterWeight) ProtoMessage()

func (*WeightedCluster_ClusterWeight) ProtoReflect added in v1.6.0

func (*WeightedCluster_ClusterWeight) Reset

func (x *WeightedCluster_ClusterWeight) Reset()

func (*WeightedCluster_ClusterWeight) String

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL