envoy_api_v2_route

package
v0.9.8 Latest Latest
Warning

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

 Go to latest Published: Dec 7, 2020 License: Apache-2.0 Imports: 27 Imported by: 262

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_envoy_api_v2_route_route_components_proto protoreflect.FileDescriptor
View Source 
var File_envoy_api_v2_route_route_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type CorsPolicy 

type CorsPolicy struct {

	// Specifies the origins that will be allowed to do CORS requests.
	//
	// An origin is allowed if either allow_origin or allow_origin_regex match.
	//
	// .. attention::
	//  This field has been deprecated in favor of `allow_origin_string_match`.
	//
	// Deprecated: Do not use.
	AllowOrigin []string `protobuf:"bytes,1,rep,name=allow_origin,json=allowOrigin,proto3" json:"allow_origin,omitempty"`
	// Specifies regex patterns that match allowed origins.
	//
	// An origin is allowed if either allow_origin or allow_origin_regex match.
	//
	// .. attention::
	//   This field has been deprecated in favor of `allow_origin_string_match` as it is not safe for
	//   use with untrusted input in all cases.
	//
	// Deprecated: Do not use.
	AllowOriginRegex []string `protobuf:"bytes,8,rep,name=allow_origin_regex,json=allowOriginRegex,proto3" json:"allow_origin_regex,omitempty"`
	// Specifies string patterns that match allowed origins. An origin is allowed if any of the
	// string matchers match.
	AllowOriginStringMatch []*matcher.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_Enabled
	//	*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_core.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 *core.RuntimeFractionalPercent `protobuf:"bytes,10,opt,name=shadow_enabled,json=shadowEnabled,proto3" json:"shadow_enabled,omitempty"`
	// contains filtered or unexported fields
}

[#next-free-field: 12]

func (*CorsPolicy) Descriptor deprecated 

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

Deprecated: Use CorsPolicy.ProtoReflect.Descriptor instead.

func (*CorsPolicy) GetAllowCredentials 

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

func (*CorsPolicy) GetAllowHeaders 

func (x *CorsPolicy) GetAllowHeaders() string

func (*CorsPolicy) GetAllowMethods 

func (x *CorsPolicy) GetAllowMethods() string

func (*CorsPolicy) GetAllowOrigin deprecated 

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

Deprecated: Do not use.

func (*CorsPolicy) GetAllowOriginRegex deprecated 

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

Deprecated: Do not use.

func (*CorsPolicy) GetAllowOriginStringMatch added in v0.9.0 

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

func (*CorsPolicy) GetEnabled deprecated 

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

Deprecated: Do not use.

func (*CorsPolicy) GetEnabledSpecifier added in v0.6.7 

func (m *CorsPolicy) GetEnabledSpecifier() isCorsPolicy_EnabledSpecifier

func (*CorsPolicy) GetExposeHeaders 

func (x *CorsPolicy) GetExposeHeaders() string

func (*CorsPolicy) GetFilterEnabled added in v0.6.7 

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

func (*CorsPolicy) GetMaxAge 

func (x *CorsPolicy) GetMaxAge() string

func (*CorsPolicy) GetShadowEnabled added in v0.6.7 

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

func (*CorsPolicy) ProtoMessage 

func (*CorsPolicy) ProtoMessage()

func (*CorsPolicy) ProtoReflect added in v0.9.6 

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

func (*CorsPolicy) Reset 

func (x *CorsPolicy) Reset()

func (*CorsPolicy) String 

func (x *CorsPolicy) String() string

func (*CorsPolicy) Validate 

func (m *CorsPolicy) Validate() error

Validate checks the field values on CorsPolicy with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type CorsPolicyValidationError 

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

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

func (CorsPolicyValidationError) Cause 

func (e CorsPolicyValidationError) Cause() error

Cause function returns cause value.

func (CorsPolicyValidationError) Error 

func (e CorsPolicyValidationError) Error() string

Error satisfies the builtin error interface

func (CorsPolicyValidationError) ErrorName added in v0.7.0 

func (e CorsPolicyValidationError) ErrorName() string

ErrorName returns error name.

func (CorsPolicyValidationError) Field 

func (e CorsPolicyValidationError) Field() string

Field function returns field value.

func (CorsPolicyValidationError) Key 

func (e CorsPolicyValidationError) Key() bool

Key function returns key value.

func (CorsPolicyValidationError) Reason 

func (e CorsPolicyValidationError) Reason() string

Reason function returns reason value.

type CorsPolicy_Enabled added in v0.6.7 

type CorsPolicy_Enabled struct {
	// Specifies if the CORS filter is enabled. Defaults to true. Only effective on route.
	//
	// .. attention::
	//
	//   **This field is deprecated**. Set the
	//   :ref:`filter_enabled<envoy_api_field_route.CorsPolicy.filter_enabled>` field instead.
	//
	// Deprecated: Do not use.
	Enabled *wrappers.BoolValue `protobuf:"bytes,7,opt,name=enabled,proto3,oneof"`
}

type CorsPolicy_FilterEnabled added in v0.6.7 

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_core.RuntimeFractionalPercent.runtime_key>` is
	// specified, Envoy will lookup the runtime key to get the percentage of requests to filter.
	FilterEnabled *core.RuntimeFractionalPercent `protobuf:"bytes,9,opt,name=filter_enabled,json=filterEnabled,proto3,oneof"`
}

type Decorator 

type Decorator struct {

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

func (*Decorator) Descriptor deprecated 

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

Deprecated: Use Decorator.ProtoReflect.Descriptor instead.

func (*Decorator) GetOperation 

func (x *Decorator) GetOperation() string

func (*Decorator) GetPropagate added in v0.9.3 

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

func (*Decorator) ProtoMessage 

func (*Decorator) ProtoMessage()

func (*Decorator) ProtoReflect added in v0.9.6 

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

func (*Decorator) Reset 

func (x *Decorator) Reset()

func (*Decorator) String 

func (x *Decorator) String() string

func (*Decorator) Validate 

func (m *Decorator) Validate() error

Validate checks the field values on Decorator with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type DecoratorValidationError 

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

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

func (DecoratorValidationError) Cause 

func (e DecoratorValidationError) Cause() error

Cause function returns cause value.

func (DecoratorValidationError) Error 

func (e DecoratorValidationError) Error() string

Error satisfies the builtin error interface

func (DecoratorValidationError) ErrorName added in v0.7.0 

func (e DecoratorValidationError) ErrorName() string

ErrorName returns error name.

func (DecoratorValidationError) Field 

func (e DecoratorValidationError) Field() string

Field function returns field value.

func (DecoratorValidationError) Key 

func (e DecoratorValidationError) Key() bool

Key function returns key value.

func (DecoratorValidationError) Reason 

func (e DecoratorValidationError) Reason() string

Reason function returns reason value.

type DirectResponseAction 

type DirectResponseAction struct {

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

func (*DirectResponseAction) Descriptor deprecated 

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

Deprecated: Use DirectResponseAction.ProtoReflect.Descriptor instead.

func (*DirectResponseAction) GetBody 

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

func (*DirectResponseAction) GetStatus 

func (x *DirectResponseAction) GetStatus() uint32

func (*DirectResponseAction) ProtoMessage 

func (*DirectResponseAction) ProtoMessage()

func (*DirectResponseAction) ProtoReflect added in v0.9.6 

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

func (*DirectResponseAction) Reset 

func (x *DirectResponseAction) Reset()

func (*DirectResponseAction) String 

func (x *DirectResponseAction) String() string

func (*DirectResponseAction) Validate 

func (m *DirectResponseAction) Validate() error

Validate checks the field values on DirectResponseAction with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type DirectResponseActionValidationError 

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

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

func (DirectResponseActionValidationError) Cause 

func (e DirectResponseActionValidationError) Cause() error

Cause function returns cause value.

func (DirectResponseActionValidationError) Error 

func (e DirectResponseActionValidationError) Error() string

Error satisfies the builtin error interface

func (DirectResponseActionValidationError) ErrorName added in v0.7.0 

func (e DirectResponseActionValidationError) ErrorName() string

ErrorName returns error name.

func (DirectResponseActionValidationError) Field 

func (e DirectResponseActionValidationError) Field() string

Field function returns field value.

func (DirectResponseActionValidationError) Key 

func (e DirectResponseActionValidationError) Key() bool

Key function returns key value.

func (DirectResponseActionValidationError) Reason 

func (e DirectResponseActionValidationError) Reason() string

Reason function returns reason value.

type FilterAction added in v0.9.2 

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

A filter-defined action type.

func (*FilterAction) Descriptor deprecated added in v0.9.2 

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

Deprecated: Use FilterAction.ProtoReflect.Descriptor instead.

func (*FilterAction) GetAction added in v0.9.2 

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

func (*FilterAction) ProtoMessage added in v0.9.2 

func (*FilterAction) ProtoMessage()

func (*FilterAction) ProtoReflect added in v0.9.6 

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

func (*FilterAction) Reset added in v0.9.2 

func (x *FilterAction) Reset()

func (*FilterAction) String added in v0.9.2 

func (x *FilterAction) String() string

func (*FilterAction) Validate added in v0.9.2 

func (m *FilterAction) Validate() error

Validate checks the field values on FilterAction with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type FilterActionValidationError added in v0.9.2 

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

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

func (FilterActionValidationError) Cause added in v0.9.2 

func (e FilterActionValidationError) Cause() error

Cause function returns cause value.

func (FilterActionValidationError) Error added in v0.9.2 

func (e FilterActionValidationError) Error() string

Error satisfies the builtin error interface

func (FilterActionValidationError) ErrorName added in v0.9.2 

func (e FilterActionValidationError) ErrorName() string

ErrorName returns error name.

func (FilterActionValidationError) Field added in v0.9.2 

func (e FilterActionValidationError) Field() string

Field function returns field value.

func (FilterActionValidationError) Key added in v0.9.2 

func (e FilterActionValidationError) Key() bool

Key function returns key value.

func (FilterActionValidationError) Reason added in v0.9.2 

func (e FilterActionValidationError) Reason() string

Reason function returns reason value.

type HeaderMatcher 

type HeaderMatcher struct {

	// Specifies the name of the header in the request.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Specifies how the header match will be performed to route the request.
	//
	// Types that are assignable to HeaderMatchSpecifier:
	//	*HeaderMatcher_ExactMatch
	//	*HeaderMatcher_RegexMatch
	//	*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_route.HeaderMatcher.present_match>`. i.e, a request that has the :ref:`name
 <envoy_api_field_route.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) Descriptor deprecated 

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

Deprecated: Use HeaderMatcher.ProtoReflect.Descriptor instead.

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

func (*HeaderMatcher) GetRegexMatch deprecated 

func (x *HeaderMatcher) GetRegexMatch() string

Deprecated: Do not use.

func (*HeaderMatcher) GetSafeRegexMatch added in v0.9.0 

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

func (*HeaderMatcher) GetSuffixMatch 

func (x *HeaderMatcher) GetSuffixMatch() string

func (*HeaderMatcher) ProtoMessage 

func (*HeaderMatcher) ProtoMessage()

func (*HeaderMatcher) ProtoReflect added in v0.9.6 

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

func (*HeaderMatcher) Reset 

func (x *HeaderMatcher) Reset()

func (*HeaderMatcher) String 

func (x *HeaderMatcher) String() string

func (*HeaderMatcher) Validate 

func (m *HeaderMatcher) Validate() error

Validate checks the field values on HeaderMatcher with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type HeaderMatcherValidationError 

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

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

func (HeaderMatcherValidationError) Cause 

func (e HeaderMatcherValidationError) Cause() error

Cause function returns cause value.

func (HeaderMatcherValidationError) Error 

func (e HeaderMatcherValidationError) Error() string

Error satisfies the builtin error interface

func (HeaderMatcherValidationError) ErrorName added in v0.7.0 

func (e HeaderMatcherValidationError) ErrorName() string

ErrorName returns error name.

func (HeaderMatcherValidationError) Field 

func (e HeaderMatcherValidationError) Field() string

Field function returns field value.

func (HeaderMatcherValidationError) Key 

func (e HeaderMatcherValidationError) Key() bool

Key function returns key value.

func (HeaderMatcherValidationError) Reason 

func (e HeaderMatcherValidationError) Reason() string

Reason function returns reason value.

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

type HeaderMatcher_RegexMatch 

type HeaderMatcher_RegexMatch struct {
	// If specified, this regex string is a regular expression rule which implies the entire request
	// header value must match the regex. The rule will not match if only a subsequence of the
	// request header value matches the regex. The regex grammar used in the value field is defined
	// `here <https://en.cppreference.com/w/cpp/regex/ecmascript>`_.
	//
	// Examples:
	//
	// * The regex “\d{3}“ matches the value *123*
	// * The regex “\d{3}“ does not match the value *1234*
	// * The regex “\d{3}“ does not match the value *123.456*
	//
	// .. attention::
	//   This field has been deprecated in favor of `safe_regex_match` as it is not safe for use
	//   with untrusted input in all cases.
	//
	// Deprecated: Do not use.
	RegexMatch string `protobuf:"bytes,5,opt,name=regex_match,json=regexMatch,proto3,oneof"`
}

type HeaderMatcher_SafeRegexMatch added in v0.9.0 

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 *matcher.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 added in v0.6.8 

type HedgePolicy struct {

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

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

func (*HedgePolicy) Descriptor deprecated added in v0.6.8 

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

Deprecated: Use HedgePolicy.ProtoReflect.Descriptor instead.

func (*HedgePolicy) GetAdditionalRequestChance added in v0.6.8 

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

func (*HedgePolicy) GetHedgeOnPerTryTimeout added in v0.6.8 

func (x *HedgePolicy) GetHedgeOnPerTryTimeout() bool

func (*HedgePolicy) GetInitialRequests added in v0.6.8 

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

func (*HedgePolicy) ProtoMessage added in v0.6.8 

func (*HedgePolicy) ProtoMessage()

func (*HedgePolicy) ProtoReflect added in v0.9.6 

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

func (*HedgePolicy) Reset added in v0.6.8 

func (x *HedgePolicy) Reset()

func (*HedgePolicy) String added in v0.6.8 

func (x *HedgePolicy) String() string

func (*HedgePolicy) Validate added in v0.6.8 

func (m *HedgePolicy) Validate() error

Validate checks the field values on HedgePolicy with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type HedgePolicyValidationError added in v0.6.8 

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

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

func (HedgePolicyValidationError) Cause added in v0.6.8 

func (e HedgePolicyValidationError) Cause() error

Cause function returns cause value.

func (HedgePolicyValidationError) Error added in v0.6.8 

func (e HedgePolicyValidationError) Error() string

Error satisfies the builtin error interface

func (HedgePolicyValidationError) ErrorName added in v0.7.0 

func (e HedgePolicyValidationError) ErrorName() string

ErrorName returns error name.

func (HedgePolicyValidationError) Field added in v0.6.8 

func (e HedgePolicyValidationError) Field() string

Field function returns field value.

func (HedgePolicyValidationError) Key added in v0.6.8 

func (e HedgePolicyValidationError) Key() bool

Key function returns key value.

func (HedgePolicyValidationError) Reason added in v0.6.8 

func (e HedgePolicyValidationError) Reason() string

Reason function returns reason value.

type QueryParameterMatcher 

type QueryParameterMatcher struct {

	// Specifies the name of a key that must be present in the requested
	// *path*'s query string.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Specifies the value of the key. If the value is absent, a request
	// that contains the key in its query string will match, whether the
	// key appears with a value (e.g., "?debug=true") or not (e.g., "?debug")
	//
	// ..attention::
	//   This field is deprecated. Use an `exact` match inside the `string_match` field.
	//
	// Deprecated: Do not use.
	Value string `protobuf:"bytes,3,opt,name=value,proto3" json:"value,omitempty"`
	// Specifies whether the query parameter value is a regular expression.
	// Defaults to false. The entire query parameter value (i.e., the part to
	// the right of the equals sign in "key=value") must match the regex.
	// E.g., the regex “\d+$“ will match *123* but not *a123* or *123a*.
	//
	// ..attention::
	//   This field is deprecated. Use a `safe_regex` match inside the `string_match` field.
	//
	// Deprecated: Do not use.
	Regex *wrappers.BoolValue `protobuf:"bytes,4,opt,name=regex,proto3" json:"regex,omitempty"`
	// Types that are assignable to QueryParameterMatchSpecifier:
	//	*QueryParameterMatcher_StringMatch
	//	*QueryParameterMatcher_PresentMatch
	QueryParameterMatchSpecifier isQueryParameterMatcher_QueryParameterMatchSpecifier `protobuf_oneof:"query_parameter_match_specifier"`
	// contains filtered or unexported fields
}

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

func (*QueryParameterMatcher) Descriptor deprecated 

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

Deprecated: Use QueryParameterMatcher.ProtoReflect.Descriptor instead.

func (*QueryParameterMatcher) GetName 

func (x *QueryParameterMatcher) GetName() string

func (*QueryParameterMatcher) GetPresentMatch added in v0.9.0 

func (x *QueryParameterMatcher) GetPresentMatch() bool

func (*QueryParameterMatcher) GetQueryParameterMatchSpecifier added in v0.9.0 

func (m *QueryParameterMatcher) GetQueryParameterMatchSpecifier() isQueryParameterMatcher_QueryParameterMatchSpecifier

func (*QueryParameterMatcher) GetRegex deprecated 

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

Deprecated: Do not use.

func (*QueryParameterMatcher) GetStringMatch added in v0.9.0 

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

func (*QueryParameterMatcher) GetValue deprecated 

func (x *QueryParameterMatcher) GetValue() string

Deprecated: Do not use.

func (*QueryParameterMatcher) ProtoMessage 

func (*QueryParameterMatcher) ProtoMessage()

func (*QueryParameterMatcher) ProtoReflect added in v0.9.6 

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

func (*QueryParameterMatcher) Reset 

func (x *QueryParameterMatcher) Reset()

func (*QueryParameterMatcher) String 

func (x *QueryParameterMatcher) String() string

func (*QueryParameterMatcher) Validate 

func (m *QueryParameterMatcher) Validate() error

Validate checks the field values on QueryParameterMatcher with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type QueryParameterMatcherValidationError 

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

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

func (QueryParameterMatcherValidationError) Cause 

func (e QueryParameterMatcherValidationError) Cause() error

Cause function returns cause value.

func (QueryParameterMatcherValidationError) Error 

func (e QueryParameterMatcherValidationError) Error() string

Error satisfies the builtin error interface

func (QueryParameterMatcherValidationError) ErrorName added in v0.7.0 

func (e QueryParameterMatcherValidationError) ErrorName() string

ErrorName returns error name.

func (QueryParameterMatcherValidationError) Field 

func (e QueryParameterMatcherValidationError) Field() string

Field function returns field value.

func (QueryParameterMatcherValidationError) Key 

func (e QueryParameterMatcherValidationError) Key() bool

Key function returns key value.

func (QueryParameterMatcherValidationError) Reason 

func (e QueryParameterMatcherValidationError) Reason() string

Reason function returns reason value.

type QueryParameterMatcher_PresentMatch added in v0.9.0 

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

type QueryParameterMatcher_StringMatch struct {
	// Specifies whether a query parameter value should match against a string.
	StringMatch *matcher.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"`
	// contains filtered or unexported fields
}

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

func (*RateLimit) Descriptor deprecated 

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

Deprecated: Use RateLimit.ProtoReflect.Descriptor instead.

func (*RateLimit) GetActions 

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

func (*RateLimit) GetDisableKey 

func (x *RateLimit) GetDisableKey() string

func (*RateLimit) GetStage 

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

func (*RateLimit) ProtoMessage 

func (*RateLimit) ProtoMessage()

func (*RateLimit) ProtoReflect added in v0.9.6 

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

func (*RateLimit) Reset 

func (x *RateLimit) Reset()

func (*RateLimit) String 

func (x *RateLimit) String() string

func (*RateLimit) Validate 

func (m *RateLimit) Validate() error

Validate checks the field values on RateLimit with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type RateLimitValidationError 

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

RateLimitValidationError is the validation error returned by RateLimit.Validate if the designated constraints aren't met.

func (RateLimitValidationError) Cause 

func (e RateLimitValidationError) Cause() error

Cause function returns cause value.

func (RateLimitValidationError) Error 

func (e RateLimitValidationError) Error() string

Error satisfies the builtin error interface

func (RateLimitValidationError) ErrorName added in v0.7.0 

func (e RateLimitValidationError) ErrorName() string

ErrorName returns error name.

func (RateLimitValidationError) Field 

func (e RateLimitValidationError) Field() string

Field function returns field value.

func (RateLimitValidationError) Key 

func (e RateLimitValidationError) Key() bool

Key function returns key value.

func (RateLimitValidationError) Reason 

func (e RateLimitValidationError) Reason() string

Reason function returns reason value.

type RateLimit_Action 

type RateLimit_Action struct {

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

[#next-free-field: 7]

func (*RateLimit_Action) Descriptor deprecated 

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

Deprecated: Use RateLimit_Action.ProtoReflect.Descriptor instead.

func (*RateLimit_Action) GetActionSpecifier 

func (m *RateLimit_Action) GetActionSpecifier() isRateLimit_Action_ActionSpecifier

func (*RateLimit_Action) GetDestinationCluster 

func (x *RateLimit_Action) GetDestinationCluster() *RateLimit_Action_DestinationCluster

func (*RateLimit_Action) 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) ProtoMessage 

func (*RateLimit_Action) ProtoMessage()

func (*RateLimit_Action) ProtoReflect added in v0.9.6 

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

func (*RateLimit_Action) Reset 

func (x *RateLimit_Action) Reset()

func (*RateLimit_Action) String 

func (x *RateLimit_Action) String() string

func (*RateLimit_Action) Validate 

func (m *RateLimit_Action) Validate() error

Validate checks the field values on RateLimit_Action with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type RateLimit_ActionValidationError 

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

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

func (RateLimit_ActionValidationError) Cause 

func (e RateLimit_ActionValidationError) Cause() error

Cause function returns cause value.

func (RateLimit_ActionValidationError) Error 

func (e RateLimit_ActionValidationError) Error() string

Error satisfies the builtin error interface

func (RateLimit_ActionValidationError) ErrorName added in v0.7.0 

func (e RateLimit_ActionValidationError) ErrorName() string

ErrorName returns error name.

func (RateLimit_ActionValidationError) Field 

func (e RateLimit_ActionValidationError) Field() string

Field function returns field value.

func (RateLimit_ActionValidationError) Key 

func (e RateLimit_ActionValidationError) Key() bool

Key function returns key value.

func (RateLimit_ActionValidationError) Reason 

func (e RateLimit_ActionValidationError) Reason() string

Reason function returns reason value.

type RateLimit_Action_DestinationCluster 

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

The following descriptor entry is appended to the descriptor:

.. code-block:: cpp 

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

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

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

func (*RateLimit_Action_DestinationCluster) Descriptor deprecated 

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

Deprecated: Use RateLimit_Action_DestinationCluster.ProtoReflect.Descriptor instead.

func (*RateLimit_Action_DestinationCluster) ProtoMessage 

func (*RateLimit_Action_DestinationCluster) ProtoMessage()

func (*RateLimit_Action_DestinationCluster) ProtoReflect added in v0.9.6 

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

func (*RateLimit_Action_DestinationCluster) Reset 

func (x *RateLimit_Action_DestinationCluster) Reset()

func (*RateLimit_Action_DestinationCluster) String 

func (x *RateLimit_Action_DestinationCluster) String() string

func (*RateLimit_Action_DestinationCluster) Validate 

func (m *RateLimit_Action_DestinationCluster) Validate() error

Validate checks the field values on RateLimit_Action_DestinationCluster with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type RateLimit_Action_DestinationClusterValidationError 

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

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

func (RateLimit_Action_DestinationClusterValidationError) Cause 

func (e RateLimit_Action_DestinationClusterValidationError) Cause() error

Cause function returns cause value.

func (RateLimit_Action_DestinationClusterValidationError) Error 

func (e RateLimit_Action_DestinationClusterValidationError) Error() string

Error satisfies the builtin error interface

func (RateLimit_Action_DestinationClusterValidationError) ErrorName added in v0.7.0 

func (e RateLimit_Action_DestinationClusterValidationError) ErrorName() string

ErrorName returns error name.

func (RateLimit_Action_DestinationClusterValidationError) Field 

func (e RateLimit_Action_DestinationClusterValidationError) Field() string

Field function returns field value.

func (RateLimit_Action_DestinationClusterValidationError) Key 

func (e RateLimit_Action_DestinationClusterValidationError) Key() bool

Key function returns key value.

func (RateLimit_Action_DestinationClusterValidationError) Reason 

func (e RateLimit_Action_DestinationClusterValidationError) Reason() string

Reason function returns reason value.

type RateLimit_Action_DestinationCluster_ 

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

type RateLimit_Action_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) Descriptor deprecated 

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

Deprecated: Use RateLimit_Action_GenericKey.ProtoReflect.Descriptor instead.

func (*RateLimit_Action_GenericKey) GetDescriptorValue 

func (x *RateLimit_Action_GenericKey) GetDescriptorValue() string

func (*RateLimit_Action_GenericKey) ProtoMessage 

func (*RateLimit_Action_GenericKey) ProtoMessage()

func (*RateLimit_Action_GenericKey) ProtoReflect added in v0.9.6 

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

func (*RateLimit_Action_GenericKey) Reset 

func (x *RateLimit_Action_GenericKey) Reset()

func (*RateLimit_Action_GenericKey) String 

func (x *RateLimit_Action_GenericKey) String() string

func (*RateLimit_Action_GenericKey) Validate 

func (m *RateLimit_Action_GenericKey) Validate() error

Validate checks the field values on RateLimit_Action_GenericKey with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type RateLimit_Action_GenericKeyValidationError 

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

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

func (RateLimit_Action_GenericKeyValidationError) Cause 

func (e RateLimit_Action_GenericKeyValidationError) Cause() error

Cause function returns cause value.

func (RateLimit_Action_GenericKeyValidationError) Error 

func (e RateLimit_Action_GenericKeyValidationError) Error() string

Error satisfies the builtin error interface

func (RateLimit_Action_GenericKeyValidationError) ErrorName added in v0.7.0 

func (e RateLimit_Action_GenericKeyValidationError) ErrorName() string

ErrorName returns error name.

func (RateLimit_Action_GenericKeyValidationError) Field 

func (e RateLimit_Action_GenericKeyValidationError) Field() string

Field function returns field value.

func (RateLimit_Action_GenericKeyValidationError) Key 

func (e RateLimit_Action_GenericKeyValidationError) Key() bool

Key function returns key value.

func (RateLimit_Action_GenericKeyValidationError) Reason 

func (e RateLimit_Action_GenericKeyValidationError) Reason() string

Reason function returns reason value.

type RateLimit_Action_GenericKey_ 

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

type RateLimit_Action_HeaderValueMatch 

type RateLimit_Action_HeaderValueMatch struct {

	// The value to use in the descriptor entry.
	DescriptorValue string `protobuf:"bytes,1,opt,name=descriptor_value,json=descriptorValue,proto3" json:"descriptor_value,omitempty"`
	// If set to true, the action will append a descriptor entry when the
	// request matches the headers. If set to false, the action will append a
	// descriptor entry when the request does not match the headers. The
	// default value is true.
	ExpectMatch *wrappers.BoolValue `protobuf:"bytes,2,opt,name=expect_match,json=expectMatch,proto3" json:"expect_match,omitempty"`
	// Specifies a set of headers that the rate limit action should match
	// on. The action will check the request’s headers against all the
	// specified headers in the config. A match will happen if all the
	// headers in the config are present in the request with the same values
	// (or based on presence if the value field is not in the config).
	Headers []*HeaderMatcher `protobuf:"bytes,3,rep,name=headers,proto3" json:"headers,omitempty"`
	// contains filtered or unexported fields
}

The following descriptor entry is appended to the descriptor:

.. code-block:: cpp 

("header_match", "<descriptor_value>")

func (*RateLimit_Action_HeaderValueMatch) Descriptor deprecated 

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

Deprecated: Use RateLimit_Action_HeaderValueMatch.ProtoReflect.Descriptor instead.

func (*RateLimit_Action_HeaderValueMatch) GetDescriptorValue 

func (x *RateLimit_Action_HeaderValueMatch) GetDescriptorValue() string

func (*RateLimit_Action_HeaderValueMatch) GetExpectMatch 

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

func (*RateLimit_Action_HeaderValueMatch) GetHeaders 

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

func (*RateLimit_Action_HeaderValueMatch) ProtoMessage 

func (*RateLimit_Action_HeaderValueMatch) ProtoMessage()

func (*RateLimit_Action_HeaderValueMatch) ProtoReflect added in v0.9.6 

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

func (*RateLimit_Action_HeaderValueMatch) Reset 

func (x *RateLimit_Action_HeaderValueMatch) Reset()

func (*RateLimit_Action_HeaderValueMatch) String 

func (x *RateLimit_Action_HeaderValueMatch) String() string

func (*RateLimit_Action_HeaderValueMatch) Validate 

func (m *RateLimit_Action_HeaderValueMatch) Validate() error

Validate checks the field values on RateLimit_Action_HeaderValueMatch with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type RateLimit_Action_HeaderValueMatchValidationError 

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

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

func (RateLimit_Action_HeaderValueMatchValidationError) Cause 

func (e RateLimit_Action_HeaderValueMatchValidationError) Cause() error

Cause function returns cause value.

func (RateLimit_Action_HeaderValueMatchValidationError) Error 

func (e RateLimit_Action_HeaderValueMatchValidationError) Error() string

Error satisfies the builtin error interface

func (RateLimit_Action_HeaderValueMatchValidationError) ErrorName added in v0.7.0 

func (e RateLimit_Action_HeaderValueMatchValidationError) ErrorName() string

ErrorName returns error name.

func (RateLimit_Action_HeaderValueMatchValidationError) Field 

func (e RateLimit_Action_HeaderValueMatchValidationError) Field() string

Field function returns field value.

func (RateLimit_Action_HeaderValueMatchValidationError) Key 

func (e RateLimit_Action_HeaderValueMatchValidationError) Key() bool

Key function returns key value.

func (RateLimit_Action_HeaderValueMatchValidationError) Reason 

func (e RateLimit_Action_HeaderValueMatchValidationError) Reason() string

Reason function returns reason value.

type RateLimit_Action_HeaderValueMatch_ 

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

type RateLimit_Action_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) Descriptor deprecated 

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

Deprecated: Use RateLimit_Action_RemoteAddress.ProtoReflect.Descriptor instead.

func (*RateLimit_Action_RemoteAddress) ProtoMessage 

func (*RateLimit_Action_RemoteAddress) ProtoMessage()

func (*RateLimit_Action_RemoteAddress) ProtoReflect added in v0.9.6 

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

func (*RateLimit_Action_RemoteAddress) Reset 

func (x *RateLimit_Action_RemoteAddress) Reset()

func (*RateLimit_Action_RemoteAddress) String 

func (x *RateLimit_Action_RemoteAddress) String() string

func (*RateLimit_Action_RemoteAddress) Validate 

func (m *RateLimit_Action_RemoteAddress) Validate() error

Validate checks the field values on RateLimit_Action_RemoteAddress with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type RateLimit_Action_RemoteAddressValidationError 

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

RateLimit_Action_RemoteAddressValidationError is the validation error returned by RateLimit_Action_RemoteAddress.Validate if the designated constraints aren't met.

func (RateLimit_Action_RemoteAddressValidationError) Cause 

func (e RateLimit_Action_RemoteAddressValidationError) Cause() error

Cause function returns cause value.

func (RateLimit_Action_RemoteAddressValidationError) Error 

func (e RateLimit_Action_RemoteAddressValidationError) Error() string

Error satisfies the builtin error interface

func (RateLimit_Action_RemoteAddressValidationError) ErrorName added in v0.7.0 

func (e RateLimit_Action_RemoteAddressValidationError) ErrorName() string

ErrorName returns error name.

func (RateLimit_Action_RemoteAddressValidationError) Field 

func (e RateLimit_Action_RemoteAddressValidationError) Field() string

Field function returns field value.

func (RateLimit_Action_RemoteAddressValidationError) Key 

func (e RateLimit_Action_RemoteAddressValidationError) Key() bool

Key function returns key value.

func (RateLimit_Action_RemoteAddressValidationError) Reason 

func (e RateLimit_Action_RemoteAddressValidationError) Reason() string

Reason function returns reason value.

type RateLimit_Action_RemoteAddress_ 

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

type RateLimit_Action_RequestHeaders 

type RateLimit_Action_RequestHeaders struct {

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

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

.. code-block:: cpp 

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

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

func (x *RateLimit_Action_RequestHeaders) GetDescriptorKey() string

func (*RateLimit_Action_RequestHeaders) GetHeaderName 

func (x *RateLimit_Action_RequestHeaders) GetHeaderName() string

func (*RateLimit_Action_RequestHeaders) ProtoMessage 

func (*RateLimit_Action_RequestHeaders) ProtoMessage()

func (*RateLimit_Action_RequestHeaders) ProtoReflect added in v0.9.6 

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

func (*RateLimit_Action_RequestHeaders) Reset 

func (x *RateLimit_Action_RequestHeaders) Reset()

func (*RateLimit_Action_RequestHeaders) String 

func (x *RateLimit_Action_RequestHeaders) String() string

func (*RateLimit_Action_RequestHeaders) Validate 

func (m *RateLimit_Action_RequestHeaders) Validate() error

Validate checks the field values on RateLimit_Action_RequestHeaders with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type RateLimit_Action_RequestHeadersValidationError 

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

RateLimit_Action_RequestHeadersValidationError is the validation error returned by RateLimit_Action_RequestHeaders.Validate if the designated constraints aren't met.

func (RateLimit_Action_RequestHeadersValidationError) Cause 

func (e RateLimit_Action_RequestHeadersValidationError) Cause() error

Cause function returns cause value.

func (RateLimit_Action_RequestHeadersValidationError) Error 

func (e RateLimit_Action_RequestHeadersValidationError) Error() string

Error satisfies the builtin error interface

func (RateLimit_Action_RequestHeadersValidationError) ErrorName added in v0.7.0 

func (e RateLimit_Action_RequestHeadersValidationError) ErrorName() string

ErrorName returns error name.

func (RateLimit_Action_RequestHeadersValidationError) Field 

func (e RateLimit_Action_RequestHeadersValidationError) Field() string

Field function returns field value.

func (RateLimit_Action_RequestHeadersValidationError) Key 

func (e RateLimit_Action_RequestHeadersValidationError) Key() bool

Key function returns key value.

func (RateLimit_Action_RequestHeadersValidationError) Reason 

func (e RateLimit_Action_RequestHeadersValidationError) Reason() string

Reason function returns reason value.

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) Descriptor deprecated 

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

Deprecated: Use RateLimit_Action_SourceCluster.ProtoReflect.Descriptor instead.

func (*RateLimit_Action_SourceCluster) ProtoMessage 

func (*RateLimit_Action_SourceCluster) ProtoMessage()

func (*RateLimit_Action_SourceCluster) ProtoReflect added in v0.9.6 

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

func (*RateLimit_Action_SourceCluster) Reset 

func (x *RateLimit_Action_SourceCluster) Reset()

func (*RateLimit_Action_SourceCluster) String 

func (x *RateLimit_Action_SourceCluster) String() string

func (*RateLimit_Action_SourceCluster) Validate 

func (m *RateLimit_Action_SourceCluster) Validate() error

Validate checks the field values on RateLimit_Action_SourceCluster with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type RateLimit_Action_SourceClusterValidationError 

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

RateLimit_Action_SourceClusterValidationError is the validation error returned by RateLimit_Action_SourceCluster.Validate if the designated constraints aren't met.

func (RateLimit_Action_SourceClusterValidationError) Cause 

func (e RateLimit_Action_SourceClusterValidationError) Cause() error

Cause function returns cause value.

func (RateLimit_Action_SourceClusterValidationError) Error 

func (e RateLimit_Action_SourceClusterValidationError) Error() string

Error satisfies the builtin error interface

func (RateLimit_Action_SourceClusterValidationError) ErrorName added in v0.7.0 

func (e RateLimit_Action_SourceClusterValidationError) ErrorName() string

ErrorName returns error name.

func (RateLimit_Action_SourceClusterValidationError) Field 

func (e RateLimit_Action_SourceClusterValidationError) Field() string

Field function returns field value.

func (RateLimit_Action_SourceClusterValidationError) Key 

func (e RateLimit_Action_SourceClusterValidationError) Key() bool

Key function returns key value.

func (RateLimit_Action_SourceClusterValidationError) Reason 

func (e RateLimit_Action_SourceClusterValidationError) Reason() string

Reason function returns reason value.

type RateLimit_Action_SourceCluster_ 

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

type RedirectAction 

type RedirectAction struct {

	// When the scheme redirection take place, the following rules apply:
	//  1. If the source URI scheme is `http` and the port is explicitly
	//     set to `:80`, the port will be removed after the redirection
	//  2. If the source URI scheme is `https` and the port is explicitly
	//     set to `:443`, the port will be removed after the redirection
	//
	// Types that are assignable to SchemeRewriteSpecifier:
	//	*RedirectAction_HttpsRedirect
	//	*RedirectAction_SchemeRedirect
	SchemeRewriteSpecifier isRedirectAction_SchemeRewriteSpecifier `protobuf_oneof:"scheme_rewrite_specifier"`
	// The host portion of the URL will be swapped with this value.
	HostRedirect string `protobuf:"bytes,1,opt,name=host_redirect,json=hostRedirect,proto3" json:"host_redirect,omitempty"`
	// The port value of the URL will be swapped with this value.
	PortRedirect uint32 `protobuf:"varint,8,opt,name=port_redirect,json=portRedirect,proto3" json:"port_redirect,omitempty"`
	// Types that are assignable to PathRewriteSpecifier:
	//	*RedirectAction_PathRedirect
	//	*RedirectAction_PrefixRewrite
	PathRewriteSpecifier isRedirectAction_PathRewriteSpecifier `protobuf_oneof:"path_rewrite_specifier"`
	// The HTTP status code to use in the redirect response. The default response
	// code is MOVED_PERMANENTLY (301).
	ResponseCode RedirectAction_RedirectResponseCode `` /* 158-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) Descriptor deprecated 

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

Deprecated: Use RedirectAction.ProtoReflect.Descriptor instead.

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

func (x *RedirectAction) GetPortRedirect() uint32

func (*RedirectAction) GetPrefixRewrite 

func (x *RedirectAction) GetPrefixRewrite() string

func (*RedirectAction) GetResponseCode 

func (x *RedirectAction) GetResponseCode() RedirectAction_RedirectResponseCode

func (*RedirectAction) GetSchemeRedirect added in v0.6.2 

func (x *RedirectAction) GetSchemeRedirect() string

func (*RedirectAction) GetSchemeRewriteSpecifier added in v0.6.2 

func (m *RedirectAction) GetSchemeRewriteSpecifier() isRedirectAction_SchemeRewriteSpecifier

func (*RedirectAction) GetStripQuery 

func (x *RedirectAction) GetStripQuery() bool

func (*RedirectAction) ProtoMessage 

func (*RedirectAction) ProtoMessage()

func (*RedirectAction) ProtoReflect added in v0.9.6 

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

func (*RedirectAction) Reset 

func (x *RedirectAction) Reset()

func (*RedirectAction) String 

func (x *RedirectAction) String() string

func (*RedirectAction) Validate 

func (m *RedirectAction) Validate() error

Validate checks the field values on RedirectAction with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type RedirectActionValidationError 

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

RedirectActionValidationError is the validation error returned by RedirectAction.Validate if the designated constraints aren't met.

func (RedirectActionValidationError) Cause 

func (e RedirectActionValidationError) Cause() error

Cause function returns cause value.

func (RedirectActionValidationError) Error 

func (e RedirectActionValidationError) Error() string

Error satisfies the builtin error interface

func (RedirectActionValidationError) ErrorName added in v0.7.0 

func (e RedirectActionValidationError) ErrorName() string

ErrorName returns error name.

func (RedirectActionValidationError) Field 

func (e RedirectActionValidationError) Field() string

Field function returns field value.

func (RedirectActionValidationError) Key 

func (e RedirectActionValidationError) Key() bool

Key function returns key value.

func (RedirectActionValidationError) Reason 

func (e RedirectActionValidationError) Reason() string

Reason function returns reason value.

type RedirectAction_HttpsRedirect added in v0.6.2 

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_route.RouteAction.prefix_rewrite>`.
	PrefixRewrite string `protobuf:"bytes,5,opt,name=prefix_rewrite,json=prefixRewrite,proto3,oneof"`
}

type RedirectAction_RedirectResponseCode 

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

func (RedirectAction_RedirectResponseCode) Descriptor added in v0.9.6 

func (RedirectAction_RedirectResponseCode) Descriptor() protoreflect.EnumDescriptor

func (RedirectAction_RedirectResponseCode) Enum added in v0.9.6 

func (x RedirectAction_RedirectResponseCode) Enum() *RedirectAction_RedirectResponseCode

func (RedirectAction_RedirectResponseCode) EnumDescriptor deprecated 

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

Deprecated: Use RedirectAction_RedirectResponseCode.Descriptor instead.

func (RedirectAction_RedirectResponseCode) Number added in v0.9.6 

func (x RedirectAction_RedirectResponseCode) Number() protoreflect.EnumNumber

func (RedirectAction_RedirectResponseCode) String 

func (x RedirectAction_RedirectResponseCode) String() string

func (RedirectAction_RedirectResponseCode) Type added in v0.9.6 

func (RedirectAction_RedirectResponseCode) Type() protoreflect.EnumType

type RedirectAction_SchemeRedirect added in v0.6.2 

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

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_route.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) Descriptor deprecated added in v0.6.7 

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

Deprecated: Use RetryPolicy.ProtoReflect.Descriptor instead.

func (*RetryPolicy) GetHostSelectionRetryMaxAttempts added in v0.6.7 

func (x *RetryPolicy) GetHostSelectionRetryMaxAttempts() int64

func (*RetryPolicy) GetNumRetries added in v0.6.7 

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

func (*RetryPolicy) GetPerTryTimeout added in v0.6.7 

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

func (*RetryPolicy) GetRetriableHeaders added in v0.9.1 

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

func (*RetryPolicy) GetRetriableRequestHeaders added in v0.9.1 

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

func (*RetryPolicy) GetRetriableStatusCodes added in v0.6.7 

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

func (*RetryPolicy) GetRetryBackOff added in v0.7.1 

func (x *RetryPolicy) GetRetryBackOff() *RetryPolicy_RetryBackOff

func (*RetryPolicy) GetRetryHostPredicate added in v0.6.7 

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

func (*RetryPolicy) GetRetryOn added in v0.6.7 

func (x *RetryPolicy) GetRetryOn() string

func (*RetryPolicy) GetRetryPriority added in v0.6.7 

func (x *RetryPolicy) GetRetryPriority() *RetryPolicy_RetryPriority

func (*RetryPolicy) ProtoMessage added in v0.6.7 

func (*RetryPolicy) ProtoMessage()

func (*RetryPolicy) ProtoReflect added in v0.9.6 

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

func (*RetryPolicy) Reset added in v0.6.7 

func (x *RetryPolicy) Reset()

func (*RetryPolicy) String added in v0.6.7 

func (x *RetryPolicy) String() string

func (*RetryPolicy) Validate added in v0.6.7 

func (m *RetryPolicy) Validate() error

Validate checks the field values on RetryPolicy with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type RetryPolicyValidationError added in v0.6.7 

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

RetryPolicyValidationError is the validation error returned by RetryPolicy.Validate if the designated constraints aren't met.

func (RetryPolicyValidationError) Cause added in v0.6.7 

func (e RetryPolicyValidationError) Cause() error

Cause function returns cause value.

func (RetryPolicyValidationError) Error added in v0.6.7 

func (e RetryPolicyValidationError) Error() string

Error satisfies the builtin error interface

func (RetryPolicyValidationError) ErrorName added in v0.7.0 

func (e RetryPolicyValidationError) ErrorName() string

ErrorName returns error name.

func (RetryPolicyValidationError) Field added in v0.6.7 

func (e RetryPolicyValidationError) Field() string

Field function returns field value.

func (RetryPolicyValidationError) Key added in v0.6.7 

func (e RetryPolicyValidationError) Key() bool

Key function returns key value.

func (RetryPolicyValidationError) Reason added in v0.6.7 

func (e RetryPolicyValidationError) Reason() string

Reason function returns reason value.

type RetryPolicy_RetryBackOff added in v0.7.1 

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) Descriptor deprecated added in v0.7.1 

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

Deprecated: Use RetryPolicy_RetryBackOff.ProtoReflect.Descriptor instead.

func (*RetryPolicy_RetryBackOff) GetBaseInterval added in v0.7.1 

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

func (*RetryPolicy_RetryBackOff) GetMaxInterval added in v0.7.1 

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

func (*RetryPolicy_RetryBackOff) ProtoMessage added in v0.7.1 

func (*RetryPolicy_RetryBackOff) ProtoMessage()

func (*RetryPolicy_RetryBackOff) ProtoReflect added in v0.9.6 

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

func (*RetryPolicy_RetryBackOff) Reset added in v0.7.1 

func (x *RetryPolicy_RetryBackOff) Reset()

func (*RetryPolicy_RetryBackOff) String added in v0.7.1 

func (x *RetryPolicy_RetryBackOff) String() string

func (*RetryPolicy_RetryBackOff) Validate added in v0.7.1 

func (m *RetryPolicy_RetryBackOff) Validate() error

Validate checks the field values on RetryPolicy_RetryBackOff with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type RetryPolicy_RetryBackOffValidationError added in v0.7.1 

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

RetryPolicy_RetryBackOffValidationError is the validation error returned by RetryPolicy_RetryBackOff.Validate if the designated constraints aren't met.

func (RetryPolicy_RetryBackOffValidationError) Cause added in v0.7.1 

func (e RetryPolicy_RetryBackOffValidationError) Cause() error

Cause function returns cause value.

func (RetryPolicy_RetryBackOffValidationError) Error added in v0.7.1 

func (e RetryPolicy_RetryBackOffValidationError) Error() string

Error satisfies the builtin error interface

func (RetryPolicy_RetryBackOffValidationError) ErrorName added in v0.7.1 

func (e RetryPolicy_RetryBackOffValidationError) ErrorName() string

ErrorName returns error name.

func (RetryPolicy_RetryBackOffValidationError) Field added in v0.7.1 

func (e RetryPolicy_RetryBackOffValidationError) Field() string

Field function returns field value.

func (RetryPolicy_RetryBackOffValidationError) Key added in v0.7.1 

func (e RetryPolicy_RetryBackOffValidationError) Key() bool

Key function returns key value.

func (RetryPolicy_RetryBackOffValidationError) Reason added in v0.7.1 

func (e RetryPolicy_RetryBackOffValidationError) Reason() string

Reason function returns reason value.

type RetryPolicy_RetryHostPredicate added in v0.6.7 

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

func (*RetryPolicy_RetryHostPredicate) Descriptor deprecated added in v0.6.7 

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

Deprecated: Use RetryPolicy_RetryHostPredicate.ProtoReflect.Descriptor instead.

func (*RetryPolicy_RetryHostPredicate) GetConfig deprecated added in v0.6.7 

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

Deprecated: Do not use.

func (*RetryPolicy_RetryHostPredicate) GetConfigType added in v0.6.7 

func (m *RetryPolicy_RetryHostPredicate) GetConfigType() isRetryPolicy_RetryHostPredicate_ConfigType

func (*RetryPolicy_RetryHostPredicate) GetName added in v0.6.7 

func (x *RetryPolicy_RetryHostPredicate) GetName() string

func (*RetryPolicy_RetryHostPredicate) GetTypedConfig added in v0.6.7 

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

func (*RetryPolicy_RetryHostPredicate) ProtoMessage added in v0.6.7 

func (*RetryPolicy_RetryHostPredicate) ProtoMessage()

func (*RetryPolicy_RetryHostPredicate) ProtoReflect added in v0.9.6 

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

func (*RetryPolicy_RetryHostPredicate) Reset added in v0.6.7 

func (x *RetryPolicy_RetryHostPredicate) Reset()

func (*RetryPolicy_RetryHostPredicate) String added in v0.6.7 

func (x *RetryPolicy_RetryHostPredicate) String() string

func (*RetryPolicy_RetryHostPredicate) Validate added in v0.6.7 

func (m *RetryPolicy_RetryHostPredicate) Validate() error

Validate checks the field values on RetryPolicy_RetryHostPredicate with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type RetryPolicy_RetryHostPredicateValidationError added in v0.6.7 

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

RetryPolicy_RetryHostPredicateValidationError is the validation error returned by RetryPolicy_RetryHostPredicate.Validate if the designated constraints aren't met.

func (RetryPolicy_RetryHostPredicateValidationError) Cause added in v0.6.7 

func (e RetryPolicy_RetryHostPredicateValidationError) Cause() error

Cause function returns cause value.

func (RetryPolicy_RetryHostPredicateValidationError) Error added in v0.6.7 

func (e RetryPolicy_RetryHostPredicateValidationError) Error() string

Error satisfies the builtin error interface

func (RetryPolicy_RetryHostPredicateValidationError) ErrorName added in v0.7.0 

func (e RetryPolicy_RetryHostPredicateValidationError) ErrorName() string

ErrorName returns error name.

func (RetryPolicy_RetryHostPredicateValidationError) Field added in v0.6.7 

func (e RetryPolicy_RetryHostPredicateValidationError) Field() string

Field function returns field value.

func (RetryPolicy_RetryHostPredicateValidationError) Key added in v0.6.7 

func (e RetryPolicy_RetryHostPredicateValidationError) Key() bool

Key function returns key value.

func (RetryPolicy_RetryHostPredicateValidationError) Reason added in v0.6.7 

func (e RetryPolicy_RetryHostPredicateValidationError) Reason() string

Reason function returns reason value.

type RetryPolicy_RetryHostPredicate_Config added in v0.6.7 

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

type RetryPolicy_RetryHostPredicate_TypedConfig added in v0.6.7 

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

type RetryPolicy_RetryPriority added in v0.6.7 

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

func (*RetryPolicy_RetryPriority) Descriptor deprecated added in v0.6.7 

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

Deprecated: Use RetryPolicy_RetryPriority.ProtoReflect.Descriptor instead.

func (*RetryPolicy_RetryPriority) GetConfig deprecated added in v0.6.7 

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

Deprecated: Do not use.

func (*RetryPolicy_RetryPriority) GetConfigType added in v0.6.7 

func (m *RetryPolicy_RetryPriority) GetConfigType() isRetryPolicy_RetryPriority_ConfigType

func (*RetryPolicy_RetryPriority) GetName added in v0.6.7 

func (x *RetryPolicy_RetryPriority) GetName() string

func (*RetryPolicy_RetryPriority) GetTypedConfig added in v0.6.7 

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

func (*RetryPolicy_RetryPriority) ProtoMessage added in v0.6.7 

func (*RetryPolicy_RetryPriority) ProtoMessage()

func (*RetryPolicy_RetryPriority) ProtoReflect added in v0.9.6 

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

func (*RetryPolicy_RetryPriority) Reset added in v0.6.7 

func (x *RetryPolicy_RetryPriority) Reset()

func (*RetryPolicy_RetryPriority) String added in v0.6.7 

func (x *RetryPolicy_RetryPriority) String() string

func (*RetryPolicy_RetryPriority) Validate added in v0.6.7 

func (m *RetryPolicy_RetryPriority) Validate() error

Validate checks the field values on RetryPolicy_RetryPriority with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type RetryPolicy_RetryPriorityValidationError added in v0.6.7 

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

RetryPolicy_RetryPriorityValidationError is the validation error returned by RetryPolicy_RetryPriority.Validate if the designated constraints aren't met.

func (RetryPolicy_RetryPriorityValidationError) Cause added in v0.6.7 

func (e RetryPolicy_RetryPriorityValidationError) Cause() error

Cause function returns cause value.

func (RetryPolicy_RetryPriorityValidationError) Error added in v0.6.7 

func (e RetryPolicy_RetryPriorityValidationError) Error() string

Error satisfies the builtin error interface

func (RetryPolicy_RetryPriorityValidationError) ErrorName added in v0.7.0 

func (e RetryPolicy_RetryPriorityValidationError) ErrorName() string

ErrorName returns error name.

func (RetryPolicy_RetryPriorityValidationError) Field added in v0.6.7 

func (e RetryPolicy_RetryPriorityValidationError) Field() string

Field function returns field value.

func (RetryPolicy_RetryPriorityValidationError) Key added in v0.6.7 

func (e RetryPolicy_RetryPriorityValidationError) Key() bool

Key function returns key value.

func (RetryPolicy_RetryPriorityValidationError) Reason added in v0.6.7 

func (e RetryPolicy_RetryPriorityValidationError) Reason() string

Reason function returns reason value.

type RetryPolicy_RetryPriority_Config added in v0.6.7 

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

type RetryPolicy_RetryPriority_TypedConfig added in v0.6.7 

type RetryPolicy_RetryPriority_TypedConfig struct {
	TypedConfig *any.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 *core.Metadata `protobuf:"bytes,4,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Decorator for the matched route.
	Decorator *Decorator `protobuf:"bytes,5,opt,name=decorator,proto3" json:"decorator,omitempty"`
	// The per_filter_config field can be used to provide route-specific
	// configurations for filters. The key should match the filter name, such as
	// *envoy.filters.http.buffer* for the HTTP buffer filter. Use of this field is filter
	// specific; see the :ref:`HTTP filter documentation <config_http_filters>` for
	// if and how it is utilized.
	//
	// Deprecated: Do not use.
	PerFilterConfig map[string]*_struct.Struct `` /* 196-byte string literal not displayed */
	// 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]*any.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_route.VirtualHost` and
	// :ref:`envoy_api_msg_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 []*core.HeaderValueOption `protobuf:"bytes,9,rep,name=request_headers_to_add,json=requestHeadersToAdd,proto3" json:"request_headers_to_add,omitempty"`
	// Specifies a list of HTTP headers that should be removed from each request
	// matching this route.
	RequestHeadersToRemove []string `` /* 132-byte string literal not displayed */
	// Specifies a set of headers that will be added to responses to requests
	// matching this route. Headers specified at this level are applied before
	// headers from the enclosing :ref:`envoy_api_msg_route.VirtualHost` and
	// :ref:`envoy_api_msg_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 []*core.HeaderValueOption `` /* 126-byte string literal not displayed */
	// Specifies a list of HTTP headers that should be removed from each response
	// to requests matching this route.
	ResponseHeadersToRemove []string `` /* 135-byte string literal not displayed */
	// Presence of the object defines whether the connection manager's tracing configuration
	// is overridden by this route specific instance.
	Tracing *Tracing `protobuf:"bytes,15,opt,name=tracing,proto3" json:"tracing,omitempty"`
	// 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_route.HeaderMatcher>`.

[#next-free-field: 18]

func (*Route) Descriptor deprecated 

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

Deprecated: Use Route.ProtoReflect.Descriptor instead.

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

func (x *Route) GetFilterAction() *FilterAction

func (*Route) GetMatch 

func (x *Route) GetMatch() *RouteMatch

func (*Route) GetMetadata 

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

func (*Route) GetName added in v0.8.1 

func (x *Route) GetName() string

func (*Route) GetPerFilterConfig deprecated 

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

Deprecated: Do not use.

func (*Route) GetPerRequestBufferLimitBytes added in v0.9.1 

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

func (*Route) GetRedirect 

func (x *Route) GetRedirect() *RedirectAction

func (*Route) GetRequestHeadersToAdd 

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

func (*Route) GetRequestHeadersToRemove added in v0.6.0 

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

func (*Route) GetResponseHeadersToAdd 

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

func (*Route) GetResponseHeadersToRemove 

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

func (*Route) GetRoute 

func (x *Route) GetRoute() *RouteAction

func (*Route) GetTracing added in v0.8.1 

func (x *Route) GetTracing() *Tracing

func (*Route) GetTypedPerFilterConfig added in v0.6.3 

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

func (*Route) ProtoMessage 

func (*Route) ProtoMessage()

func (*Route) ProtoReflect added in v0.9.6 

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

func (*Route) Reset 

func (x *Route) Reset()

func (*Route) String 

func (x *Route) String() string

func (*Route) Validate 

func (m *Route) Validate() error

Validate checks the field values on Route with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

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 `` /* 214-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_route.RouteAction.weighted_clusters>`, metadata will be merged, with values
	// provided there taking precedence. The filter name should be specified as *envoy.lb*.
	MetadataMatch *core.Metadata `protobuf:"bytes,4,opt,name=metadata_match,json=metadataMatch,proto3" json:"metadata_match,omitempty"`
	// Indicates that during forwarding, the matched prefix (or path) should be
	// swapped with this value. This option allows application URLs to be rooted
	// at a different path from those exposed at the reverse proxy layer. The router filter will
	// place the original path before rewrite into the :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_route.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_route.Route.match>` prefix value.
	//   Stripping a prefix from a path requires multiple Routes to handle all cases. For example,
	//   rewriting */prefix* to */* and */prefix/etc* to */etc* cannot be done in a single
	//   :ref:`Route <envoy_api_msg_route.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_route.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 *matcher.RegexMatchAndSubstitute `protobuf:"bytes,32,opt,name=regex_rewrite,json=regexRewrite,proto3" json:"regex_rewrite,omitempty"`
	// Types that are assignable to HostRewriteSpecifier:
	//	*RouteAction_HostRewrite
	//	*RouteAction_AutoHostRewrite
	//	*RouteAction_AutoHostRewriteHeader
	HostRewriteSpecifier isRouteAction_HostRewriteSpecifier `protobuf_oneof:"host_rewrite_specifier"`
	// Specifies the upstream timeout for the route. If not specified, the default is 15s. This
	// spans between the point at which the entire downstream request (i.e. end-of-stream) has been
	// processed and when the upstream response has been completely processed. 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_config.filter.network.http_connection_manager.v2.HttpConnectionManager.stream_idle_timeout>`
	// will still apply. A value of 0 will completely disable the route's idle timeout, even if a
	// connection manager stream idle timeout is configured.
	//
	// The idle timeout is distinct to :ref:`timeout
	// <envoy_api_field_route.RouteAction.timeout>`, which provides an upper bound
	// on the upstream response time; :ref:`idle_timeout
	// <envoy_api_field_route.RouteAction.idle_timeout>` instead bounds the amount
	// of time the request's stream may be idle.
	//
	// After header decoding, the idle timeout will apply on downstream and
	// upstream request events. Each time an encode/decode event for headers or
	// data is processed for the stream, the timer will be reset. If the timeout
	// fires, the stream is terminated with a 408 Request Timeout error code if no
	// upstream response header has been received, otherwise a stream reset
	// occurs.
	IdleTimeout *duration.Duration `protobuf:"bytes,24,opt,name=idle_timeout,json=idleTimeout,proto3" json:"idle_timeout,omitempty"`
	// Indicates that the route has a retry policy. Note that if this is set,
	// it'll take precedence over the virtual host level retry policy entirely
	// (e.g.: policies are not merged, most internal one becomes the enforced policy).
	RetryPolicy *RetryPolicy `protobuf:"bytes,9,opt,name=retry_policy,json=retryPolicy,proto3" json:"retry_policy,omitempty"`
	// [#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_route.VirtualHost.retry_policy>`
	// should not be set if this field is used.
	RetryPolicyTypedConfig *any.Any `` /* 132-byte string literal not displayed */
	// Indicates that the route has a request mirroring policy.
	//
	// .. attention::
	//   This field has been deprecated in favor of `request_mirror_policies` which supports one or
	//   more mirroring policies.
	//
	// Deprecated: Do not use.
	RequestMirrorPolicy *RouteAction_RequestMirrorPolicy `protobuf:"bytes,10,opt,name=request_mirror_policy,json=requestMirrorPolicy,proto3" json:"request_mirror_policy,omitempty"`
	// 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 core.RoutingPriority `protobuf:"varint,11,opt,name=priority,proto3,enum=envoy.api.v2.core.RoutingPriority" json:"priority,omitempty"`
	// Specifies a set of rate limit configurations that could be applied to the
	// route.
	RateLimits []*RateLimit `protobuf:"bytes,13,rep,name=rate_limits,json=rateLimits,proto3" json:"rate_limits,omitempty"`
	// Specifies if the rate limit filter should include the virtual host rate
	// limits. By default, if the route configured rate limits, the virtual host
	// :ref:`rate_limits <envoy_api_field_route.VirtualHost.rate_limits>` are not applied to the
	// request.
	IncludeVhRateLimits *wrappers.BoolValue `protobuf:"bytes,14,opt,name=include_vh_rate_limits,json=includeVhRateLimits,proto3" json:"include_vh_rate_limits,omitempty"`
	// Specifies a list of hash policies to use for ring hash load balancing. Each
	// hash policy is evaluated individually and the combined result is used to
	// route the request. The method of combination is deterministic such that
	// identical lists of hash policies will produce the same hash. Since a hash
	// policy examines specific parts of a request, it can fail to produce a hash
	// (i.e. if the hashed header is not present). If (and only if) all configured
	// hash policies fail to generate a hash, no hash will be produced for
	// the route. In this case, the behavior is the same as if no hash policies
	// were specified (i.e. the ring hash load balancer will choose a random
	// backend). If a hash policy has the "terminal" attribute set to true, and
	// there is already a hash generated, the hash is returned immediately,
	// ignoring the rest of the hash policy list.
	HashPolicy []*RouteAction_HashPolicy `protobuf:"bytes,15,rep,name=hash_policy,json=hashPolicy,proto3" json:"hash_policy,omitempty"`
	// Indicates that the route has a CORS policy.
	Cors *CorsPolicy `protobuf:"bytes,17,opt,name=cors,proto3" json:"cors,omitempty"`
	// If present, and the request is a gRPC request, use the
	// `grpc-timeout header <https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md>`_,
	// or its default value (infinity) instead of
	// :ref:`timeout <envoy_api_field_route.RouteAction.timeout>`, but limit the applied timeout
	// to the maximum value specified here. If configured as 0, the maximum allowed timeout for
	// gRPC requests is infinity. If not configured at all, the `grpc-timeout` header is not used
	// and gRPC requests time out like any other requests using
	// :ref:`timeout <envoy_api_field_route.RouteAction.timeout>` or its default.
	// This can be used to prevent unexpected upstream request timeouts due to potentially long
	// time gaps between gRPC request and response in gRPC streaming mode.
	//
	// .. 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"`
	InternalRedirectAction RouteAction_InternalRedirectAction `` /* 190-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_route.RouteAction.internal_redirect_action>`
	// is set to :ref:`HANDLE_INTERNAL_REDIRECT
	// <envoy_api_enum_value_route.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_route.RouteAction.internal_redirect_action>`
	// set to
	// :ref:`PASS_THROUGH_INTERNAL_REDIRECT
	// <envoy_api_enum_value_route.RouteAction.InternalRedirectAction.PASS_THROUGH_INTERNAL_REDIRECT>`
	// will pass the redirect back to downstream.
	//
	// If not specified, at most one redirect will be followed.
	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: 34]

func (*RouteAction) Descriptor deprecated 

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

Deprecated: Use RouteAction.ProtoReflect.Descriptor instead.

func (*RouteAction) GetAutoHostRewrite 

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

func (*RouteAction) GetAutoHostRewriteHeader added in v0.8.1 

func (x *RouteAction) GetAutoHostRewriteHeader() string

func (*RouteAction) GetCluster 

func (x *RouteAction) GetCluster() string

func (*RouteAction) GetClusterHeader 

func (x *RouteAction) GetClusterHeader() string

func (*RouteAction) GetClusterNotFoundResponseCode 

func (x *RouteAction) GetClusterNotFoundResponseCode() RouteAction_ClusterNotFoundResponseCode

func (*RouteAction) GetClusterSpecifier 

func (m *RouteAction) GetClusterSpecifier() isRouteAction_ClusterSpecifier

func (*RouteAction) GetCors 

func (x *RouteAction) GetCors() *CorsPolicy

func (*RouteAction) GetGrpcTimeoutOffset added in v0.8.0 

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

func (*RouteAction) GetHashPolicy 

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

func (*RouteAction) GetHedgePolicy added in v0.6.8 

func (x *RouteAction) GetHedgePolicy() *HedgePolicy

func (*RouteAction) GetHostRewrite 

func (x *RouteAction) GetHostRewrite() string

func (*RouteAction) GetHostRewriteSpecifier 

func (m *RouteAction) GetHostRewriteSpecifier() isRouteAction_HostRewriteSpecifier

func (*RouteAction) GetIdleTimeout 

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

func (*RouteAction) GetIncludeVhRateLimits 

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

func (*RouteAction) GetInternalRedirectAction added in v0.6.7 

func (x *RouteAction) GetInternalRedirectAction() RouteAction_InternalRedirectAction

func (*RouteAction) GetMaxGrpcTimeout 

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

func (*RouteAction) GetMaxInternalRedirects added in v0.9.3 

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

func (*RouteAction) GetMetadataMatch 

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

func (*RouteAction) GetPrefixRewrite 

func (x *RouteAction) GetPrefixRewrite() string

func (*RouteAction) GetPriority 

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

func (*RouteAction) GetRateLimits 

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

func (*RouteAction) GetRegexRewrite added in v0.9.5 

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

func (*RouteAction) GetRequestMirrorPolicies added in v0.9.2 

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

func (*RouteAction) GetRequestMirrorPolicy deprecated 

func (x *RouteAction) GetRequestMirrorPolicy() *RouteAction_RequestMirrorPolicy

Deprecated: Do not use.

func (*RouteAction) GetRetryPolicy 

func (x *RouteAction) GetRetryPolicy() *RetryPolicy

func (*RouteAction) GetRetryPolicyTypedConfig added in v0.9.5 

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

func (*RouteAction) GetTimeout 

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

func (*RouteAction) GetUpgradeConfigs added in v0.6.4 

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

func (*RouteAction) GetWeightedClusters 

func (x *RouteAction) GetWeightedClusters() *WeightedCluster

func (*RouteAction) ProtoMessage 

func (*RouteAction) ProtoMessage()

func (*RouteAction) ProtoReflect added in v0.9.6 

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

func (*RouteAction) Reset 

func (x *RouteAction) Reset()

func (*RouteAction) String 

func (x *RouteAction) String() string

func (*RouteAction) Validate 

func (m *RouteAction) Validate() error

Validate checks the field values on RouteAction with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type RouteActionValidationError 

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

RouteActionValidationError is the validation error returned by RouteAction.Validate if the designated constraints aren't met.

func (RouteActionValidationError) Cause 

func (e RouteActionValidationError) Cause() error

Cause function returns cause value.

func (RouteActionValidationError) Error 

func (e RouteActionValidationError) Error() string

Error satisfies the builtin error interface

func (RouteActionValidationError) ErrorName added in v0.7.0 

func (e RouteActionValidationError) ErrorName() string

ErrorName returns error name.

func (RouteActionValidationError) Field 

func (e RouteActionValidationError) Field() string

Field function returns field value.

func (RouteActionValidationError) Key 

func (e RouteActionValidationError) Key() bool

Key function returns key value.

func (RouteActionValidationError) Reason 

func (e RouteActionValidationError) Reason() string

Reason function returns reason value.

type RouteAction_AutoHostRewrite 

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

type RouteAction_AutoHostRewriteHeader added in v0.8.1 

type RouteAction_AutoHostRewriteHeader 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.
	//
	// .. note::
	//
	//   If the header appears multiple times only the first value is used.
	AutoHostRewriteHeader string `protobuf:"bytes,29,opt,name=auto_host_rewrite_header,json=autoHostRewriteHeader,proto3,oneof"`
}

type RouteAction_Cluster 

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

type RouteAction_ClusterHeader 

type RouteAction_ClusterHeader struct {
	// Envoy will determine the cluster to route to by reading the value of the
	// HTTP header named by cluster_header from the request headers. If the
	// header is not found or the referenced cluster does not exist, Envoy will
	// return a 404 response.
	//
	// .. 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.
	//
	// .. note::
	//
	//   If the header appears multiple times only the first value is used.
	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 v0.9.6 

func (RouteAction_ClusterNotFoundResponseCode) Descriptor() protoreflect.EnumDescriptor

func (RouteAction_ClusterNotFoundResponseCode) Enum added in v0.9.6 

func (x RouteAction_ClusterNotFoundResponseCode) Enum() *RouteAction_ClusterNotFoundResponseCode

func (RouteAction_ClusterNotFoundResponseCode) EnumDescriptor deprecated 

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

Deprecated: Use RouteAction_ClusterNotFoundResponseCode.Descriptor instead.

func (RouteAction_ClusterNotFoundResponseCode) Number added in v0.9.6 

func (x RouteAction_ClusterNotFoundResponseCode) Number() protoreflect.EnumNumber

func (RouteAction_ClusterNotFoundResponseCode) String 

func (x RouteAction_ClusterNotFoundResponseCode) String() string

func (RouteAction_ClusterNotFoundResponseCode) Type added in v0.9.6 

func (RouteAction_ClusterNotFoundResponseCode) Type() protoreflect.EnumType

type RouteAction_HashPolicy 

type RouteAction_HashPolicy struct {

	// Types that are assignable to PolicySpecifier:
	//	*RouteAction_HashPolicy_Header_
	//	*RouteAction_HashPolicy_Cookie_
	//	*RouteAction_HashPolicy_ConnectionProperties_
	//	*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) Descriptor deprecated 

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

Deprecated: Use RouteAction_HashPolicy.ProtoReflect.Descriptor instead.

func (*RouteAction_HashPolicy) GetConnectionProperties 

func (x *RouteAction_HashPolicy) GetConnectionProperties() *RouteAction_HashPolicy_ConnectionProperties

func (*RouteAction_HashPolicy) GetCookie 

func (x *RouteAction_HashPolicy) GetCookie() *RouteAction_HashPolicy_Cookie

func (*RouteAction_HashPolicy) GetFilterState added in v0.9.5 

func (x *RouteAction_HashPolicy) GetFilterState() *RouteAction_HashPolicy_FilterState

func (*RouteAction_HashPolicy) GetHeader 

func (x *RouteAction_HashPolicy) GetHeader() *RouteAction_HashPolicy_Header

func (*RouteAction_HashPolicy) GetPolicySpecifier 

func (m *RouteAction_HashPolicy) GetPolicySpecifier() isRouteAction_HashPolicy_PolicySpecifier

func (*RouteAction_HashPolicy) GetQueryParameter added in v0.9.2 

func (x *RouteAction_HashPolicy) GetQueryParameter() *RouteAction_HashPolicy_QueryParameter

func (*RouteAction_HashPolicy) GetTerminal added in v0.6.0 

func (x *RouteAction_HashPolicy) GetTerminal() bool

func (*RouteAction_HashPolicy) ProtoMessage 

func (*RouteAction_HashPolicy) ProtoMessage()

func (*RouteAction_HashPolicy) ProtoReflect added in v0.9.6 

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

func (*RouteAction_HashPolicy) Validate 

func (m *RouteAction_HashPolicy) Validate() error

Validate checks the field values on RouteAction_HashPolicy with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type RouteAction_HashPolicyValidationError 

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

RouteAction_HashPolicyValidationError is the validation error returned by RouteAction_HashPolicy.Validate if the designated constraints aren't met.

func (RouteAction_HashPolicyValidationError) Cause 

func (e RouteAction_HashPolicyValidationError) Cause() error

Cause function returns cause value.

func (RouteAction_HashPolicyValidationError) Error 

func (e RouteAction_HashPolicyValidationError) Error() string

Error satisfies the builtin error interface

func (RouteAction_HashPolicyValidationError) ErrorName added in v0.7.0 

func (e RouteAction_HashPolicyValidationError) ErrorName() string

ErrorName returns error name.

func (RouteAction_HashPolicyValidationError) Field 

func (e RouteAction_HashPolicyValidationError) Field() string

Field function returns field value.

func (RouteAction_HashPolicyValidationError) Key 

func (e RouteAction_HashPolicyValidationError) Key() bool

Key function returns key value.

func (RouteAction_HashPolicyValidationError) Reason 

func (e RouteAction_HashPolicyValidationError) Reason() string

Reason function returns reason value.

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) Descriptor deprecated 

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

Deprecated: Use RouteAction_HashPolicy_ConnectionProperties.ProtoReflect.Descriptor instead.

func (*RouteAction_HashPolicy_ConnectionProperties) GetSourceIp 

func (x *RouteAction_HashPolicy_ConnectionProperties) GetSourceIp() bool

func (*RouteAction_HashPolicy_ConnectionProperties) ProtoMessage 

func (*RouteAction_HashPolicy_ConnectionProperties) ProtoMessage()

func (*RouteAction_HashPolicy_ConnectionProperties) ProtoReflect added in v0.9.6 

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

func (*RouteAction_HashPolicy_ConnectionProperties) Reset 

func (x *RouteAction_HashPolicy_ConnectionProperties) Reset()

func (*RouteAction_HashPolicy_ConnectionProperties) String 

func (x *RouteAction_HashPolicy_ConnectionProperties) String() string

func (*RouteAction_HashPolicy_ConnectionProperties) Validate 

func (m *RouteAction_HashPolicy_ConnectionProperties) Validate() error

Validate checks the field values on RouteAction_HashPolicy_ConnectionProperties with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type RouteAction_HashPolicy_ConnectionPropertiesValidationError 

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

RouteAction_HashPolicy_ConnectionPropertiesValidationError is the validation error returned by RouteAction_HashPolicy_ConnectionProperties.Validate if the designated constraints aren't met.

func (RouteAction_HashPolicy_ConnectionPropertiesValidationError) Cause 

func (e RouteAction_HashPolicy_ConnectionPropertiesValidationError) Cause() error

Cause function returns cause value.

func (RouteAction_HashPolicy_ConnectionPropertiesValidationError) Error 

func (e RouteAction_HashPolicy_ConnectionPropertiesValidationError) Error() string

Error satisfies the builtin error interface

func (RouteAction_HashPolicy_ConnectionPropertiesValidationError) ErrorName added in v0.7.0 

func (e RouteAction_HashPolicy_ConnectionPropertiesValidationError) ErrorName() string

ErrorName returns error name.

func (RouteAction_HashPolicy_ConnectionPropertiesValidationError) Field 

func (e RouteAction_HashPolicy_ConnectionPropertiesValidationError) Field() string

Field function returns field value.

func (RouteAction_HashPolicy_ConnectionPropertiesValidationError) Key 

func (e RouteAction_HashPolicy_ConnectionPropertiesValidationError) Key() bool

Key function returns key value.

func (RouteAction_HashPolicy_ConnectionPropertiesValidationError) Reason 

func (e RouteAction_HashPolicy_ConnectionPropertiesValidationError) Reason() string

Reason function returns reason value.

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) Descriptor deprecated 

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

Deprecated: Use RouteAction_HashPolicy_Cookie.ProtoReflect.Descriptor instead.

func (*RouteAction_HashPolicy_Cookie) GetName 

func (x *RouteAction_HashPolicy_Cookie) GetName() string

func (*RouteAction_HashPolicy_Cookie) GetPath 

func (x *RouteAction_HashPolicy_Cookie) GetPath() string

func (*RouteAction_HashPolicy_Cookie) GetTtl 

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

func (*RouteAction_HashPolicy_Cookie) ProtoMessage 

func (*RouteAction_HashPolicy_Cookie) ProtoMessage()

func (*RouteAction_HashPolicy_Cookie) ProtoReflect added in v0.9.6 

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

func (*RouteAction_HashPolicy_Cookie) Reset 

func (x *RouteAction_HashPolicy_Cookie) Reset()

func (*RouteAction_HashPolicy_Cookie) String 

func (x *RouteAction_HashPolicy_Cookie) String() string

func (*RouteAction_HashPolicy_Cookie) Validate 

func (m *RouteAction_HashPolicy_Cookie) Validate() error

Validate checks the field values on RouteAction_HashPolicy_Cookie with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type RouteAction_HashPolicy_CookieValidationError 

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

RouteAction_HashPolicy_CookieValidationError is the validation error returned by RouteAction_HashPolicy_Cookie.Validate if the designated constraints aren't met.

func (RouteAction_HashPolicy_CookieValidationError) Cause 

func (e RouteAction_HashPolicy_CookieValidationError) Cause() error

Cause function returns cause value.

func (RouteAction_HashPolicy_CookieValidationError) Error 

func (e RouteAction_HashPolicy_CookieValidationError) Error() string

Error satisfies the builtin error interface

func (RouteAction_HashPolicy_CookieValidationError) ErrorName added in v0.7.0 

func (e RouteAction_HashPolicy_CookieValidationError) ErrorName() string

ErrorName returns error name.

func (RouteAction_HashPolicy_CookieValidationError) Field 

func (e RouteAction_HashPolicy_CookieValidationError) Field() string

Field function returns field value.

func (RouteAction_HashPolicy_CookieValidationError) Key 

func (e RouteAction_HashPolicy_CookieValidationError) Key() bool

Key function returns key value.

func (RouteAction_HashPolicy_CookieValidationError) Reason 

func (e RouteAction_HashPolicy_CookieValidationError) Reason() string

Reason function returns reason value.

type RouteAction_HashPolicy_Cookie_ 

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

type RouteAction_HashPolicy_FilterState added in v0.9.5 

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) Descriptor deprecated added in v0.9.5 

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

Deprecated: Use RouteAction_HashPolicy_FilterState.ProtoReflect.Descriptor instead.

func (*RouteAction_HashPolicy_FilterState) GetKey added in v0.9.5 

func (x *RouteAction_HashPolicy_FilterState) GetKey() string

func (*RouteAction_HashPolicy_FilterState) ProtoMessage added in v0.9.5 

func (*RouteAction_HashPolicy_FilterState) ProtoMessage()

func (*RouteAction_HashPolicy_FilterState) ProtoReflect added in v0.9.6 

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

func (*RouteAction_HashPolicy_FilterState) Reset added in v0.9.5 

func (x *RouteAction_HashPolicy_FilterState) Reset()

func (*RouteAction_HashPolicy_FilterState) String added in v0.9.5 

func (x *RouteAction_HashPolicy_FilterState) String() string

func (*RouteAction_HashPolicy_FilterState) Validate added in v0.9.5 

func (m *RouteAction_HashPolicy_FilterState) Validate() error

Validate checks the field values on RouteAction_HashPolicy_FilterState with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type RouteAction_HashPolicy_FilterStateValidationError added in v0.9.5 

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

RouteAction_HashPolicy_FilterStateValidationError is the validation error returned by RouteAction_HashPolicy_FilterState.Validate if the designated constraints aren't met.

func (RouteAction_HashPolicy_FilterStateValidationError) Cause added in v0.9.5 

func (e RouteAction_HashPolicy_FilterStateValidationError) Cause() error

Cause function returns cause value.

func (RouteAction_HashPolicy_FilterStateValidationError) Error added in v0.9.5 

func (e RouteAction_HashPolicy_FilterStateValidationError) Error() string

Error satisfies the builtin error interface

func (RouteAction_HashPolicy_FilterStateValidationError) ErrorName added in v0.9.5 

func (e RouteAction_HashPolicy_FilterStateValidationError) ErrorName() string

ErrorName returns error name.

func (RouteAction_HashPolicy_FilterStateValidationError) Field added in v0.9.5 

func (e RouteAction_HashPolicy_FilterStateValidationError) Field() string

Field function returns field value.

func (RouteAction_HashPolicy_FilterStateValidationError) Key added in v0.9.5 

func (e RouteAction_HashPolicy_FilterStateValidationError) Key() bool

Key function returns key value.

func (RouteAction_HashPolicy_FilterStateValidationError) Reason added in v0.9.5 

func (e RouteAction_HashPolicy_FilterStateValidationError) Reason() string

Reason function returns reason value.

type RouteAction_HashPolicy_FilterState_ added in v0.9.5 

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

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

func (x *RouteAction_HashPolicy_Header) GetHeaderName() string

func (*RouteAction_HashPolicy_Header) ProtoMessage 

func (*RouteAction_HashPolicy_Header) ProtoMessage()

func (*RouteAction_HashPolicy_Header) ProtoReflect added in v0.9.6 

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

func (*RouteAction_HashPolicy_Header) Reset 

func (x *RouteAction_HashPolicy_Header) Reset()

func (*RouteAction_HashPolicy_Header) String 

func (x *RouteAction_HashPolicy_Header) String() string

func (*RouteAction_HashPolicy_Header) Validate 

func (m *RouteAction_HashPolicy_Header) Validate() error

Validate checks the field values on RouteAction_HashPolicy_Header with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type RouteAction_HashPolicy_HeaderValidationError 

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

RouteAction_HashPolicy_HeaderValidationError is the validation error returned by RouteAction_HashPolicy_Header.Validate if the designated constraints aren't met.

func (RouteAction_HashPolicy_HeaderValidationError) Cause 

func (e RouteAction_HashPolicy_HeaderValidationError) Cause() error

Cause function returns cause value.

func (RouteAction_HashPolicy_HeaderValidationError) Error 

func (e RouteAction_HashPolicy_HeaderValidationError) Error() string

Error satisfies the builtin error interface

func (RouteAction_HashPolicy_HeaderValidationError) ErrorName added in v0.7.0 

func (e RouteAction_HashPolicy_HeaderValidationError) ErrorName() string

ErrorName returns error name.

func (RouteAction_HashPolicy_HeaderValidationError) Field 

func (e RouteAction_HashPolicy_HeaderValidationError) Field() string

Field function returns field value.

func (RouteAction_HashPolicy_HeaderValidationError) Key 

func (e RouteAction_HashPolicy_HeaderValidationError) Key() bool

Key function returns key value.

func (RouteAction_HashPolicy_HeaderValidationError) Reason 

func (e RouteAction_HashPolicy_HeaderValidationError) Reason() string

Reason function returns reason value.

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

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) Descriptor deprecated added in v0.9.2 

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

Deprecated: Use RouteAction_HashPolicy_QueryParameter.ProtoReflect.Descriptor instead.

func (*RouteAction_HashPolicy_QueryParameter) GetName added in v0.9.2 

func (x *RouteAction_HashPolicy_QueryParameter) GetName() string

func (*RouteAction_HashPolicy_QueryParameter) ProtoMessage added in v0.9.2 

func (*RouteAction_HashPolicy_QueryParameter) ProtoMessage()

func (*RouteAction_HashPolicy_QueryParameter) ProtoReflect added in v0.9.6 

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

func (*RouteAction_HashPolicy_QueryParameter) Reset added in v0.9.2 

func (x *RouteAction_HashPolicy_QueryParameter) Reset()

func (*RouteAction_HashPolicy_QueryParameter) String added in v0.9.2 

func (x *RouteAction_HashPolicy_QueryParameter) String() string

func (*RouteAction_HashPolicy_QueryParameter) Validate added in v0.9.2 

func (m *RouteAction_HashPolicy_QueryParameter) Validate() error

Validate checks the field values on RouteAction_HashPolicy_QueryParameter with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type RouteAction_HashPolicy_QueryParameterValidationError added in v0.9.2 

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

RouteAction_HashPolicy_QueryParameterValidationError is the validation error returned by RouteAction_HashPolicy_QueryParameter.Validate if the designated constraints aren't met.

func (RouteAction_HashPolicy_QueryParameterValidationError) Cause added in v0.9.2 

func (e RouteAction_HashPolicy_QueryParameterValidationError) Cause() error

Cause function returns cause value.

func (RouteAction_HashPolicy_QueryParameterValidationError) Error added in v0.9.2 

func (e RouteAction_HashPolicy_QueryParameterValidationError) Error() string

Error satisfies the builtin error interface

func (RouteAction_HashPolicy_QueryParameterValidationError) ErrorName added in v0.9.2 

func (e RouteAction_HashPolicy_QueryParameterValidationError) ErrorName() string

ErrorName returns error name.

func (RouteAction_HashPolicy_QueryParameterValidationError) Field added in v0.9.2 

func (e RouteAction_HashPolicy_QueryParameterValidationError) Field() string

Field function returns field value.

func (RouteAction_HashPolicy_QueryParameterValidationError) Key added in v0.9.2 

func (e RouteAction_HashPolicy_QueryParameterValidationError) Key() bool

Key function returns key value.

func (RouteAction_HashPolicy_QueryParameterValidationError) Reason added in v0.9.2 

func (e RouteAction_HashPolicy_QueryParameterValidationError) Reason() string

Reason function returns reason value.

type RouteAction_HashPolicy_QueryParameter_ added in v0.9.2 

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_HostRewrite 

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

type RouteAction_InternalRedirectAction added in v0.6.7 

type RouteAction_InternalRedirectAction int32

Configures :ref:`internal redirect <arch_overview_internal_redirects>` behavior. 

const (
	RouteAction_PASS_THROUGH_INTERNAL_REDIRECT RouteAction_InternalRedirectAction = 0
	RouteAction_HANDLE_INTERNAL_REDIRECT       RouteAction_InternalRedirectAction = 1
)

func (RouteAction_InternalRedirectAction) Descriptor added in v0.9.6 

func (RouteAction_InternalRedirectAction) Descriptor() protoreflect.EnumDescriptor

func (RouteAction_InternalRedirectAction) Enum added in v0.9.6 

func (x RouteAction_InternalRedirectAction) Enum() *RouteAction_InternalRedirectAction

func (RouteAction_InternalRedirectAction) EnumDescriptor deprecated added in v0.6.7 

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

Deprecated: Use RouteAction_InternalRedirectAction.Descriptor instead.

func (RouteAction_InternalRedirectAction) Number added in v0.9.6 

func (x RouteAction_InternalRedirectAction) Number() protoreflect.EnumNumber

func (RouteAction_InternalRedirectAction) String added in v0.6.7 

func (x RouteAction_InternalRedirectAction) String() string

func (RouteAction_InternalRedirectAction) Type added in v0.9.6 

func (RouteAction_InternalRedirectAction) Type() protoreflect.EnumType

type RouteAction_RequestMirrorPolicy 

type RouteAction_RequestMirrorPolicy struct {

	// Specifies the cluster that requests will be mirrored to. The cluster must
	// exist in the cluster manager configuration.
	Cluster string `protobuf:"bytes,1,opt,name=cluster,proto3" json:"cluster,omitempty"`
	// If not specified, all requests to the target cluster will be mirrored. If
	// specified, Envoy will lookup the runtime key to get the % of requests to
	// mirror. Valid values are from 0 to 10000, allowing for increments of
	// 0.01% of requests to be mirrored. If the runtime key is specified in the
	// configuration but not present in runtime, 0 is the default and thus 0% of
	// requests will be mirrored.
	//
	// .. attention::
	//
	//   **This field is deprecated**. Set the
	//   :ref:`runtime_fraction
	//   <envoy_api_field_route.RouteAction.RequestMirrorPolicy.runtime_fraction>`
	//   field instead. Mirroring occurs if both this and
	//   <envoy_api_field_route.RouteAction.RequestMirrorPolicy.runtime_fraction>`
	//   are not set.
	//
	// Deprecated: Do not use.
	RuntimeKey string `protobuf:"bytes,2,opt,name=runtime_key,json=runtimeKey,proto3" json:"runtime_key,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 *core.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) Descriptor deprecated 

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

Deprecated: Use RouteAction_RequestMirrorPolicy.ProtoReflect.Descriptor instead.

func (*RouteAction_RequestMirrorPolicy) GetCluster 

func (x *RouteAction_RequestMirrorPolicy) GetCluster() string

func (*RouteAction_RequestMirrorPolicy) GetRuntimeFraction added in v0.6.6 

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

func (*RouteAction_RequestMirrorPolicy) GetRuntimeKey deprecated 

func (x *RouteAction_RequestMirrorPolicy) GetRuntimeKey() string

Deprecated: Do not use.

func (*RouteAction_RequestMirrorPolicy) GetTraceSampled added in v0.9.5 

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

func (*RouteAction_RequestMirrorPolicy) ProtoMessage 

func (*RouteAction_RequestMirrorPolicy) ProtoMessage()

func (*RouteAction_RequestMirrorPolicy) ProtoReflect added in v0.9.6 

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

func (*RouteAction_RequestMirrorPolicy) Reset 

func (x *RouteAction_RequestMirrorPolicy) Reset()

func (*RouteAction_RequestMirrorPolicy) String 

func (x *RouteAction_RequestMirrorPolicy) String() string

func (*RouteAction_RequestMirrorPolicy) Validate 

func (m *RouteAction_RequestMirrorPolicy) Validate() error

Validate checks the field values on RouteAction_RequestMirrorPolicy with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type RouteAction_RequestMirrorPolicyValidationError 

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

RouteAction_RequestMirrorPolicyValidationError is the validation error returned by RouteAction_RequestMirrorPolicy.Validate if the designated constraints aren't met.

func (RouteAction_RequestMirrorPolicyValidationError) Cause 

func (e RouteAction_RequestMirrorPolicyValidationError) Cause() error

Cause function returns cause value.

func (RouteAction_RequestMirrorPolicyValidationError) Error 

func (e RouteAction_RequestMirrorPolicyValidationError) Error() string

Error satisfies the builtin error interface

func (RouteAction_RequestMirrorPolicyValidationError) ErrorName added in v0.7.0 

func (e RouteAction_RequestMirrorPolicyValidationError) ErrorName() string

ErrorName returns error name.

func (RouteAction_RequestMirrorPolicyValidationError) Field 

func (e RouteAction_RequestMirrorPolicyValidationError) Field() string

Field function returns field value.

func (RouteAction_RequestMirrorPolicyValidationError) Key 

func (e RouteAction_RequestMirrorPolicyValidationError) Key() bool

Key function returns key value.

func (RouteAction_RequestMirrorPolicyValidationError) Reason 

func (e RouteAction_RequestMirrorPolicyValidationError) Reason() string

Reason function returns reason value.

type RouteAction_UpgradeConfig added in v0.6.4 

type RouteAction_UpgradeConfig struct {

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

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

func (*RouteAction_UpgradeConfig) Descriptor deprecated added in v0.6.4 

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

Deprecated: Use RouteAction_UpgradeConfig.ProtoReflect.Descriptor instead.

func (*RouteAction_UpgradeConfig) GetEnabled added in v0.6.4 

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

func (*RouteAction_UpgradeConfig) GetUpgradeType added in v0.6.4 

func (x *RouteAction_UpgradeConfig) GetUpgradeType() string

func (*RouteAction_UpgradeConfig) ProtoMessage added in v0.6.4 

func (*RouteAction_UpgradeConfig) ProtoMessage()

func (*RouteAction_UpgradeConfig) ProtoReflect added in v0.9.6 

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

func (*RouteAction_UpgradeConfig) Reset added in v0.6.4 

func (x *RouteAction_UpgradeConfig) Reset()

func (*RouteAction_UpgradeConfig) String added in v0.6.4 

func (x *RouteAction_UpgradeConfig) String() string

func (*RouteAction_UpgradeConfig) Validate added in v0.6.4 

func (m *RouteAction_UpgradeConfig) Validate() error

Validate checks the field values on RouteAction_UpgradeConfig with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type RouteAction_UpgradeConfigValidationError added in v0.6.4 

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

RouteAction_UpgradeConfigValidationError is the validation error returned by RouteAction_UpgradeConfig.Validate if the designated constraints aren't met.

func (RouteAction_UpgradeConfigValidationError) Cause added in v0.6.4 

func (e RouteAction_UpgradeConfigValidationError) Cause() error

Cause function returns cause value.

func (RouteAction_UpgradeConfigValidationError) Error added in v0.6.4 

func (e RouteAction_UpgradeConfigValidationError) Error() string

Error satisfies the builtin error interface

func (RouteAction_UpgradeConfigValidationError) ErrorName added in v0.7.0 

func (e RouteAction_UpgradeConfigValidationError) ErrorName() string

ErrorName returns error name.

func (RouteAction_UpgradeConfigValidationError) Field added in v0.6.4 

func (e RouteAction_UpgradeConfigValidationError) Field() string

Field function returns field value.

func (RouteAction_UpgradeConfigValidationError) Key added in v0.6.4 

func (e RouteAction_UpgradeConfigValidationError) Key() bool

Key function returns key value.

func (RouteAction_UpgradeConfigValidationError) Reason added in v0.6.4 

func (e RouteAction_UpgradeConfigValidationError) Reason() string

Reason function returns reason value.

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_Regex
	//	*RouteMatch_SafeRegex
	PathSpecifier isRouteMatch_PathSpecifier `protobuf_oneof:"path_specifier"`
	// Indicates that prefix/path matching should be case sensitive. 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 *core.RuntimeFractionalPercent `protobuf:"bytes,9,opt,name=runtime_fraction,json=runtimeFraction,proto3" json:"runtime_fraction,omitempty"`
	// Specifies a set of headers that the route should match on. The router will
	// check the request’s headers against all the specified headers in the route
	// config. A match will happen if all the headers in the route are present in
	// the request with the same values (or based on presence if the value field
	// is not in the config).
	Headers []*HeaderMatcher `protobuf:"bytes,6,rep,name=headers,proto3" json:"headers,omitempty"`
	// Specifies a set of URL query parameters on which the route should
	// match. The router will check the query string from the *path* header
	// against all the specified query parameters. If the number of specified
	// query parameters is nonzero, they all must match the *path* header's
	// query string for a match to occur.
	QueryParameters []*QueryParameterMatcher `protobuf:"bytes,7,rep,name=query_parameters,json=queryParameters,proto3" json:"query_parameters,omitempty"`
	// If specified, only gRPC requests will be matched. The router will check
	// that the content-type header has a application/grpc or one of the various
	// application/grpc+ values.
	Grpc *RouteMatch_GrpcRouteMatchOptions `protobuf:"bytes,8,opt,name=grpc,proto3" json:"grpc,omitempty"`
	// 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: 12]

func (*RouteMatch) Descriptor deprecated 

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

Deprecated: Use RouteMatch.ProtoReflect.Descriptor instead.

func (*RouteMatch) GetCaseSensitive 

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

func (*RouteMatch) GetGrpc added in v0.6.0 

func (x *RouteMatch) GetGrpc() *RouteMatch_GrpcRouteMatchOptions

func (*RouteMatch) GetHeaders 

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

func (*RouteMatch) GetPath 

func (x *RouteMatch) GetPath() string

func (*RouteMatch) GetPathSpecifier 

func (m *RouteMatch) GetPathSpecifier() isRouteMatch_PathSpecifier

func (*RouteMatch) GetPrefix 

func (x *RouteMatch) GetPrefix() string

func (*RouteMatch) GetQueryParameters 

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

func (*RouteMatch) GetRegex deprecated 

func (x *RouteMatch) GetRegex() string

Deprecated: Do not use.

func (*RouteMatch) GetRuntimeFraction added in v0.6.1 

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

func (*RouteMatch) GetSafeRegex added in v0.9.0 

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

func (*RouteMatch) GetTlsContext added in v0.9.1 

func (x *RouteMatch) GetTlsContext() *RouteMatch_TlsContextMatchOptions

func (*RouteMatch) ProtoMessage 

func (*RouteMatch) ProtoMessage()

func (*RouteMatch) ProtoReflect added in v0.9.6 

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

func (*RouteMatch) Reset 

func (x *RouteMatch) Reset()

func (*RouteMatch) String 

func (x *RouteMatch) String() string

func (*RouteMatch) Validate 

func (m *RouteMatch) Validate() error

Validate checks the field values on RouteMatch with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type RouteMatchValidationError 

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

RouteMatchValidationError is the validation error returned by RouteMatch.Validate if the designated constraints aren't met.

func (RouteMatchValidationError) Cause 

func (e RouteMatchValidationError) Cause() error

Cause function returns cause value.

func (RouteMatchValidationError) Error 

func (e RouteMatchValidationError) Error() string

Error satisfies the builtin error interface

func (RouteMatchValidationError) ErrorName added in v0.7.0 

func (e RouteMatchValidationError) ErrorName() string

ErrorName returns error name.

func (RouteMatchValidationError) Field 

func (e RouteMatchValidationError) Field() string

Field function returns field value.

func (RouteMatchValidationError) Key 

func (e RouteMatchValidationError) Key() bool

Key function returns key value.

func (RouteMatchValidationError) Reason 

func (e RouteMatchValidationError) Reason() string

Reason function returns reason value.

type RouteMatch_GrpcRouteMatchOptions added in v0.6.0 

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

func (*RouteMatch_GrpcRouteMatchOptions) Descriptor deprecated added in v0.6.0 

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

Deprecated: Use RouteMatch_GrpcRouteMatchOptions.ProtoReflect.Descriptor instead.

func (*RouteMatch_GrpcRouteMatchOptions) ProtoMessage added in v0.6.0 

func (*RouteMatch_GrpcRouteMatchOptions) ProtoMessage()

func (*RouteMatch_GrpcRouteMatchOptions) ProtoReflect added in v0.9.6 

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

func (*RouteMatch_GrpcRouteMatchOptions) Reset added in v0.6.0 

func (x *RouteMatch_GrpcRouteMatchOptions) Reset()

func (*RouteMatch_GrpcRouteMatchOptions) String added in v0.6.0 

func (x *RouteMatch_GrpcRouteMatchOptions) String() string

func (*RouteMatch_GrpcRouteMatchOptions) Validate added in v0.6.0 

func (m *RouteMatch_GrpcRouteMatchOptions) Validate() error

Validate checks the field values on RouteMatch_GrpcRouteMatchOptions with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type RouteMatch_GrpcRouteMatchOptionsValidationError added in v0.6.0 

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

RouteMatch_GrpcRouteMatchOptionsValidationError is the validation error returned by RouteMatch_GrpcRouteMatchOptions.Validate if the designated constraints aren't met.

func (RouteMatch_GrpcRouteMatchOptionsValidationError) Cause added in v0.6.0 

func (e RouteMatch_GrpcRouteMatchOptionsValidationError) Cause() error

Cause function returns cause value.

func (RouteMatch_GrpcRouteMatchOptionsValidationError) Error added in v0.6.0 

func (e RouteMatch_GrpcRouteMatchOptionsValidationError) Error() string

Error satisfies the builtin error interface

func (RouteMatch_GrpcRouteMatchOptionsValidationError) ErrorName added in v0.7.0 

func (e RouteMatch_GrpcRouteMatchOptionsValidationError) ErrorName() string

ErrorName returns error name.

func (RouteMatch_GrpcRouteMatchOptionsValidationError) Field added in v0.6.0 

func (e RouteMatch_GrpcRouteMatchOptionsValidationError) Field() string

Field function returns field value.

func (RouteMatch_GrpcRouteMatchOptionsValidationError) Key added in v0.6.0 

func (e RouteMatch_GrpcRouteMatchOptionsValidationError) Key() bool

Key function returns key value.

func (RouteMatch_GrpcRouteMatchOptionsValidationError) Reason added in v0.6.0 

func (e RouteMatch_GrpcRouteMatchOptionsValidationError) Reason() string

Reason function returns reason value.

type RouteMatch_Path 

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

type RouteMatch_Prefix 

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

type RouteMatch_Regex 

type RouteMatch_Regex struct {
	// If specified, the route is a regular expression rule meaning that the
	// regex must match the *:path* header once the query string is removed. The entire path
	// (without the query string) must match the regex. The rule will not match if only a
	// subsequence of the *:path* header matches the regex. The regex grammar is defined `here
	// <https://en.cppreference.com/w/cpp/regex/ecmascript>`_.
	//
	// Examples:
	//
	// * The regex “/b[io]t“ matches the path */bit*
	// * The regex “/b[io]t“ matches the path */bot*
	// * The regex “/b[io]t“ does not match the path */bite*
	// * The regex “/b[io]t“ does not match the path */bit/bot*
	//
	// .. attention::
	//   This field has been deprecated in favor of `safe_regex` as it is not safe for use with
	//   untrusted input in all cases.
	//
	// Deprecated: Do not use.
	Regex string `protobuf:"bytes,3,opt,name=regex,proto3,oneof"`
}

type RouteMatch_SafeRegex added in v0.9.0 

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 *matcher.RegexMatcher `protobuf:"bytes,10,opt,name=safe_regex,json=safeRegex,proto3,oneof"`
}

type RouteMatch_TlsContextMatchOptions added in v0.9.1 

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) Descriptor deprecated added in v0.9.1 

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

Deprecated: Use RouteMatch_TlsContextMatchOptions.ProtoReflect.Descriptor instead.

func (*RouteMatch_TlsContextMatchOptions) GetPresented added in v0.9.1 

func (x *RouteMatch_TlsContextMatchOptions) GetPresented() *wrappers.BoolValue

func (*RouteMatch_TlsContextMatchOptions) GetValidated added in v0.9.3 

func (x *RouteMatch_TlsContextMatchOptions) GetValidated() *wrappers.BoolValue

func (*RouteMatch_TlsContextMatchOptions) ProtoMessage added in v0.9.1 

func (*RouteMatch_TlsContextMatchOptions) ProtoMessage()

func (*RouteMatch_TlsContextMatchOptions) ProtoReflect added in v0.9.6 

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

func (*RouteMatch_TlsContextMatchOptions) Reset added in v0.9.1 

func (x *RouteMatch_TlsContextMatchOptions) Reset()

func (*RouteMatch_TlsContextMatchOptions) String added in v0.9.1 

func (x *RouteMatch_TlsContextMatchOptions) String() string

func (*RouteMatch_TlsContextMatchOptions) Validate added in v0.9.1 

func (m *RouteMatch_TlsContextMatchOptions) Validate() error

Validate checks the field values on RouteMatch_TlsContextMatchOptions with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type RouteMatch_TlsContextMatchOptionsValidationError added in v0.9.1 

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

RouteMatch_TlsContextMatchOptionsValidationError is the validation error returned by RouteMatch_TlsContextMatchOptions.Validate if the designated constraints aren't met.

func (RouteMatch_TlsContextMatchOptionsValidationError) Cause added in v0.9.1 

func (e RouteMatch_TlsContextMatchOptionsValidationError) Cause() error

Cause function returns cause value.

func (RouteMatch_TlsContextMatchOptionsValidationError) Error added in v0.9.1 

func (e RouteMatch_TlsContextMatchOptionsValidationError) Error() string

Error satisfies the builtin error interface

func (RouteMatch_TlsContextMatchOptionsValidationError) ErrorName added in v0.9.1 

func (e RouteMatch_TlsContextMatchOptionsValidationError) ErrorName() string

ErrorName returns error name.

func (RouteMatch_TlsContextMatchOptionsValidationError) Field added in v0.9.1 

func (e RouteMatch_TlsContextMatchOptionsValidationError) Field() string

Field function returns field value.

func (RouteMatch_TlsContextMatchOptionsValidationError) Key added in v0.9.1 

func (e RouteMatch_TlsContextMatchOptionsValidationError) Key() bool

Key function returns key value.

func (RouteMatch_TlsContextMatchOptionsValidationError) Reason added in v0.9.1 

func (e RouteMatch_TlsContextMatchOptionsValidationError) Reason() string

Reason function returns reason value.

type RouteValidationError 

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

RouteValidationError is the validation error returned by Route.Validate if the designated constraints aren't met.

func (RouteValidationError) Cause 

func (e RouteValidationError) Cause() error

Cause function returns cause value.

func (RouteValidationError) Error 

func (e RouteValidationError) Error() string

Error satisfies the builtin error interface

func (RouteValidationError) ErrorName added in v0.7.0 

func (e RouteValidationError) ErrorName() string

ErrorName returns error name.

func (RouteValidationError) Field 

func (e RouteValidationError) Field() string

Field function returns field value.

func (RouteValidationError) Key 

func (e RouteValidationError) Key() bool

Key function returns key value.

func (RouteValidationError) Reason 

func (e RouteValidationError) Reason() string

Reason function returns reason value.

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

type Route_FilterAction struct {
	// [#not-implemented-hide:]
	// If true, a filter will define the action (e.g., it could dynamically generate the
	// RouteAction).
	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 added in v0.8.1 

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

func (*Tracing) Descriptor deprecated added in v0.8.1 

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

Deprecated: Use Tracing.ProtoReflect.Descriptor instead.

func (*Tracing) GetClientSampling added in v0.8.1 

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

func (*Tracing) GetCustomTags added in v0.9.2 

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

func (*Tracing) GetOverallSampling added in v0.8.1 

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

func (*Tracing) GetRandomSampling added in v0.8.1 

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

func (*Tracing) ProtoMessage added in v0.8.1 

func (*Tracing) ProtoMessage()

func (*Tracing) ProtoReflect added in v0.9.6 

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

func (*Tracing) Reset added in v0.8.1 

func (x *Tracing) Reset()

func (*Tracing) String added in v0.8.1 

func (x *Tracing) String() string

func (*Tracing) Validate added in v0.8.1 

func (m *Tracing) Validate() error

Validate checks the field values on Tracing with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type TracingValidationError added in v0.8.1 

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

TracingValidationError is the validation error returned by Tracing.Validate if the designated constraints aren't met.

func (TracingValidationError) Cause added in v0.8.1 

func (e TracingValidationError) Cause() error

Cause function returns cause value.

func (TracingValidationError) Error added in v0.8.1 

func (e TracingValidationError) Error() string

Error satisfies the builtin error interface

func (TracingValidationError) ErrorName added in v0.8.1 

func (e TracingValidationError) ErrorName() string

ErrorName returns error name.

func (TracingValidationError) Field added in v0.8.1 

func (e TracingValidationError) Field() string

Field function returns field value.

func (TracingValidationError) Key added in v0.8.1 

func (e TracingValidationError) Key() bool

Key function returns key value.

func (TracingValidationError) Reason added in v0.8.1 

func (e TracingValidationError) Reason() string

Reason function returns reason value.

type VirtualCluster 

type VirtualCluster struct {

	// Specifies a regex pattern to use for matching requests. The entire path of the request
	// must match the regex. The regex grammar used is defined `here
	// <https://en.cppreference.com/w/cpp/regex/ecmascript>`_.
	//
	// Examples:
	//
	// * The regex “/rides/\d+“ matches the path */rides/0*
	// * The regex “/rides/\d+“ matches the path */rides/123*
	// * The regex “/rides/\d+“ does not match the path */rides/123/456*
	//
	// .. attention::
	//   This field has been deprecated in favor of `headers` as it is not safe for use with
	//   untrusted input in all cases.
	//
	// Deprecated: Do not use.
	Pattern string `protobuf:"bytes,1,opt,name=pattern,proto3" json:"pattern,omitempty"`
	// 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"`
	// Optionally specifies the HTTP method to match on. For example GET, PUT,
	// etc.
	//
	// .. attention::
	//   This field has been deprecated in favor of `headers`.
	//
	// Deprecated: Do not use.
	Method core.RequestMethod `protobuf:"varint,3,opt,name=method,proto3,enum=envoy.api.v2.core.RequestMethod" json:"method,omitempty"`
	// contains filtered or unexported fields
}

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

Documentation for :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) Descriptor deprecated 

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

Deprecated: Use VirtualCluster.ProtoReflect.Descriptor instead.

func (*VirtualCluster) GetHeaders added in v0.9.0 

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

func (*VirtualCluster) GetMethod deprecated 

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

Deprecated: Do not use.

func (*VirtualCluster) GetName 

func (x *VirtualCluster) GetName() string

func (*VirtualCluster) GetPattern deprecated 

func (x *VirtualCluster) GetPattern() string

Deprecated: Do not use.

func (*VirtualCluster) ProtoMessage 

func (*VirtualCluster) ProtoMessage()

func (*VirtualCluster) ProtoReflect added in v0.9.6 

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

func (*VirtualCluster) Reset 

func (x *VirtualCluster) Reset()

func (*VirtualCluster) String 

func (x *VirtualCluster) String() string

func (*VirtualCluster) Validate 

func (m *VirtualCluster) Validate() error

Validate checks the field values on VirtualCluster with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type VirtualClusterValidationError 

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

VirtualClusterValidationError is the validation error returned by VirtualCluster.Validate if the designated constraints aren't met.

func (VirtualClusterValidationError) Cause 

func (e VirtualClusterValidationError) Cause() error

Cause function returns cause value.

func (VirtualClusterValidationError) Error 

func (e VirtualClusterValidationError) Error() string

Error satisfies the builtin error interface

func (VirtualClusterValidationError) ErrorName added in v0.7.0 

func (e VirtualClusterValidationError) ErrorName() string

ErrorName returns error name.

func (VirtualClusterValidationError) Field 

func (e VirtualClusterValidationError) Field() string

Field function returns field value.

func (VirtualClusterValidationError) Key 

func (e VirtualClusterValidationError) Key() bool

Key function returns key value.

func (VirtualClusterValidationError) Reason 

func (e VirtualClusterValidationError) Reason() string

Reason function returns reason value.

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 `` /* 147-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_route.Route` and before headers from the
	// enclosing :ref:`envoy_api_msg_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 []*core.HeaderValueOption `protobuf:"bytes,7,rep,name=request_headers_to_add,json=requestHeadersToAdd,proto3" json:"request_headers_to_add,omitempty"`
	// Specifies a list of HTTP headers that should be removed from each request
	// handled by this virtual host.
	RequestHeadersToRemove []string `` /* 132-byte string literal not displayed */
	// Specifies a list of HTTP headers that should be added to each response
	// handled by this virtual host. Headers specified at this level are applied
	// after headers from enclosed :ref:`envoy_api_msg_route.Route` and before headers from the
	// enclosing :ref:`envoy_api_msg_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 []*core.HeaderValueOption `` /* 126-byte string literal not displayed */
	// Specifies a list of HTTP headers that should be removed from each response
	// handled by this virtual host.
	ResponseHeadersToRemove []string `` /* 135-byte string literal not displayed */
	// Indicates that the virtual host has a CORS policy.
	Cors *CorsPolicy `protobuf:"bytes,8,opt,name=cors,proto3" json:"cors,omitempty"`
	// The per_filter_config field can be used to provide virtual host-specific
	// configurations for filters. The key should match the filter name, such as
	// *envoy.filters.http.buffer* for the HTTP buffer filter. Use of this field is filter
	// specific; see the :ref:`HTTP filter documentation <config_http_filters>`
	// for if and how it is utilized.
	//
	// Deprecated: Do not use.
	PerFilterConfig map[string]*_struct.Struct `` /* 197-byte string literal not displayed */
	// The per_filter_config field can be used to provide virtual host-specific
	// configurations for filters. The key should match the filter name, such as
	// *envoy.filters.http.buffer* for the HTTP buffer filter. Use of this field is filter
	// specific; see the :ref:`HTTP filter documentation <config_http_filters>`
	// for if and how it is utilized.
	TypedPerFilterConfig map[string]*any.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_config.filter.http.router.v2.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_config.filter.http.router.v2.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_route.VirtualHost.retry_policy>` should not be
	// set if this field is used.
	RetryPolicyTypedConfig *any.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) Descriptor deprecated 

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

Deprecated: Use VirtualHost.ProtoReflect.Descriptor instead.

func (*VirtualHost) GetCors 

func (x *VirtualHost) GetCors() *CorsPolicy

func (*VirtualHost) GetDomains 

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

func (*VirtualHost) GetHedgePolicy added in v0.6.8 

func (x *VirtualHost) GetHedgePolicy() *HedgePolicy

func (*VirtualHost) GetIncludeAttemptCountInResponse added in v0.9.5 

func (x *VirtualHost) GetIncludeAttemptCountInResponse() bool

func (*VirtualHost) GetIncludeRequestAttemptCount added in v0.6.1 

func (x *VirtualHost) GetIncludeRequestAttemptCount() bool

func (*VirtualHost) GetName 

func (x *VirtualHost) GetName() string

func (*VirtualHost) GetPerFilterConfig deprecated 

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

Deprecated: Do not use.

func (*VirtualHost) GetPerRequestBufferLimitBytes added in v0.9.1 

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

func (*VirtualHost) GetRateLimits 

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

func (*VirtualHost) GetRequestHeadersToAdd 

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

func (*VirtualHost) GetRequestHeadersToRemove added in v0.6.0 

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

func (*VirtualHost) GetRequireTls 

func (x *VirtualHost) GetRequireTls() VirtualHost_TlsRequirementType

func (*VirtualHost) GetResponseHeadersToAdd 

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

func (*VirtualHost) GetResponseHeadersToRemove 

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

func (*VirtualHost) GetRetryPolicy added in v0.6.7 

func (x *VirtualHost) GetRetryPolicy() *RetryPolicy

func (*VirtualHost) GetRetryPolicyTypedConfig added in v0.9.5 

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

func (*VirtualHost) GetRoutes 

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

func (*VirtualHost) GetTypedPerFilterConfig added in v0.6.3 

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

func (*VirtualHost) GetVirtualClusters 

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

func (*VirtualHost) ProtoMessage 

func (*VirtualHost) ProtoMessage()

func (*VirtualHost) ProtoReflect added in v0.9.6 

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

func (*VirtualHost) Reset 

func (x *VirtualHost) Reset()

func (*VirtualHost) String 

func (x *VirtualHost) String() string

func (*VirtualHost) Validate 

func (m *VirtualHost) Validate() error

Validate checks the field values on VirtualHost with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type VirtualHostValidationError 

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

VirtualHostValidationError is the validation error returned by VirtualHost.Validate if the designated constraints aren't met.

func (VirtualHostValidationError) Cause 

func (e VirtualHostValidationError) Cause() error

Cause function returns cause value.

func (VirtualHostValidationError) Error 

func (e VirtualHostValidationError) Error() string

Error satisfies the builtin error interface

func (VirtualHostValidationError) ErrorName added in v0.7.0 

func (e VirtualHostValidationError) ErrorName() string

ErrorName returns error name.

func (VirtualHostValidationError) Field 

func (e VirtualHostValidationError) Field() string

Field function returns field value.

func (VirtualHostValidationError) Key 

func (e VirtualHostValidationError) Key() bool

Key function returns key value.

func (VirtualHostValidationError) Reason 

func (e VirtualHostValidationError) Reason() string

Reason function returns reason value.

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 v0.9.6 

func (VirtualHost_TlsRequirementType) Descriptor() protoreflect.EnumDescriptor

func (VirtualHost_TlsRequirementType) Enum added in v0.9.6 

func (x VirtualHost_TlsRequirementType) Enum() *VirtualHost_TlsRequirementType

func (VirtualHost_TlsRequirementType) EnumDescriptor deprecated 

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

Deprecated: Use VirtualHost_TlsRequirementType.Descriptor instead.

func (VirtualHost_TlsRequirementType) Number added in v0.9.6 

func (x VirtualHost_TlsRequirementType) Number() protoreflect.EnumNumber

func (VirtualHost_TlsRequirementType) String 

func (x VirtualHost_TlsRequirementType) String() string

func (VirtualHost_TlsRequirementType) Type added in v0.9.6 

func (VirtualHost_TlsRequirementType) Type() protoreflect.EnumType

type WeightedCluster 

type WeightedCluster struct {

	// Specifies one or more upstream clusters associated with the route.
	Clusters []*WeightedCluster_ClusterWeight `protobuf:"bytes,1,rep,name=clusters,proto3" json:"clusters,omitempty"`
	// Specifies the total weight across all clusters. The sum of all cluster weights must equal this
	// value, which must be greater than 0. Defaults to 100.
	TotalWeight *wrappers.UInt32Value `protobuf:"bytes,3,opt,name=total_weight,json=totalWeight,proto3" json:"total_weight,omitempty"`
	// Specifies the runtime key prefix that should be used to construct the
	// runtime keys associated with each cluster. When the *runtime_key_prefix* is
	// specified, the router will look for weights associated with each upstream
	// cluster under the key *runtime_key_prefix* + "." + *cluster[i].name* where
	// *cluster[i]* denotes an entry in the clusters array field. If the runtime
	// key for the cluster does not exist, the value specified in the
	// configuration file will be used as the default weight. See the :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_route.RouteAction.cluster>` field that specifies a single upstream cluster as the target of a request, the :ref:`weighted_clusters <envoy_api_field_route.RouteAction.weighted_clusters>` option allows for specification of multiple upstream clusters along with weights that indicate the percentage of traffic to be forwarded to each cluster. The router selects an upstream cluster based on the weights.

func (*WeightedCluster) Descriptor deprecated 

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

Deprecated: Use WeightedCluster.ProtoReflect.Descriptor instead.

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

func (*WeightedCluster) ProtoMessage()

func (*WeightedCluster) ProtoReflect added in v0.9.6 

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

func (*WeightedCluster) Reset 

func (x *WeightedCluster) Reset()

func (*WeightedCluster) String 

func (x *WeightedCluster) String() string

func (*WeightedCluster) Validate 

func (m *WeightedCluster) Validate() error

Validate checks the field values on WeightedCluster with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type WeightedClusterValidationError 

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

WeightedClusterValidationError is the validation error returned by WeightedCluster.Validate if the designated constraints aren't met.

func (WeightedClusterValidationError) Cause 

func (e WeightedClusterValidationError) Cause() error

Cause function returns cause value.

func (WeightedClusterValidationError) Error 

func (e WeightedClusterValidationError) Error() string

Error satisfies the builtin error interface

func (WeightedClusterValidationError) ErrorName added in v0.7.0 

func (e WeightedClusterValidationError) ErrorName() string

ErrorName returns error name.

func (WeightedClusterValidationError) Field 

func (e WeightedClusterValidationError) Field() string

Field function returns field value.

func (WeightedClusterValidationError) Key 

func (e WeightedClusterValidationError) Key() bool

Key function returns key value.

func (WeightedClusterValidationError) Reason 

func (e WeightedClusterValidationError) Reason() string

Reason function returns reason value.

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

[#next-free-field: 11]

func (*WeightedCluster_ClusterWeight) Descriptor deprecated 

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

Deprecated: Use WeightedCluster_ClusterWeight.ProtoReflect.Descriptor instead.

func (*WeightedCluster_ClusterWeight) GetMetadataMatch 

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

func (*WeightedCluster_ClusterWeight) GetName 

func (x *WeightedCluster_ClusterWeight) GetName() string

func (*WeightedCluster_ClusterWeight) GetPerFilterConfig deprecated 

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

Deprecated: Do not use.

func (*WeightedCluster_ClusterWeight) GetRequestHeadersToAdd 

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

func (*WeightedCluster_ClusterWeight) GetRequestHeadersToRemove added in v0.6.0 

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

func (*WeightedCluster_ClusterWeight) GetResponseHeadersToAdd 

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

func (*WeightedCluster_ClusterWeight) GetResponseHeadersToRemove 

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

func (*WeightedCluster_ClusterWeight) GetTypedPerFilterConfig added in v0.6.3 

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

func (*WeightedCluster_ClusterWeight) GetWeight 

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

func (*WeightedCluster_ClusterWeight) ProtoMessage 

func (*WeightedCluster_ClusterWeight) ProtoMessage()

func (*WeightedCluster_ClusterWeight) ProtoReflect added in v0.9.6 

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

func (*WeightedCluster_ClusterWeight) Reset 

func (x *WeightedCluster_ClusterWeight) Reset()

func (*WeightedCluster_ClusterWeight) String 

func (x *WeightedCluster_ClusterWeight) String() string

func (*WeightedCluster_ClusterWeight) Validate 

func (m *WeightedCluster_ClusterWeight) Validate() error

Validate checks the field values on WeightedCluster_ClusterWeight with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type WeightedCluster_ClusterWeightValidationError 

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

WeightedCluster_ClusterWeightValidationError is the validation error returned by WeightedCluster_ClusterWeight.Validate if the designated constraints aren't met.

func (WeightedCluster_ClusterWeightValidationError) Cause 

func (e WeightedCluster_ClusterWeightValidationError) Cause() error

Cause function returns cause value.

func (WeightedCluster_ClusterWeightValidationError) Error 

func (e WeightedCluster_ClusterWeightValidationError) Error() string

Error satisfies the builtin error interface

func (WeightedCluster_ClusterWeightValidationError) ErrorName added in v0.7.0 

func (e WeightedCluster_ClusterWeightValidationError) ErrorName() string

ErrorName returns error name.

func (WeightedCluster_ClusterWeightValidationError) Field 

func (e WeightedCluster_ClusterWeightValidationError) Field() string

Field function returns field value.

func (WeightedCluster_ClusterWeightValidationError) Key 

func (e WeightedCluster_ClusterWeightValidationError) Key() bool

Key function returns key value.

func (WeightedCluster_ClusterWeightValidationError) Reason 

func (e WeightedCluster_ClusterWeightValidationError) Reason() string

Reason function returns reason value.

Source Files

View all Source files

Jump to

Keyboard shortcuts

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