routev3

package
v1.34.2-20230518215316... Latest Latest
Warning

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

 Go to latest Published: unknown License: Apache-2.0 Imports: 17 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

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

Enum value maps for VirtualHost_TlsRequirementType.

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

Enum value maps for RouteAction_ClusterNotFoundResponseCode.

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

Enum value maps for RouteAction_InternalRedirectAction.

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

Enum value maps for RetryPolicy_ResetHeaderFormat.

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

Enum value maps for RedirectAction_RedirectResponseCode.

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

Enum value maps for RateLimit_Action_MetaData_Source.

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

Functions

This section is empty.

Types

type ClusterSpecifierPlugin 

type ClusterSpecifierPlugin struct {

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

Configuration for a cluster specifier plugin.

func (*ClusterSpecifierPlugin) Descriptor deprecated 

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

Deprecated: Use ClusterSpecifierPlugin.ProtoReflect.Descriptor instead.

func (*ClusterSpecifierPlugin) GetExtension 

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

func (*ClusterSpecifierPlugin) GetIsOptional 

func (x *ClusterSpecifierPlugin) GetIsOptional() bool

func (*ClusterSpecifierPlugin) ProtoMessage 

func (*ClusterSpecifierPlugin) ProtoMessage()

func (*ClusterSpecifierPlugin) ProtoReflect 

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

func (*ClusterSpecifierPlugin) Reset 

func (x *ClusterSpecifierPlugin) Reset()

func (*ClusterSpecifierPlugin) String 

func (x *ClusterSpecifierPlugin) String() string

type CorsPolicy 

type CorsPolicy struct {

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

Cors policy configuration.

.. attention:: 

This message has been deprecated. Please use
:ref:`CorsPolicy in filter extension <envoy_v3_api_msg_extensions.filters.http.cors.v3.CorsPolicy>`
as as alternative.

[#next-free-field: 13]

func (*CorsPolicy) Descriptor deprecated 

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

Deprecated: Use CorsPolicy.ProtoReflect.Descriptor instead.

func (*CorsPolicy) GetAllowCredentials 

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

func (*CorsPolicy) GetAllowHeaders 

func (x *CorsPolicy) GetAllowHeaders() string

func (*CorsPolicy) GetAllowMethods 

func (x *CorsPolicy) GetAllowMethods() string

func (*CorsPolicy) GetAllowOriginStringMatch 

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

func (*CorsPolicy) GetAllowPrivateNetworkAccess 

func (x *CorsPolicy) GetAllowPrivateNetworkAccess() *wrapperspb.BoolValue

func (*CorsPolicy) GetEnabledSpecifier 

func (m *CorsPolicy) GetEnabledSpecifier() isCorsPolicy_EnabledSpecifier

func (*CorsPolicy) GetExposeHeaders 

func (x *CorsPolicy) GetExposeHeaders() string

func (*CorsPolicy) GetFilterEnabled 

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

func (*CorsPolicy) GetMaxAge 

func (x *CorsPolicy) GetMaxAge() string

func (*CorsPolicy) GetShadowEnabled 

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

func (*CorsPolicy) ProtoMessage 

func (*CorsPolicy) ProtoMessage()

func (*CorsPolicy) ProtoReflect 

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

func (*CorsPolicy) Reset 

func (x *CorsPolicy) Reset()

func (*CorsPolicy) String 

func (x *CorsPolicy) String() string

type CorsPolicy_FilterEnabled 

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

type Decorator 

type Decorator struct {

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

func (*Decorator) Descriptor deprecated 

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

Deprecated: Use Decorator.ProtoReflect.Descriptor instead.

func (*Decorator) GetOperation 

func (x *Decorator) GetOperation() string

func (*Decorator) GetPropagate 

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

func (*Decorator) ProtoMessage 

func (*Decorator) ProtoMessage()

func (*Decorator) ProtoReflect 

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

func (*Decorator) Reset 

func (x *Decorator) Reset()

func (*Decorator) String 

func (x *Decorator) String() string

type DirectResponseAction 

type DirectResponseAction struct {

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

func (*DirectResponseAction) Descriptor deprecated 

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

Deprecated: Use DirectResponseAction.ProtoReflect.Descriptor instead.

func (*DirectResponseAction) GetBody 

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

func (*DirectResponseAction) GetStatus 

func (x *DirectResponseAction) GetStatus() uint32

func (*DirectResponseAction) ProtoMessage 

func (*DirectResponseAction) ProtoMessage()

func (*DirectResponseAction) ProtoReflect 

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

func (*DirectResponseAction) Reset 

func (x *DirectResponseAction) Reset()

func (*DirectResponseAction) String 

func (x *DirectResponseAction) String() string

type FilterAction 

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

A filter-defined action type.

func (*FilterAction) Descriptor deprecated 

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

Deprecated: Use FilterAction.ProtoReflect.Descriptor instead.

func (*FilterAction) GetAction 

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

func (*FilterAction) ProtoMessage 

func (*FilterAction) ProtoMessage()

func (*FilterAction) ProtoReflect 

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

func (*FilterAction) Reset 

func (x *FilterAction) Reset()

func (*FilterAction) String 

func (x *FilterAction) String() string

type FilterConfig 

type FilterConfig struct {

	// The filter config.
	Config *anypb.Any `protobuf:"bytes,1,opt,name=config,proto3" json:"config,omitempty"`
	// If true, the filter is optional, meaning that if the client does
	// not support the specified filter, it may ignore the map entry rather
	// than rejecting the config.
	IsOptional bool `protobuf:"varint,2,opt,name=is_optional,json=isOptional,proto3" json:"is_optional,omitempty"`
	// If true, the filter is disabled in the route or virtual host and the “config“ field is ignored.
	//
	// .. note::
	//
	//	This field will take effect when the request arrive and filter chain is created for the request.
	//	If initial route is selected for the request and a filter is disabled in the initial route, then
	//	the filter will not be added to the filter chain.
	//	And if the request is mutated later and re-match to another route, the disabled filter by the
	//	initial route will not be added back to the filter chain because the filter chain is already
	//	created and it is too late to change the chain.
	//
	//	This field only make sense for the downstream HTTP filters for now.
	Disabled bool `protobuf:"varint,3,opt,name=disabled,proto3" json:"disabled,omitempty"`
	// contains filtered or unexported fields
}

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

func (*FilterConfig) Descriptor deprecated 

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

Deprecated: Use FilterConfig.ProtoReflect.Descriptor instead.

func (*FilterConfig) GetConfig 

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

func (*FilterConfig) GetDisabled 

func (x *FilterConfig) GetDisabled() bool

func (*FilterConfig) GetIsOptional 

func (x *FilterConfig) GetIsOptional() bool

func (*FilterConfig) ProtoMessage 

func (*FilterConfig) ProtoMessage()

func (*FilterConfig) ProtoReflect 

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

func (*FilterConfig) Reset 

func (x *FilterConfig) Reset()

func (*FilterConfig) String 

func (x *FilterConfig) String() string

type HeaderMatcher 

type HeaderMatcher struct {

	// Specifies the name of the header in the request.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Specifies how the header match will be performed to route the request.
	//
	// Types that are assignable to HeaderMatchSpecifier:
	//
	//	*HeaderMatcher_ExactMatch
	//	*HeaderMatcher_SafeRegexMatch
	//	*HeaderMatcher_RangeMatch
	//	*HeaderMatcher_PresentMatch
	//	*HeaderMatcher_PrefixMatch
	//	*HeaderMatcher_SuffixMatch
	//	*HeaderMatcher_ContainsMatch
	//	*HeaderMatcher_StringMatch
	HeaderMatchSpecifier isHeaderMatcher_HeaderMatchSpecifier `protobuf_oneof:"header_match_specifier"`
	// If specified, the match result will be inverted before checking. Defaults to false.
	//
	// Examples:
	//
	// * The regex “\d{3}“ does not match the value “1234“, so it will match when inverted.
	// * The range [-10,0) will match the value -1, so it will not match when inverted.
	InvertMatch bool `protobuf:"varint,8,opt,name=invert_match,json=invertMatch,proto3" json:"invert_match,omitempty"`
	// If specified, for any header match rule, if the header match rule specified header
	// does not exist, this header value will be treated as empty. Defaults to false.
	//
	// Examples:
	//
	//   - The header match rule specified header "header1" to range match of [0, 10],
	//     :ref:`invert_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.invert_match>`
	//     is set to true and :ref:`treat_missing_header_as_empty <envoy_v3_api_field_config.route.v3.HeaderMatcher.treat_missing_header_as_empty>`
	//     is set to true; The "header1" header is not present. The match rule will
	//     treat the "header1" as an empty header. The empty header does not match the range,
	//     so it will match when inverted.
	//   - The header match rule specified header "header2" to range match of [0, 10],
	//     :ref:`invert_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.invert_match>`
	//     is set to true and :ref:`treat_missing_header_as_empty <envoy_v3_api_field_config.route.v3.HeaderMatcher.treat_missing_header_as_empty>`
	//     is set to false; The "header2" header is not present and the header
	//     matcher rule for "header2" will be ignored so it will not match.
	//   - The header match rule specified header "header3" to a string regex match
	//     “^$“ which means an empty string, and
	//     :ref:`treat_missing_header_as_empty <envoy_v3_api_field_config.route.v3.HeaderMatcher.treat_missing_header_as_empty>`
	//     is set to true; The "header3" header is not present.
	//     The match rule will treat the "header3" header as an empty header so it will match.
	//   - The header match rule specified header "header4" to a string regex match
	//     “^$“ which means an empty string, and
	//     :ref:`treat_missing_header_as_empty <envoy_v3_api_field_config.route.v3.HeaderMatcher.treat_missing_header_as_empty>`
	//     is set to false; The "header4" header is not present.
	//     The match rule for "header4" will be ignored so it will not match.
	TreatMissingHeaderAsEmpty bool `` /* 144-byte string literal not displayed */
	// 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",
    "string_match": {
      "exact": "POST"
    }
  }

.. attention:: 

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

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

[#next-free-field: 15]

func (*HeaderMatcher) Descriptor deprecated 

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

Deprecated: Use HeaderMatcher.ProtoReflect.Descriptor instead.

func (*HeaderMatcher) GetContainsMatch deprecated 

func (x *HeaderMatcher) GetContainsMatch() string

Deprecated: Marked as deprecated in envoy/config/route/v3/route_components.proto.

func (*HeaderMatcher) GetExactMatch deprecated 

func (x *HeaderMatcher) GetExactMatch() string

Deprecated: Marked as deprecated in envoy/config/route/v3/route_components.proto.

func (*HeaderMatcher) GetHeaderMatchSpecifier 

func (m *HeaderMatcher) GetHeaderMatchSpecifier() isHeaderMatcher_HeaderMatchSpecifier

func (*HeaderMatcher) GetInvertMatch 

func (x *HeaderMatcher) GetInvertMatch() bool

func (*HeaderMatcher) GetName 

func (x *HeaderMatcher) GetName() string

func (*HeaderMatcher) GetPrefixMatch deprecated 

func (x *HeaderMatcher) GetPrefixMatch() string

Deprecated: Marked as deprecated in envoy/config/route/v3/route_components.proto.

func (*HeaderMatcher) GetPresentMatch 

func (x *HeaderMatcher) GetPresentMatch() bool

func (*HeaderMatcher) GetRangeMatch 

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

func (*HeaderMatcher) GetSafeRegexMatch deprecated 

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

Deprecated: Marked as deprecated in envoy/config/route/v3/route_components.proto.

func (*HeaderMatcher) GetStringMatch 

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

func (*HeaderMatcher) GetSuffixMatch deprecated 

func (x *HeaderMatcher) GetSuffixMatch() string

Deprecated: Marked as deprecated in envoy/config/route/v3/route_components.proto.

func (*HeaderMatcher) GetTreatMissingHeaderAsEmpty 

func (x *HeaderMatcher) GetTreatMissingHeaderAsEmpty() bool

func (*HeaderMatcher) ProtoMessage 

func (*HeaderMatcher) ProtoMessage()

func (*HeaderMatcher) ProtoReflect 

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

func (*HeaderMatcher) Reset 

func (x *HeaderMatcher) Reset()

func (*HeaderMatcher) String 

func (x *HeaderMatcher) String() string

type HeaderMatcher_ContainsMatch 

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

type HeaderMatcher_ExactMatch 

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

type HeaderMatcher_PrefixMatch 

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

type HeaderMatcher_PresentMatch 

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

type HeaderMatcher_RangeMatch 

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

type HeaderMatcher_SafeRegexMatch 

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

type HeaderMatcher_StringMatch 

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

type HeaderMatcher_SuffixMatch 

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

type HedgePolicy 

type HedgePolicy struct {

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

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

func (*HedgePolicy) Descriptor deprecated 

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

Deprecated: Use HedgePolicy.ProtoReflect.Descriptor instead.

func (*HedgePolicy) GetAdditionalRequestChance 

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

func (*HedgePolicy) GetHedgeOnPerTryTimeout 

func (x *HedgePolicy) GetHedgeOnPerTryTimeout() bool

func (*HedgePolicy) GetInitialRequests 

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

func (*HedgePolicy) ProtoMessage 

func (*HedgePolicy) ProtoMessage()

func (*HedgePolicy) ProtoReflect 

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

func (*HedgePolicy) Reset 

func (x *HedgePolicy) Reset()

func (*HedgePolicy) String 

func (x *HedgePolicy) String() string

type InternalRedirectPolicy 

type InternalRedirectPolicy struct {

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

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

func (*InternalRedirectPolicy) Descriptor deprecated 

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

Deprecated: Use InternalRedirectPolicy.ProtoReflect.Descriptor instead.

func (*InternalRedirectPolicy) GetAllowCrossSchemeRedirect 

func (x *InternalRedirectPolicy) GetAllowCrossSchemeRedirect() bool

func (*InternalRedirectPolicy) GetMaxInternalRedirects 

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

func (*InternalRedirectPolicy) GetPredicates 

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

func (*InternalRedirectPolicy) GetRedirectResponseCodes 

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

func (*InternalRedirectPolicy) ProtoMessage 

func (*InternalRedirectPolicy) ProtoMessage()

func (*InternalRedirectPolicy) ProtoReflect 

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

func (*InternalRedirectPolicy) Reset 

func (x *InternalRedirectPolicy) Reset()

func (*InternalRedirectPolicy) String 

func (x *InternalRedirectPolicy) String() string

type NonForwardingAction 

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

[#not-implemented-hide:]

func (*NonForwardingAction) Descriptor deprecated 

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

Deprecated: Use NonForwardingAction.ProtoReflect.Descriptor instead.

func (*NonForwardingAction) ProtoMessage 

func (*NonForwardingAction) ProtoMessage()

func (*NonForwardingAction) ProtoReflect 

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

func (*NonForwardingAction) Reset 

func (x *NonForwardingAction) Reset()

func (*NonForwardingAction) String 

func (x *NonForwardingAction) String() string

type QueryParameterMatcher 

type QueryParameterMatcher struct {

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

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

func (*QueryParameterMatcher) Descriptor deprecated 

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

Deprecated: Use QueryParameterMatcher.ProtoReflect.Descriptor instead.

func (*QueryParameterMatcher) GetName 

func (x *QueryParameterMatcher) GetName() string

func (*QueryParameterMatcher) GetPresentMatch 

func (x *QueryParameterMatcher) GetPresentMatch() bool

func (*QueryParameterMatcher) GetQueryParameterMatchSpecifier 

func (m *QueryParameterMatcher) GetQueryParameterMatchSpecifier() isQueryParameterMatcher_QueryParameterMatchSpecifier

func (*QueryParameterMatcher) GetStringMatch 

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

func (*QueryParameterMatcher) ProtoMessage 

func (*QueryParameterMatcher) ProtoMessage()

func (*QueryParameterMatcher) ProtoReflect 

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

func (*QueryParameterMatcher) Reset 

func (x *QueryParameterMatcher) Reset()

func (*QueryParameterMatcher) String 

func (x *QueryParameterMatcher) String() string

type QueryParameterMatcher_PresentMatch 

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

type QueryParameterMatcher_StringMatch 

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

type RateLimit 

type RateLimit struct {

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

Global rate limiting :ref:`architecture overview <arch_overview_global_rate_limit>`. Also applies to Local rate limiting :ref:`using descriptors <config_http_filters_local_rate_limit_descriptors>`.

func (*RateLimit) Descriptor deprecated 

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

Deprecated: Use RateLimit.ProtoReflect.Descriptor instead.

func (*RateLimit) GetActions 

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

func (*RateLimit) GetDisableKey 

func (x *RateLimit) GetDisableKey() string

func (*RateLimit) GetLimit 

func (x *RateLimit) GetLimit() *RateLimit_Override

func (*RateLimit) GetStage 

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

func (*RateLimit) ProtoMessage 

func (*RateLimit) ProtoMessage()

func (*RateLimit) ProtoReflect 

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

func (*RateLimit) Reset 

func (x *RateLimit) Reset()

func (*RateLimit) String 

func (x *RateLimit) String() string

type RateLimit_Action 

type RateLimit_Action struct {

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

[#next-free-field: 12]

func (*RateLimit_Action) Descriptor deprecated 

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

Deprecated: Use RateLimit_Action.ProtoReflect.Descriptor instead.

func (*RateLimit_Action) GetActionSpecifier 

func (m *RateLimit_Action) GetActionSpecifier() isRateLimit_Action_ActionSpecifier

func (*RateLimit_Action) GetDestinationCluster 

func (x *RateLimit_Action) GetDestinationCluster() *RateLimit_Action_DestinationCluster

func (*RateLimit_Action) GetDynamicMetadata deprecated 

func (x *RateLimit_Action) GetDynamicMetadata() *RateLimit_Action_DynamicMetaData

Deprecated: Marked as deprecated in envoy/config/route/v3/route_components.proto.

func (*RateLimit_Action) GetExtension 

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

func (*RateLimit_Action) GetGenericKey 

func (x *RateLimit_Action) GetGenericKey() *RateLimit_Action_GenericKey

func (*RateLimit_Action) GetHeaderValueMatch 

func (x *RateLimit_Action) GetHeaderValueMatch() *RateLimit_Action_HeaderValueMatch

func (*RateLimit_Action) GetMaskedRemoteAddress 

func (x *RateLimit_Action) GetMaskedRemoteAddress() *RateLimit_Action_MaskedRemoteAddress

func (*RateLimit_Action) GetMetadata 

func (x *RateLimit_Action) GetMetadata() *RateLimit_Action_MetaData

func (*RateLimit_Action) GetQueryParameterValueMatch 

func (x *RateLimit_Action) GetQueryParameterValueMatch() *RateLimit_Action_QueryParameterValueMatch

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 

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

func (*RateLimit_Action) Reset 

func (x *RateLimit_Action) Reset()

func (*RateLimit_Action) String 

func (x *RateLimit_Action) String() string

type RateLimit_Action_DestinationCluster 

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

The following descriptor entry is appended to the descriptor:

.. code-block:: cpp 

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

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

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

func (*RateLimit_Action_DestinationCluster) Descriptor deprecated 

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

Deprecated: Use RateLimit_Action_DestinationCluster.ProtoReflect.Descriptor instead.

func (*RateLimit_Action_DestinationCluster) ProtoMessage 

func (*RateLimit_Action_DestinationCluster) ProtoMessage()

func (*RateLimit_Action_DestinationCluster) ProtoReflect 

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

func (*RateLimit_Action_DestinationCluster) Reset 

func (x *RateLimit_Action_DestinationCluster) Reset()

func (*RateLimit_Action_DestinationCluster) String 

func (x *RateLimit_Action_DestinationCluster) String() string

type RateLimit_Action_DestinationCluster_ 

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

type RateLimit_Action_DynamicMetaData 

type RateLimit_Action_DynamicMetaData struct {

	// The key to use in the descriptor entry.
	DescriptorKey string `protobuf:"bytes,1,opt,name=descriptor_key,json=descriptorKey,proto3" json:"descriptor_key,omitempty"`
	// Metadata struct that defines the key and path to retrieve the string value. A match will
	// only happen if the value in the dynamic metadata is of type string.
	MetadataKey *v35.MetadataKey `protobuf:"bytes,2,opt,name=metadata_key,json=metadataKey,proto3" json:"metadata_key,omitempty"`
	// An optional value to use if “metadata_key“ is empty. If not set and
	// no value is present under the metadata_key then no descriptor is generated.
	DefaultValue string `protobuf:"bytes,3,opt,name=default_value,json=defaultValue,proto3" json:"default_value,omitempty"`
	// contains filtered or unexported fields
}

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

.. code-block:: cpp 

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

.. attention:: 

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

func (*RateLimit_Action_DynamicMetaData) Descriptor deprecated 

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

Deprecated: Use RateLimit_Action_DynamicMetaData.ProtoReflect.Descriptor instead.

func (*RateLimit_Action_DynamicMetaData) GetDefaultValue 

func (x *RateLimit_Action_DynamicMetaData) GetDefaultValue() string

func (*RateLimit_Action_DynamicMetaData) GetDescriptorKey 

func (x *RateLimit_Action_DynamicMetaData) GetDescriptorKey() string

func (*RateLimit_Action_DynamicMetaData) GetMetadataKey 

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

func (*RateLimit_Action_DynamicMetaData) ProtoMessage 

func (*RateLimit_Action_DynamicMetaData) ProtoMessage()

func (*RateLimit_Action_DynamicMetaData) ProtoReflect 

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

func (*RateLimit_Action_DynamicMetaData) Reset 

func (x *RateLimit_Action_DynamicMetaData) Reset()

func (*RateLimit_Action_DynamicMetaData) String 

func (x *RateLimit_Action_DynamicMetaData) String() string

type RateLimit_Action_DynamicMetadata 

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

type RateLimit_Action_Extension 

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

type RateLimit_Action_GenericKey 

type RateLimit_Action_GenericKey struct {

	// The value to use in the descriptor entry.
	DescriptorValue string `protobuf:"bytes,1,opt,name=descriptor_value,json=descriptorValue,proto3" json:"descriptor_value,omitempty"`
	// An optional key to use in the descriptor entry. If not set it defaults
	// to 'generic_key' as the descriptor key.
	DescriptorKey string `protobuf:"bytes,2,opt,name=descriptor_key,json=descriptorKey,proto3" json:"descriptor_key,omitempty"`
	// contains filtered or unexported fields
}

The following descriptor entry is appended to the descriptor:

.. code-block:: cpp 

("generic_key", "<descriptor_value>")

func (*RateLimit_Action_GenericKey) Descriptor deprecated 

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

Deprecated: Use RateLimit_Action_GenericKey.ProtoReflect.Descriptor instead.

func (*RateLimit_Action_GenericKey) GetDescriptorKey 

func (x *RateLimit_Action_GenericKey) GetDescriptorKey() string

func (*RateLimit_Action_GenericKey) GetDescriptorValue 

func (x *RateLimit_Action_GenericKey) GetDescriptorValue() string

func (*RateLimit_Action_GenericKey) ProtoMessage 

func (*RateLimit_Action_GenericKey) ProtoMessage()

func (*RateLimit_Action_GenericKey) ProtoReflect 

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

func (*RateLimit_Action_GenericKey) Reset 

func (x *RateLimit_Action_GenericKey) Reset()

func (*RateLimit_Action_GenericKey) String 

func (x *RateLimit_Action_GenericKey) String() string

type RateLimit_Action_GenericKey_ 

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

type RateLimit_Action_HeaderValueMatch 

type RateLimit_Action_HeaderValueMatch struct {

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

The following descriptor entry is appended to the descriptor:

.. code-block:: cpp 

("header_match", "<descriptor_value>")

func (*RateLimit_Action_HeaderValueMatch) Descriptor deprecated 

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

Deprecated: Use RateLimit_Action_HeaderValueMatch.ProtoReflect.Descriptor instead.

func (*RateLimit_Action_HeaderValueMatch) GetDescriptorKey 

func (x *RateLimit_Action_HeaderValueMatch) GetDescriptorKey() string

func (*RateLimit_Action_HeaderValueMatch) GetDescriptorValue 

func (x *RateLimit_Action_HeaderValueMatch) GetDescriptorValue() string

func (*RateLimit_Action_HeaderValueMatch) GetExpectMatch 

func (x *RateLimit_Action_HeaderValueMatch) GetExpectMatch() *wrapperspb.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 

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

func (*RateLimit_Action_HeaderValueMatch) Reset 

func (x *RateLimit_Action_HeaderValueMatch) Reset()

func (*RateLimit_Action_HeaderValueMatch) String 

func (x *RateLimit_Action_HeaderValueMatch) String() string

type RateLimit_Action_HeaderValueMatch_ 

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

type RateLimit_Action_MaskedRemoteAddress 

type RateLimit_Action_MaskedRemoteAddress struct {

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

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

.. code-block:: cpp 

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

func (*RateLimit_Action_MaskedRemoteAddress) Descriptor deprecated 

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

Deprecated: Use RateLimit_Action_MaskedRemoteAddress.ProtoReflect.Descriptor instead.

func (*RateLimit_Action_MaskedRemoteAddress) GetV4PrefixMaskLen 

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

func (*RateLimit_Action_MaskedRemoteAddress) GetV6PrefixMaskLen 

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

func (*RateLimit_Action_MaskedRemoteAddress) ProtoMessage 

func (*RateLimit_Action_MaskedRemoteAddress) ProtoMessage()

func (*RateLimit_Action_MaskedRemoteAddress) ProtoReflect 

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

func (*RateLimit_Action_MaskedRemoteAddress) Reset 

func (x *RateLimit_Action_MaskedRemoteAddress) Reset()

func (*RateLimit_Action_MaskedRemoteAddress) String 

func (x *RateLimit_Action_MaskedRemoteAddress) String() string

type RateLimit_Action_MaskedRemoteAddress_ 

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

type RateLimit_Action_MetaData 

type RateLimit_Action_MetaData struct {

	// The key to use in the descriptor entry.
	DescriptorKey string `protobuf:"bytes,1,opt,name=descriptor_key,json=descriptorKey,proto3" json:"descriptor_key,omitempty"`
	// Metadata struct that defines the key and path to retrieve the string value. A match will
	// only happen if the value in the metadata is of type string.
	MetadataKey *v35.MetadataKey `protobuf:"bytes,2,opt,name=metadata_key,json=metadataKey,proto3" json:"metadata_key,omitempty"`
	// An optional value to use if “metadata_key“ is empty. If not set and
	// no value is present under the metadata_key then “skip_if_absent“ is followed to
	// skip calling the rate limiting service or skip the descriptor.
	DefaultValue string `protobuf:"bytes,3,opt,name=default_value,json=defaultValue,proto3" json:"default_value,omitempty"`
	// Source of metadata
	Source RateLimit_Action_MetaData_Source `` /* 126-byte string literal not displayed */
	// If set to true, Envoy skips the descriptor while calling rate limiting service
	// when “metadata_key“ is empty and “default_value“ is not set. By default it skips calling the
	// rate limiting service in that case.
	SkipIfAbsent bool `protobuf:"varint,5,opt,name=skip_if_absent,json=skipIfAbsent,proto3" json:"skip_if_absent,omitempty"`
	// contains filtered or unexported fields
}

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

.. code-block:: cpp 

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

[#next-free-field: 6]

func (*RateLimit_Action_MetaData) Descriptor deprecated 

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

Deprecated: Use RateLimit_Action_MetaData.ProtoReflect.Descriptor instead.

func (*RateLimit_Action_MetaData) GetDefaultValue 

func (x *RateLimit_Action_MetaData) GetDefaultValue() string

func (*RateLimit_Action_MetaData) GetDescriptorKey 

func (x *RateLimit_Action_MetaData) GetDescriptorKey() string

func (*RateLimit_Action_MetaData) GetMetadataKey 

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

func (*RateLimit_Action_MetaData) GetSkipIfAbsent 

func (x *RateLimit_Action_MetaData) GetSkipIfAbsent() bool

func (*RateLimit_Action_MetaData) GetSource 

func (x *RateLimit_Action_MetaData) GetSource() RateLimit_Action_MetaData_Source

func (*RateLimit_Action_MetaData) ProtoMessage 

func (*RateLimit_Action_MetaData) ProtoMessage()

func (*RateLimit_Action_MetaData) ProtoReflect 

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

func (*RateLimit_Action_MetaData) Reset 

func (x *RateLimit_Action_MetaData) Reset()

func (*RateLimit_Action_MetaData) String 

func (x *RateLimit_Action_MetaData) String() string

type RateLimit_Action_MetaData_Source 

type RateLimit_Action_MetaData_Source int32
const (
	// Query :ref:`dynamic metadata <well_known_dynamic_metadata>`
	RateLimit_Action_MetaData_DYNAMIC RateLimit_Action_MetaData_Source = 0
	// Query :ref:`route entry metadata <envoy_v3_api_field_config.route.v3.Route.metadata>`
	RateLimit_Action_MetaData_ROUTE_ENTRY RateLimit_Action_MetaData_Source = 1
)

func (RateLimit_Action_MetaData_Source) Descriptor 

func (RateLimit_Action_MetaData_Source) Descriptor() protoreflect.EnumDescriptor

func (RateLimit_Action_MetaData_Source) Enum 

func (x RateLimit_Action_MetaData_Source) Enum() *RateLimit_Action_MetaData_Source

func (RateLimit_Action_MetaData_Source) EnumDescriptor deprecated 

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

Deprecated: Use RateLimit_Action_MetaData_Source.Descriptor instead.

func (RateLimit_Action_MetaData_Source) Number 

func (x RateLimit_Action_MetaData_Source) Number() protoreflect.EnumNumber

func (RateLimit_Action_MetaData_Source) String 

func (x RateLimit_Action_MetaData_Source) String() string

func (RateLimit_Action_MetaData_Source) Type 

func (RateLimit_Action_MetaData_Source) Type() protoreflect.EnumType

type RateLimit_Action_Metadata 

type RateLimit_Action_Metadata struct {
	// Rate limit on metadata.
	Metadata *RateLimit_Action_MetaData `protobuf:"bytes,8,opt,name=metadata,proto3,oneof"`
}

type RateLimit_Action_QueryParameterValueMatch 

type RateLimit_Action_QueryParameterValueMatch struct {

	// The key to use in the descriptor entry. Defaults to “query_match“.
	DescriptorKey string `protobuf:"bytes,4,opt,name=descriptor_key,json=descriptorKey,proto3" json:"descriptor_key,omitempty"`
	// The value to use in the descriptor entry.
	DescriptorValue string `protobuf:"bytes,1,opt,name=descriptor_value,json=descriptorValue,proto3" json:"descriptor_value,omitempty"`
	// If set to true, the action will append a descriptor entry when the
	// request matches the headers. If set to false, the action will append a
	// descriptor entry when the request does not match the headers. The
	// default value is true.
	ExpectMatch *wrapperspb.BoolValue `protobuf:"bytes,2,opt,name=expect_match,json=expectMatch,proto3" json:"expect_match,omitempty"`
	// Specifies a set of query parameters that the rate limit action should match
	// on. The action will check the request’s query parameters against all the
	// specified query parameters in the config. A match will happen if all the
	// query parameters 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).
	QueryParameters []*QueryParameterMatcher `protobuf:"bytes,3,rep,name=query_parameters,json=queryParameters,proto3" json:"query_parameters,omitempty"`
	// contains filtered or unexported fields
}

The following descriptor entry is appended to the descriptor:

.. code-block:: cpp 

("query_match", "<descriptor_value>")

func (*RateLimit_Action_QueryParameterValueMatch) Descriptor deprecated 

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

Deprecated: Use RateLimit_Action_QueryParameterValueMatch.ProtoReflect.Descriptor instead.

func (*RateLimit_Action_QueryParameterValueMatch) GetDescriptorKey 

func (x *RateLimit_Action_QueryParameterValueMatch) GetDescriptorKey() string

func (*RateLimit_Action_QueryParameterValueMatch) GetDescriptorValue 

func (x *RateLimit_Action_QueryParameterValueMatch) GetDescriptorValue() string

func (*RateLimit_Action_QueryParameterValueMatch) GetExpectMatch 

func (x *RateLimit_Action_QueryParameterValueMatch) GetExpectMatch() *wrapperspb.BoolValue

func (*RateLimit_Action_QueryParameterValueMatch) GetQueryParameters 

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

func (*RateLimit_Action_QueryParameterValueMatch) ProtoMessage 

func (*RateLimit_Action_QueryParameterValueMatch) ProtoMessage()

func (*RateLimit_Action_QueryParameterValueMatch) ProtoReflect 

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

func (*RateLimit_Action_QueryParameterValueMatch) Reset 

func (x *RateLimit_Action_QueryParameterValueMatch) Reset()

func (*RateLimit_Action_QueryParameterValueMatch) String 

func (x *RateLimit_Action_QueryParameterValueMatch) String() string

type RateLimit_Action_QueryParameterValueMatch_ 

type RateLimit_Action_QueryParameterValueMatch_ struct {
	// Rate limit on the existence of query parameters.
	QueryParameterValueMatch *RateLimit_Action_QueryParameterValueMatch `protobuf:"bytes,11,opt,name=query_parameter_value_match,json=queryParameterValueMatch,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 

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

func (*RateLimit_Action_RemoteAddress) Reset 

func (x *RateLimit_Action_RemoteAddress) Reset()

func (*RateLimit_Action_RemoteAddress) String 

func (x *RateLimit_Action_RemoteAddress) String() string

type RateLimit_Action_RemoteAddress_ 

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

type RateLimit_Action_RequestHeaders 

type RateLimit_Action_RequestHeaders struct {

	// The header name to be queried from the request headers. The header’s
	// value is used to populate the value of the descriptor entry for the
	// descriptor_key.
	HeaderName string `protobuf:"bytes,1,opt,name=header_name,json=headerName,proto3" json:"header_name,omitempty"`
	// The key to use in the descriptor entry.
	DescriptorKey string `protobuf:"bytes,2,opt,name=descriptor_key,json=descriptorKey,proto3" json:"descriptor_key,omitempty"`
	// If set to true, Envoy skips the descriptor while calling rate limiting service
	// when header is not present in the request. By default it skips calling the
	// rate limiting service if this header is not present in the request.
	SkipIfAbsent bool `protobuf:"varint,3,opt,name=skip_if_absent,json=skipIfAbsent,proto3" json:"skip_if_absent,omitempty"`
	// contains filtered or unexported fields
}

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

.. code-block:: cpp 

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

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

func (x *RateLimit_Action_RequestHeaders) GetSkipIfAbsent() bool

func (*RateLimit_Action_RequestHeaders) ProtoMessage 

func (*RateLimit_Action_RequestHeaders) ProtoMessage()

func (*RateLimit_Action_RequestHeaders) ProtoReflect 

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

func (*RateLimit_Action_RequestHeaders) Reset 

func (x *RateLimit_Action_RequestHeaders) Reset()

func (*RateLimit_Action_RequestHeaders) String 

func (x *RateLimit_Action_RequestHeaders) String() string

type RateLimit_Action_RequestHeaders_ 

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

type RateLimit_Action_SourceCluster 

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

The following descriptor entry is appended to the descriptor:

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

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

func (*RateLimit_Action_SourceCluster) Reset 

func (x *RateLimit_Action_SourceCluster) Reset()

func (*RateLimit_Action_SourceCluster) String 

func (x *RateLimit_Action_SourceCluster) String() string

type RateLimit_Action_SourceCluster_ 

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

type RateLimit_Override 

type RateLimit_Override struct {

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

func (*RateLimit_Override) Descriptor deprecated 

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

Deprecated: Use RateLimit_Override.ProtoReflect.Descriptor instead.

func (*RateLimit_Override) GetDynamicMetadata 

func (x *RateLimit_Override) GetDynamicMetadata() *RateLimit_Override_DynamicMetadata

func (*RateLimit_Override) GetOverrideSpecifier 

func (m *RateLimit_Override) GetOverrideSpecifier() isRateLimit_Override_OverrideSpecifier

func (*RateLimit_Override) ProtoMessage 

func (*RateLimit_Override) ProtoMessage()

func (*RateLimit_Override) ProtoReflect 

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

func (*RateLimit_Override) Reset 

func (x *RateLimit_Override) Reset()

func (*RateLimit_Override) String 

func (x *RateLimit_Override) String() string

type RateLimit_Override_DynamicMetadata 

type RateLimit_Override_DynamicMetadata struct {

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

Fetches the override from the dynamic metadata.

func (*RateLimit_Override_DynamicMetadata) Descriptor deprecated 

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

Deprecated: Use RateLimit_Override_DynamicMetadata.ProtoReflect.Descriptor instead.

func (*RateLimit_Override_DynamicMetadata) GetMetadataKey 

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

func (*RateLimit_Override_DynamicMetadata) ProtoMessage 

func (*RateLimit_Override_DynamicMetadata) ProtoMessage()

func (*RateLimit_Override_DynamicMetadata) ProtoReflect 

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

func (*RateLimit_Override_DynamicMetadata) Reset 

func (x *RateLimit_Override_DynamicMetadata) Reset()

func (*RateLimit_Override_DynamicMetadata) String 

func (x *RateLimit_Override_DynamicMetadata) String() string

type RateLimit_Override_DynamicMetadata_ 

type RateLimit_Override_DynamicMetadata_ struct {
	// Limit override from dynamic metadata.
	DynamicMetadata *RateLimit_Override_DynamicMetadata `protobuf:"bytes,1,opt,name=dynamic_metadata,json=dynamicMetadata,proto3,oneof"`
}

type RedirectAction 

type RedirectAction struct {

	// When the scheme redirection take place, the following rules apply:
	//  1. If the source URI scheme is “http“ and the port is explicitly
	//     set to “:80“, the port will be removed after the redirection
	//  2. If the source URI scheme is “https“ and the port is explicitly
	//     set to “:443“, the port will be removed after the redirection
	//
	// Types that are assignable to SchemeRewriteSpecifier:
	//
	//	*RedirectAction_HttpsRedirect
	//	*RedirectAction_SchemeRedirect
	SchemeRewriteSpecifier isRedirectAction_SchemeRewriteSpecifier `protobuf_oneof:"scheme_rewrite_specifier"`
	// The host portion of the URL will be swapped with this value.
	HostRedirect string `protobuf:"bytes,1,opt,name=host_redirect,json=hostRedirect,proto3" json:"host_redirect,omitempty"`
	// The port value of the URL will be swapped with this value.
	PortRedirect uint32 `protobuf:"varint,8,opt,name=port_redirect,json=portRedirect,proto3" json:"port_redirect,omitempty"`
	// Types that are assignable to PathRewriteSpecifier:
	//
	//	*RedirectAction_PathRedirect
	//	*RedirectAction_PrefixRewrite
	//	*RedirectAction_RegexRewrite
	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 `` /* 161-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: 10]

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 

func (x *RedirectAction) GetPortRedirect() uint32

func (*RedirectAction) GetPrefixRewrite 

func (x *RedirectAction) GetPrefixRewrite() string

func (*RedirectAction) GetRegexRewrite 

func (x *RedirectAction) GetRegexRewrite() *v32.RegexMatchAndSubstitute

func (*RedirectAction) GetResponseCode 

func (x *RedirectAction) GetResponseCode() RedirectAction_RedirectResponseCode

func (*RedirectAction) GetSchemeRedirect 

func (x *RedirectAction) GetSchemeRedirect() string

func (*RedirectAction) GetSchemeRewriteSpecifier 

func (m *RedirectAction) GetSchemeRewriteSpecifier() isRedirectAction_SchemeRewriteSpecifier

func (*RedirectAction) GetStripQuery 

func (x *RedirectAction) GetStripQuery() bool

func (*RedirectAction) ProtoMessage 

func (*RedirectAction) ProtoMessage()

func (*RedirectAction) ProtoReflect 

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

func (*RedirectAction) Reset 

func (x *RedirectAction) Reset()

func (*RedirectAction) String 

func (x *RedirectAction) String() string

type RedirectAction_HttpsRedirect 

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

type RedirectAction_PathRedirect 

type RedirectAction_PathRedirect struct {
	// The path portion of the URL will be swapped with this value.
	// Please note that query string in path_redirect will override the
	// request's query string and will not be stripped.
	//
	// For example, let's say we have the following routes:
	//
	//   - match: { path: "/old-path-1" }
	//     redirect: { path_redirect: "/new-path-1" }
	//   - match: { path: "/old-path-2" }
	//     redirect: { path_redirect: "/new-path-2", strip-query: "true" }
	//   - match: { path: "/old-path-3" }
	//     redirect: { path_redirect: "/new-path-3?foo=1", strip_query: "true" }
	//
	// 1. if request uri is "/old-path-1?bar=1", users will be redirected to "/new-path-1?bar=1"
	// 2. if request uri is "/old-path-2?bar=1", users will be redirected to "/new-path-2"
	// 3. if request uri is "/old-path-3?bar=1", users will be redirected to "/new-path-3?foo=1"
	PathRedirect string `protobuf:"bytes,2,opt,name=path_redirect,json=pathRedirect,proto3,oneof"`
}

type RedirectAction_PrefixRewrite 

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

type RedirectAction_RedirectResponseCode 

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

func (RedirectAction_RedirectResponseCode) Descriptor 

func (RedirectAction_RedirectResponseCode) Descriptor() protoreflect.EnumDescriptor

func (RedirectAction_RedirectResponseCode) Enum 

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 

func (x RedirectAction_RedirectResponseCode) Number() protoreflect.EnumNumber

func (RedirectAction_RedirectResponseCode) String 

func (x RedirectAction_RedirectResponseCode) String() string

func (RedirectAction_RedirectResponseCode) Type 

func (RedirectAction_RedirectResponseCode) Type() protoreflect.EnumType

type RedirectAction_RegexRewrite 

type RedirectAction_RegexRewrite struct {
	// Indicates that during redirect, 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.
	//
	// 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 *v32.RegexMatchAndSubstitute `protobuf:"bytes,9,opt,name=regex_rewrite,json=regexRewrite,proto3,oneof"`
}

type RedirectAction_SchemeRedirect 

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

type RetryPolicy 

type RetryPolicy struct {

	// Specifies the conditions under which retry takes place. These are the same
	// conditions documented for :ref:`config_http_filters_router_x-envoy-retry-on` and
	// :ref:`config_http_filters_router_x-envoy-retry-grpc-on`.
	RetryOn string `protobuf:"bytes,1,opt,name=retry_on,json=retryOn,proto3" json:"retry_on,omitempty"`
	// Specifies the allowed number of retries. This parameter is optional and
	// defaults to 1. These are the same conditions documented for
	// :ref:`config_http_filters_router_x-envoy-max-retries`.
	NumRetries *wrapperspb.UInt32Value `protobuf:"bytes,2,opt,name=num_retries,json=numRetries,proto3" json:"num_retries,omitempty"`
	// Specifies a non-zero upstream timeout per retry attempt (including the initial 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_v3_api_field_config.route.v3.RouteAction.timeout>` for the request.
	//	Consequently, when using a :ref:`5xx <config_http_filters_router_x-envoy-retry-on>` based
	//	retry policy, a request that times out will not be retried as the total timeout budget
	//	would have been exhausted.
	PerTryTimeout *durationpb.Duration `protobuf:"bytes,3,opt,name=per_try_timeout,json=perTryTimeout,proto3" json:"per_try_timeout,omitempty"`
	// Specifies an upstream idle timeout per retry attempt (including the initial attempt). This
	// parameter is optional and if absent there is no per try idle timeout. The semantics of the per
	// try idle timeout are similar to the
	// :ref:`route idle timeout <envoy_v3_api_field_config.route.v3.RouteAction.timeout>` and
	// :ref:`stream idle timeout
	// <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.stream_idle_timeout>`
	// both enforced by the HTTP connection manager. The difference is that this idle timeout
	// is enforced by the router for each individual attempt and thus after all previous filters have
	// run, as opposed to *before* all previous filters run for the other idle timeouts. This timeout
	// is useful in cases in which total request timeout is bounded by a number of retries and a
	// :ref:`per_try_timeout <envoy_v3_api_field_config.route.v3.RetryPolicy.per_try_timeout>`, but
	// there is a desire to ensure each try is making incremental progress. Note also that similar
	// to :ref:`per_try_timeout <envoy_v3_api_field_config.route.v3.RetryPolicy.per_try_timeout>`,
	// this idle timeout does not start until after both the entire request has been received by the
	// router *and* a connection pool connection has been obtained. Unlike
	// :ref:`per_try_timeout <envoy_v3_api_field_config.route.v3.RetryPolicy.per_try_timeout>`,
	// the idle timer continues once the response starts streaming back to the downstream client.
	// This ensures that response data continues to make progress without using one of the HTTP
	// connection manager idle timeouts.
	PerTryIdleTimeout *durationpb.Duration `protobuf:"bytes,13,opt,name=per_try_idle_timeout,json=perTryIdleTimeout,proto3" json:"per_try_idle_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"`
	// Retry options predicates that will be applied prior to retrying a request. These predicates
	// allow customizing request behavior between retries.
	// [#comment: add [#extension-category: envoy.retry_options_predicates] when there are built-in extensions]
	RetryOptionsPredicates []*v31.TypedExtensionConfig `` /* 130-byte string literal not displayed */
	// 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 exponential 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"`
	// Specifies parameters that control a retry back-off strategy that is used
	// when the request is rate limited by the upstream server. The server may
	// return a response header like “Retry-After“ or “X-RateLimit-Reset“ to
	// provide feedback to the client on how long to wait before retrying. If
	// configured, this back-off strategy will be used instead of the
	// default exponential back off strategy (configured using “retry_back_off“)
	// whenever a response includes the matching headers.
	RateLimitedRetryBackOff *RetryPolicy_RateLimitedRetryBackOff `` /* 137-byte string literal not displayed */
	// 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: 14]

func (*RetryPolicy) Descriptor deprecated 

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

Deprecated: Use RetryPolicy.ProtoReflect.Descriptor instead.

func (*RetryPolicy) GetHostSelectionRetryMaxAttempts 

func (x *RetryPolicy) GetHostSelectionRetryMaxAttempts() int64

func (*RetryPolicy) GetNumRetries 

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

func (*RetryPolicy) GetPerTryIdleTimeout 

func (x *RetryPolicy) GetPerTryIdleTimeout() *durationpb.Duration

func (*RetryPolicy) GetPerTryTimeout 

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

func (*RetryPolicy) GetRateLimitedRetryBackOff 

func (x *RetryPolicy) GetRateLimitedRetryBackOff() *RetryPolicy_RateLimitedRetryBackOff

func (*RetryPolicy) GetRetriableHeaders 

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

func (*RetryPolicy) GetRetriableRequestHeaders 

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

func (*RetryPolicy) GetRetriableStatusCodes 

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

func (*RetryPolicy) GetRetryBackOff 

func (x *RetryPolicy) GetRetryBackOff() *RetryPolicy_RetryBackOff

func (*RetryPolicy) GetRetryHostPredicate 

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

func (*RetryPolicy) GetRetryOn 

func (x *RetryPolicy) GetRetryOn() string

func (*RetryPolicy) GetRetryOptionsPredicates 

func (x *RetryPolicy) GetRetryOptionsPredicates() []*v31.TypedExtensionConfig

func (*RetryPolicy) GetRetryPriority 

func (x *RetryPolicy) GetRetryPriority() *RetryPolicy_RetryPriority

func (*RetryPolicy) ProtoMessage 

func (*RetryPolicy) ProtoMessage()

func (*RetryPolicy) ProtoReflect 

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

func (*RetryPolicy) Reset 

func (x *RetryPolicy) Reset()

func (*RetryPolicy) String 

func (x *RetryPolicy) String() string

type RetryPolicy_RateLimitedRetryBackOff 

type RetryPolicy_RateLimitedRetryBackOff struct {

	// Specifies the reset headers (like “Retry-After“ or “X-RateLimit-Reset“)
	// to match against the response. Headers are tried in order, and matched case
	// insensitive. The first header to be parsed successfully is used. If no headers
	// match the default exponential back-off is used instead.
	ResetHeaders []*RetryPolicy_ResetHeader `protobuf:"bytes,1,rep,name=reset_headers,json=resetHeaders,proto3" json:"reset_headers,omitempty"`
	// Specifies the maximum back off interval that Envoy will allow. If a reset
	// header contains an interval longer than this then it will be discarded and
	// the next header will be tried. Defaults to 300 seconds.
	MaxInterval *durationpb.Duration `protobuf:"bytes,2,opt,name=max_interval,json=maxInterval,proto3" json:"max_interval,omitempty"`
	// contains filtered or unexported fields
}

A retry back-off strategy that applies when the upstream server rate limits the request.

Given this configuration:

.. code-block:: yaml 

rate_limited_retry_back_off:
  reset_headers:
  - name: Retry-After
    format: SECONDS
  - name: X-RateLimit-Reset
    format: UNIX_TIMESTAMP
  max_interval: "300s"

The following algorithm will apply:

  1. If the response contains the header “Retry-After“ its value must be on the form “120“ (an integer that represents the number of seconds to wait before retrying). If so, this value is used as the back-off interval.
  2. Otherwise, if the response contains the header “X-RateLimit-Reset“ its value must be on the form “1595320702“ (an integer that represents the point in time at which to retry, as a Unix timestamp in seconds). If so, the current time is subtracted from this value and the result is used as the back-off interval.
  3. Otherwise, Envoy will use the default :ref:`exponential back-off <envoy_v3_api_field_config.route.v3.RetryPolicy.retry_back_off>` strategy.

No matter which format is used, if the resulting back-off interval exceeds “max_interval“ it is discarded and the next header in “reset_headers“ is tried. If a request timeout is configured for the route it will further limit how long the request will be allowed to run.

To prevent many clients retrying at the same point in time jitter is added to the back-off interval, so the resulting interval is decided by taking: “random(interval, interval * 1.5)“.

.. attention:: 

Configuring ``rate_limited_retry_back_off`` will not by itself cause a request
to be retried. You will still need to configure the right retry policy to match
the responses from the upstream server.

func (*RetryPolicy_RateLimitedRetryBackOff) Descriptor deprecated 

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

Deprecated: Use RetryPolicy_RateLimitedRetryBackOff.ProtoReflect.Descriptor instead.

func (*RetryPolicy_RateLimitedRetryBackOff) GetMaxInterval 

func (x *RetryPolicy_RateLimitedRetryBackOff) GetMaxInterval() *durationpb.Duration

func (*RetryPolicy_RateLimitedRetryBackOff) GetResetHeaders 

func (x *RetryPolicy_RateLimitedRetryBackOff) GetResetHeaders() []*RetryPolicy_ResetHeader

func (*RetryPolicy_RateLimitedRetryBackOff) ProtoMessage 

func (*RetryPolicy_RateLimitedRetryBackOff) ProtoMessage()

func (*RetryPolicy_RateLimitedRetryBackOff) ProtoReflect 

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

func (*RetryPolicy_RateLimitedRetryBackOff) Reset 

func (x *RetryPolicy_RateLimitedRetryBackOff) Reset()

func (*RetryPolicy_RateLimitedRetryBackOff) String 

func (x *RetryPolicy_RateLimitedRetryBackOff) String() string

type RetryPolicy_ResetHeader 

type RetryPolicy_ResetHeader struct {

	// The name of the reset header.
	//
	// .. note::
	//
	//	If the header appears multiple times only the first value is used.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The format of the reset header.
	Format RetryPolicy_ResetHeaderFormat `protobuf:"varint,2,opt,name=format,proto3,enum=envoy.config.route.v3.RetryPolicy_ResetHeaderFormat" json:"format,omitempty"`
	// contains filtered or unexported fields
}

func (*RetryPolicy_ResetHeader) Descriptor deprecated 

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

Deprecated: Use RetryPolicy_ResetHeader.ProtoReflect.Descriptor instead.

func (*RetryPolicy_ResetHeader) GetFormat 

func (x *RetryPolicy_ResetHeader) GetFormat() RetryPolicy_ResetHeaderFormat

func (*RetryPolicy_ResetHeader) GetName 

func (x *RetryPolicy_ResetHeader) GetName() string

func (*RetryPolicy_ResetHeader) ProtoMessage 

func (*RetryPolicy_ResetHeader) ProtoMessage()

func (*RetryPolicy_ResetHeader) ProtoReflect 

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

func (*RetryPolicy_ResetHeader) Reset 

func (x *RetryPolicy_ResetHeader) Reset()

func (*RetryPolicy_ResetHeader) String 

func (x *RetryPolicy_ResetHeader) String() string

type RetryPolicy_ResetHeaderFormat 

type RetryPolicy_ResetHeaderFormat int32
const (
	RetryPolicy_SECONDS        RetryPolicy_ResetHeaderFormat = 0
	RetryPolicy_UNIX_TIMESTAMP RetryPolicy_ResetHeaderFormat = 1
)

func (RetryPolicy_ResetHeaderFormat) Descriptor 

func (RetryPolicy_ResetHeaderFormat) Descriptor() protoreflect.EnumDescriptor

func (RetryPolicy_ResetHeaderFormat) Enum 

func (x RetryPolicy_ResetHeaderFormat) Enum() *RetryPolicy_ResetHeaderFormat

func (RetryPolicy_ResetHeaderFormat) EnumDescriptor deprecated 

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

Deprecated: Use RetryPolicy_ResetHeaderFormat.Descriptor instead.

func (RetryPolicy_ResetHeaderFormat) Number 

func (x RetryPolicy_ResetHeaderFormat) Number() protoreflect.EnumNumber

func (RetryPolicy_ResetHeaderFormat) String 

func (x RetryPolicy_ResetHeaderFormat) String() string

func (RetryPolicy_ResetHeaderFormat) Type 

func (RetryPolicy_ResetHeaderFormat) Type() protoreflect.EnumType

type RetryPolicy_RetryBackOff 

type RetryPolicy_RetryBackOff struct {

	// Specifies the base interval between retries. This parameter is required and must be greater
	// than zero. Values less than 1 ms are rounded up to 1 ms.
	// See :ref:`config_http_filters_router_x-envoy-max-retries` for a discussion of Envoy's
	// back-off algorithm.
	BaseInterval *durationpb.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 *durationpb.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 

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

Deprecated: Use RetryPolicy_RetryBackOff.ProtoReflect.Descriptor instead.

func (*RetryPolicy_RetryBackOff) GetBaseInterval 

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

func (*RetryPolicy_RetryBackOff) GetMaxInterval 

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

func (*RetryPolicy_RetryBackOff) ProtoMessage 

func (*RetryPolicy_RetryBackOff) ProtoMessage()

func (*RetryPolicy_RetryBackOff) ProtoReflect 

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

func (*RetryPolicy_RetryBackOff) Reset 

func (x *RetryPolicy_RetryBackOff) Reset()

func (*RetryPolicy_RetryBackOff) String 

func (x *RetryPolicy_RetryBackOff) String() string

type RetryPolicy_RetryHostPredicate 

type RetryPolicy_RetryHostPredicate struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// [#extension-category: envoy.retry_host_predicates]
	//
	// Types that are assignable to ConfigType:
	//
	//	*RetryPolicy_RetryHostPredicate_TypedConfig
	ConfigType isRetryPolicy_RetryHostPredicate_ConfigType `protobuf_oneof:"config_type"`
	// contains filtered or unexported fields
}

func (*RetryPolicy_RetryHostPredicate) Descriptor deprecated 

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

Deprecated: Use RetryPolicy_RetryHostPredicate.ProtoReflect.Descriptor instead.

func (*RetryPolicy_RetryHostPredicate) GetConfigType 

func (m *RetryPolicy_RetryHostPredicate) GetConfigType() isRetryPolicy_RetryHostPredicate_ConfigType

func (*RetryPolicy_RetryHostPredicate) GetName 

func (x *RetryPolicy_RetryHostPredicate) GetName() string

func (*RetryPolicy_RetryHostPredicate) GetTypedConfig 

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

func (*RetryPolicy_RetryHostPredicate) ProtoMessage 

func (*RetryPolicy_RetryHostPredicate) ProtoMessage()

func (*RetryPolicy_RetryHostPredicate) ProtoReflect 

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

func (*RetryPolicy_RetryHostPredicate) Reset 

func (x *RetryPolicy_RetryHostPredicate) Reset()

func (*RetryPolicy_RetryHostPredicate) String 

func (x *RetryPolicy_RetryHostPredicate) String() string

type RetryPolicy_RetryHostPredicate_TypedConfig 

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

type RetryPolicy_RetryPriority 

type RetryPolicy_RetryPriority struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// [#extension-category: envoy.retry_priorities]
	//
	// Types that are assignable to ConfigType:
	//
	//	*RetryPolicy_RetryPriority_TypedConfig
	ConfigType isRetryPolicy_RetryPriority_ConfigType `protobuf_oneof:"config_type"`
	// contains filtered or unexported fields
}

func (*RetryPolicy_RetryPriority) Descriptor deprecated 

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

Deprecated: Use RetryPolicy_RetryPriority.ProtoReflect.Descriptor instead.

func (*RetryPolicy_RetryPriority) GetConfigType 

func (m *RetryPolicy_RetryPriority) GetConfigType() isRetryPolicy_RetryPriority_ConfigType

func (*RetryPolicy_RetryPriority) GetName 

func (x *RetryPolicy_RetryPriority) GetName() string

func (*RetryPolicy_RetryPriority) GetTypedConfig 

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

func (*RetryPolicy_RetryPriority) ProtoMessage 

func (*RetryPolicy_RetryPriority) ProtoMessage()

func (*RetryPolicy_RetryPriority) ProtoReflect 

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

func (*RetryPolicy_RetryPriority) Reset 

func (x *RetryPolicy_RetryPriority) Reset()

func (*RetryPolicy_RetryPriority) String 

func (x *RetryPolicy_RetryPriority) String() string

type RetryPolicy_RetryPriority_TypedConfig 

type RetryPolicy_RetryPriority_TypedConfig struct {
	TypedConfig *anypb.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
	//	*Route_NonForwardingAction
	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 *v31.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 :ref:`filter config name
	// <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpFilter.name>`.
	// The canonical filter name (e.g., “envoy.filters.http.buffer“ for the HTTP buffer filter) can also
	// be used for the backwards compatibility. If there is no entry referred by the filter config name, the
	// entry referred by the canonical filter name will be provided to the filters as fallback.
	//
	// Use of this field is filter specific;
	// see the :ref:`HTTP filter documentation <config_http_filters>` for if and how it is utilized.
	// [#comment: An entry's value may be wrapped in a
	// :ref:`FilterConfig<envoy_v3_api_msg_config.route.v3.FilterConfig>`
	// message to specify additional options.]
	TypedPerFilterConfig map[string]*anypb.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_v3_api_msg_config.route.v3.VirtualHost` and
	// :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. For more information, including details on
	// header value syntax, see the documentation on :ref:`custom request headers
	// <config_http_conn_man_headers_custom_request_headers>`.
	RequestHeadersToAdd []*v31.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_v3_api_msg_config.route.v3.VirtualHost` and
	// :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. For more information, including
	// details on header value syntax, see the documentation on
	// :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
	ResponseHeadersToAdd []*v31.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 *wrapperspb.UInt32Value `` /* 146-byte string literal not displayed */
	// The human readable prefix to use when emitting statistics for this endpoint.
	// The statistics are rooted at vhost.<virtual host name>.route.<stat_prefix>.
	// This should be set for highly critical
	// endpoints that one wishes to get “per-route” statistics on.
	// If not set, endpoint statistics are not generated.
	//
	// The emitted statistics are the same as those documented for :ref:`virtual clusters <config_http_filters_router_vcluster_stats>`.
	//
	// .. warning::
	//
	//	We do not recommend setting up a stat prefix for
	//	every application endpoint. This is both not easily maintainable and
	//	statistics use a non-trivial amount of memory(approximately 1KiB per route).
	StatPrefix string `protobuf:"bytes,19,opt,name=stat_prefix,json=statPrefix,proto3" json:"stat_prefix,omitempty"`
	// contains filtered or unexported fields
}

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

.. attention:: 

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

[#next-free-field: 20]

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 

func (x *Route) GetFilterAction() *FilterAction

func (*Route) GetMatch 

func (x *Route) GetMatch() *RouteMatch

func (*Route) GetMetadata 

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

func (*Route) GetName 

func (x *Route) GetName() string

func (*Route) GetNonForwardingAction 

func (x *Route) GetNonForwardingAction() *NonForwardingAction

func (*Route) GetPerRequestBufferLimitBytes 

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

func (*Route) GetRedirect 

func (x *Route) GetRedirect() *RedirectAction

func (*Route) GetRequestHeadersToAdd 

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

func (*Route) GetRequestHeadersToRemove 

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

func (*Route) GetResponseHeadersToAdd 

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

func (*Route) GetResponseHeadersToRemove 

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

func (*Route) GetRoute 

func (x *Route) GetRoute() *RouteAction

func (*Route) GetStatPrefix 

func (x *Route) GetStatPrefix() string

func (*Route) GetTracing 

func (x *Route) GetTracing() *Tracing

func (*Route) GetTypedPerFilterConfig 

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

func (*Route) ProtoMessage 

func (*Route) ProtoMessage()

func (*Route) ProtoReflect 

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

func (*Route) Reset 

func (x *Route) Reset()

func (*Route) String 

func (x *Route) String() string

type RouteAction 

type RouteAction struct {

	// Types that are assignable to ClusterSpecifier:
	//
	//	*RouteAction_Cluster
	//	*RouteAction_ClusterHeader
	//	*RouteAction_WeightedClusters
	//	*RouteAction_ClusterSpecifierPlugin
	//	*RouteAction_InlineClusterSpecifierPlugin
	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 `` /* 217-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_v3_api_field_config.route.v3.RouteAction.weighted_clusters>`, metadata will be merged, with values
	// provided there taking precedence. The filter name should be specified as “envoy.lb“.
	MetadataMatch *v31.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 :ref:`regex_rewrite <envoy_v3_api_field_config.route.v3.RouteAction.regex_rewrite>`
	// :ref:`path_rewrite_policy <envoy_v3_api_field_config.route.v3.RouteAction.path_rewrite_policy>`,
	// or :ref:`prefix_rewrite <envoy_v3_api_field_config.route.v3.RouteAction.prefix_rewrite>` may be specified.
	//
	// .. attention::
	//
	//	Pay careful attention to the use of trailing slashes in the
	//	:ref:`route's match <envoy_v3_api_field_config.route.v3.Route.match>` prefix value.
	//	Stripping a prefix from a path requires multiple Routes to handle all cases. For example,
	//	rewriting “/prefix“ to “/“ and “/prefix/etc“ to “/etc“ cannot be done in a single
	//	:ref:`Route <envoy_v3_api_msg_config.route.v3.Route>`, as shown by the below config entries:
	//
	//	.. code-block:: yaml
	//
	//	  - match:
	//	      prefix: "/prefix/"
	//	    route:
	//	      prefix_rewrite: "/"
	//	  - match:
	//	      prefix: "/prefix"
	//	    route:
	//	      prefix_rewrite: "/"
	//
	//	Having above entries in the config, requests to “/prefix“ will be stripped to “/“, while
	//	requests to “/prefix/etc“ will be stripped to “/etc“.
	PrefixRewrite string `protobuf:"bytes,5,opt,name=prefix_rewrite,json=prefixRewrite,proto3" json:"prefix_rewrite,omitempty"`
	// Indicates that during forwarding, portions of the path that match the
	// pattern should be rewritten, even allowing the substitution of capture
	// groups from the pattern into the new path as specified by the rewrite
	// substitution string. This is useful to allow application paths to be
	// rewritten in a way that is aware of segments with variable content like
	// identifiers. The router filter will place the original path as it was
	// before the rewrite into the :ref:`x-envoy-original-path
	// <config_http_filters_router_x-envoy-original-path>` header.
	//
	// Only one of :ref:`regex_rewrite <envoy_v3_api_field_config.route.v3.RouteAction.regex_rewrite>`,
	// :ref:`prefix_rewrite <envoy_v3_api_field_config.route.v3.RouteAction.prefix_rewrite>`, or
	// :ref:`path_rewrite_policy <envoy_v3_api_field_config.route.v3.RouteAction.path_rewrite_policy>`]
	// 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 *v32.RegexMatchAndSubstitute `protobuf:"bytes,32,opt,name=regex_rewrite,json=regexRewrite,proto3" json:"regex_rewrite,omitempty"`
	// [#extension-category: envoy.path.rewrite]
	PathRewritePolicy *v31.TypedExtensionConfig `protobuf:"bytes,41,opt,name=path_rewrite_policy,json=pathRewritePolicy,proto3" json:"path_rewrite_policy,omitempty"`
	// Types that are assignable to HostRewriteSpecifier:
	//
	//	*RouteAction_HostRewriteLiteral
	//	*RouteAction_AutoHostRewrite
	//	*RouteAction_HostRewriteHeader
	//	*RouteAction_HostRewritePathRegex
	HostRewriteSpecifier isRouteAction_HostRewriteSpecifier `protobuf_oneof:"host_rewrite_specifier"`
	// If set, then a host rewrite action (one of
	// :ref:`host_rewrite_literal <envoy_v3_api_field_config.route.v3.RouteAction.host_rewrite_literal>`,
	// :ref:`auto_host_rewrite <envoy_v3_api_field_config.route.v3.RouteAction.auto_host_rewrite>`,
	// :ref:`host_rewrite_header <envoy_v3_api_field_config.route.v3.RouteAction.host_rewrite_header>`, or
	// :ref:`host_rewrite_path_regex <envoy_v3_api_field_config.route.v3.RouteAction.host_rewrite_path_regex>`)
	// causes the original value of the host header, if any, to be appended to the
	// :ref:`config_http_conn_man_headers_x-forwarded-host` HTTP header if it is different to the last value appended.
	// This can be disabled by setting the runtime guard `envoy_reloadable_features_append_xfh_idempotent` to false.
	AppendXForwardedHost bool `` /* 127-byte string literal not displayed */
	// 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 *durationpb.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_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.stream_idle_timeout>`
	// will still apply. A value of 0 will completely disable the route's idle timeout, even if a
	// connection manager stream idle timeout is configured.
	//
	// The idle timeout is distinct to :ref:`timeout
	// <envoy_v3_api_field_config.route.v3.RouteAction.timeout>`, which provides an upper bound
	// on the upstream response time; :ref:`idle_timeout
	// <envoy_v3_api_field_config.route.v3.RouteAction.idle_timeout>` instead bounds the amount
	// of time the request's stream may be idle.
	//
	// After header decoding, the idle timeout will apply on downstream and
	// upstream request events. Each time an encode/decode event for headers or
	// data is processed for the stream, the timer will be reset. If the timeout
	// fires, the stream is terminated with a 408 Request Timeout error code if no
	// upstream response header has been received, otherwise a stream reset
	// occurs.
	//
	// If the :ref:`overload action <config_overload_manager_overload_actions>` "envoy.overload_actions.reduce_timeouts"
	// is configured, this timeout is scaled according to the value for
	// :ref:`HTTP_DOWNSTREAM_STREAM_IDLE <envoy_v3_api_enum_value_config.overload.v3.ScaleTimersOverloadActionConfig.TimerType.HTTP_DOWNSTREAM_STREAM_IDLE>`.
	IdleTimeout *durationpb.Duration `protobuf:"bytes,24,opt,name=idle_timeout,json=idleTimeout,proto3" json:"idle_timeout,omitempty"`
	// Specifies how to send request over TLS early data.
	// If absent, allows `safe HTTP requests <https://www.rfc-editor.org/rfc/rfc7231#section-4.2.1>`_ to be sent on early data.
	// [#extension-category: envoy.route.early_data_policy]
	EarlyDataPolicy *v31.TypedExtensionConfig `protobuf:"bytes,40,opt,name=early_data_policy,json=earlyDataPolicy,proto3" json:"early_data_policy,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_v3_api_field_config.route.v3.VirtualHost.retry_policy>`
	// should not be set if this field is used.
	RetryPolicyTypedConfig *anypb.Any `` /* 132-byte string literal not displayed */
	// Specify a set of route request mirroring policies.
	// It takes precedence over the virtual host and route config mirror policy entirely.
	// That is, policies are not merged, the most specific non-empty one becomes the mirror policies.
	RequestMirrorPolicies []*RouteAction_RequestMirrorPolicy `` /* 127-byte string literal not displayed */
	// Optionally specifies the :ref:`routing priority <arch_overview_http_routing_priority>`.
	Priority v31.RoutingPriority `protobuf:"varint,11,opt,name=priority,proto3,enum=envoy.config.core.v3.RoutingPriority" json:"priority,omitempty"`
	// Specifies a set of rate limit configurations that could be applied to the
	// route.
	RateLimits []*RateLimit `protobuf:"bytes,13,rep,name=rate_limits,json=rateLimits,proto3" json:"rate_limits,omitempty"`
	// Specifies if the rate limit filter should include the virtual host rate
	// limits. By default, if the route configured rate limits, the virtual host
	// :ref:`rate_limits <envoy_v3_api_field_config.route.v3.VirtualHost.rate_limits>` are not applied to the
	// request.
	//
	// This field is deprecated. Please use :ref:`vh_rate_limits <envoy_v3_api_field_extensions.filters.http.ratelimit.v3.RateLimitPerRoute.vh_rate_limits>`
	//
	// Deprecated: Marked as deprecated in envoy/config/route/v3/route_components.proto.
	IncludeVhRateLimits *wrapperspb.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. This field is ignored if related cors policy is
	// found in the :ref:`Route.typed_per_filter_config<envoy_v3_api_field_config.route.v3.Route.typed_per_filter_config>` or
	// :ref:`WeightedCluster.ClusterWeight.typed_per_filter_config<envoy_v3_api_field_config.route.v3.WeightedCluster.ClusterWeight.typed_per_filter_config>`.
	//
	// .. attention::
	//
	//	This option has been deprecated. Please use
	//	:ref:`Route.typed_per_filter_config<envoy_v3_api_field_config.route.v3.Route.typed_per_filter_config>` or
	//	:ref:`WeightedCluster.ClusterWeight.typed_per_filter_config<envoy_v3_api_field_config.route.v3.WeightedCluster.ClusterWeight.typed_per_filter_config>`
	//	to configure the CORS HTTP filter.
	//
	// Deprecated: Marked as deprecated in envoy/config/route/v3/route_components.proto.
	Cors *CorsPolicy `protobuf:"bytes,17,opt,name=cors,proto3" json:"cors,omitempty"`
	// Deprecated by :ref:`grpc_timeout_header_max <envoy_v3_api_field_config.route.v3.RouteAction.MaxStreamDuration.grpc_timeout_header_max>`
	// 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_v3_api_field_config.route.v3.RouteAction.timeout>`, but limit the applied timeout
	// to the maximum value specified here. If configured as 0, the maximum allowed timeout for
	// gRPC requests is infinity. If not configured at all, the “grpc-timeout“ header is not used
	// and gRPC requests time out like any other requests using
	// :ref:`timeout <envoy_v3_api_field_config.route.v3.RouteAction.timeout>` or its default.
	// This can be used to prevent unexpected upstream request timeouts due to potentially long
	// time gaps between gRPC request and response in gRPC streaming mode.
	//
	// .. note::
	//
	//	If a timeout is specified using :ref:`config_http_filters_router_x-envoy-upstream-rq-timeout-ms`, it takes
	//	precedence over `grpc-timeout header <https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md>`_, when
	//	both are present. See also
	//	:ref:`config_http_filters_router_x-envoy-upstream-rq-timeout-ms`,
	//	:ref:`config_http_filters_router_x-envoy-upstream-rq-per-try-timeout-ms`, and the
	//	:ref:`retry overview <arch_overview_http_routing_retry>`.
	//
	// Deprecated: Marked as deprecated in envoy/config/route/v3/route_components.proto.
	MaxGrpcTimeout *durationpb.Duration `protobuf:"bytes,23,opt,name=max_grpc_timeout,json=maxGrpcTimeout,proto3" json:"max_grpc_timeout,omitempty"`
	// Deprecated by :ref:`grpc_timeout_header_offset <envoy_v3_api_field_config.route.v3.RouteAction.MaxStreamDuration.grpc_timeout_header_offset>`.
	// 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).
	//
	// Deprecated: Marked as deprecated in envoy/config/route/v3/route_components.proto.
	GrpcTimeoutOffset *durationpb.Duration         `protobuf:"bytes,28,opt,name=grpc_timeout_offset,json=grpcTimeoutOffset,proto3" json:"grpc_timeout_offset,omitempty"`
	UpgradeConfigs    []*RouteAction_UpgradeConfig `protobuf:"bytes,25,rep,name=upgrade_configs,json=upgradeConfigs,proto3" json:"upgrade_configs,omitempty"`
	// If present, Envoy will try to follow an upstream redirect response instead of proxying the
	// response back to the downstream. An upstream redirect response is defined
	// by :ref:`redirect_response_codes
	// <envoy_v3_api_field_config.route.v3.InternalRedirectPolicy.redirect_response_codes>`.
	InternalRedirectPolicy *InternalRedirectPolicy `` /* 130-byte string literal not displayed */
	// Deprecated: Marked as deprecated in envoy/config/route/v3/route_components.proto.
	InternalRedirectAction RouteAction_InternalRedirectAction `` /* 193-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_v3_api_field_config.route.v3.RouteAction.internal_redirect_action>`
	// is set to :ref:`HANDLE_INTERNAL_REDIRECT
	// <envoy_v3_api_enum_value_config.route.v3.RouteAction.InternalRedirectAction.HANDLE_INTERNAL_REDIRECT>`
	// In the case where a downstream request is bounced among multiple routes by internal redirect,
	// the first route that hits this threshold, or has
	// :ref:`internal_redirect_action <envoy_v3_api_field_config.route.v3.RouteAction.internal_redirect_action>`
	// set to
	// :ref:`PASS_THROUGH_INTERNAL_REDIRECT
	// <envoy_v3_api_enum_value_config.route.v3.RouteAction.InternalRedirectAction.PASS_THROUGH_INTERNAL_REDIRECT>`
	// will pass the redirect back to downstream.
	//
	// If not specified, at most one redirect will be followed.
	//
	// Deprecated: Marked as deprecated in envoy/config/route/v3/route_components.proto.
	MaxInternalRedirects *wrapperspb.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"`
	// Specifies the maximum stream duration for this route.
	MaxStreamDuration *RouteAction_MaxStreamDuration `protobuf:"bytes,36,opt,name=max_stream_duration,json=maxStreamDuration,proto3" json:"max_stream_duration,omitempty"`
	// contains filtered or unexported fields
}

[#next-free-field: 42]

func (*RouteAction) Descriptor deprecated 

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

Deprecated: Use RouteAction.ProtoReflect.Descriptor instead.

func (*RouteAction) GetAppendXForwardedHost 

func (x *RouteAction) GetAppendXForwardedHost() bool

func (*RouteAction) GetAutoHostRewrite 

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

func (*RouteAction) GetCluster 

func (x *RouteAction) GetCluster() string

func (*RouteAction) GetClusterHeader 

func (x *RouteAction) GetClusterHeader() string

func (*RouteAction) GetClusterNotFoundResponseCode 

func (x *RouteAction) GetClusterNotFoundResponseCode() RouteAction_ClusterNotFoundResponseCode

func (*RouteAction) GetClusterSpecifier 

func (m *RouteAction) GetClusterSpecifier() isRouteAction_ClusterSpecifier

func (*RouteAction) GetClusterSpecifierPlugin 

func (x *RouteAction) GetClusterSpecifierPlugin() string

func (*RouteAction) GetCors deprecated 

func (x *RouteAction) GetCors() *CorsPolicy

Deprecated: Marked as deprecated in envoy/config/route/v3/route_components.proto.

func (*RouteAction) GetEarlyDataPolicy 

func (x *RouteAction) GetEarlyDataPolicy() *v31.TypedExtensionConfig

func (*RouteAction) GetGrpcTimeoutOffset deprecated 

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

Deprecated: Marked as deprecated in envoy/config/route/v3/route_components.proto.

func (*RouteAction) GetHashPolicy 

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

func (*RouteAction) GetHedgePolicy 

func (x *RouteAction) GetHedgePolicy() *HedgePolicy

func (*RouteAction) GetHostRewriteHeader 

func (x *RouteAction) GetHostRewriteHeader() string

func (*RouteAction) GetHostRewriteLiteral 

func (x *RouteAction) GetHostRewriteLiteral() string

func (*RouteAction) GetHostRewritePathRegex 

func (x *RouteAction) GetHostRewritePathRegex() *v32.RegexMatchAndSubstitute

func (*RouteAction) GetHostRewriteSpecifier 

func (m *RouteAction) GetHostRewriteSpecifier() isRouteAction_HostRewriteSpecifier

func (*RouteAction) GetIdleTimeout 

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

func (*RouteAction) GetIncludeVhRateLimits deprecated 

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

Deprecated: Marked as deprecated in envoy/config/route/v3/route_components.proto.

func (*RouteAction) GetInlineClusterSpecifierPlugin 

func (x *RouteAction) GetInlineClusterSpecifierPlugin() *ClusterSpecifierPlugin

func (*RouteAction) GetInternalRedirectAction deprecated 

func (x *RouteAction) GetInternalRedirectAction() RouteAction_InternalRedirectAction

Deprecated: Marked as deprecated in envoy/config/route/v3/route_components.proto.

func (*RouteAction) GetInternalRedirectPolicy 

func (x *RouteAction) GetInternalRedirectPolicy() *InternalRedirectPolicy

func (*RouteAction) GetMaxGrpcTimeout deprecated 

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

Deprecated: Marked as deprecated in envoy/config/route/v3/route_components.proto.

func (*RouteAction) GetMaxInternalRedirects deprecated 

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

Deprecated: Marked as deprecated in envoy/config/route/v3/route_components.proto.

func (*RouteAction) GetMaxStreamDuration 

func (x *RouteAction) GetMaxStreamDuration() *RouteAction_MaxStreamDuration

func (*RouteAction) GetMetadataMatch 

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

func (*RouteAction) GetPathRewritePolicy 

func (x *RouteAction) GetPathRewritePolicy() *v31.TypedExtensionConfig

func (*RouteAction) GetPrefixRewrite 

func (x *RouteAction) GetPrefixRewrite() string

func (*RouteAction) GetPriority 

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

func (*RouteAction) GetRateLimits 

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

func (*RouteAction) GetRegexRewrite 

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

func (*RouteAction) GetRequestMirrorPolicies 

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

func (*RouteAction) GetRetryPolicy 

func (x *RouteAction) GetRetryPolicy() *RetryPolicy

func (*RouteAction) GetRetryPolicyTypedConfig 

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

func (*RouteAction) GetTimeout 

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

func (*RouteAction) GetUpgradeConfigs 

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

func (*RouteAction) GetWeightedClusters 

func (x *RouteAction) GetWeightedClusters() *WeightedCluster

func (*RouteAction) ProtoMessage 

func (*RouteAction) ProtoMessage()

func (*RouteAction) ProtoReflect 

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

func (*RouteAction) Reset 

func (x *RouteAction) Reset()

func (*RouteAction) String 

func (x *RouteAction) String() string

type RouteAction_AutoHostRewrite 

type RouteAction_AutoHostRewrite struct {
	// Indicates that during forwarding, the host header will be swapped with
	// the hostname of the upstream host chosen by the cluster manager. This
	// option is applicable only when the destination cluster for a route is of
	// type “strict_dns“ or “logical_dns“. Setting this to true with other cluster types
	// has no effect. Using this option will append the
	// :ref:`config_http_conn_man_headers_x-forwarded-host` header if
	// :ref:`append_x_forwarded_host <envoy_v3_api_field_config.route.v3.RouteAction.append_x_forwarded_host>`
	// is set.
	AutoHostRewrite *wrapperspb.BoolValue `protobuf:"bytes,7,opt,name=auto_host_rewrite,json=autoHostRewrite,proto3,oneof"`
}

type RouteAction_Cluster 

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

type RouteAction_ClusterHeader 

type RouteAction_ClusterHeader struct {
	// Envoy will determine the cluster to route to by reading the value of the
	// HTTP header named by cluster_header from the request headers. If the
	// header is not found or the referenced cluster does not exist, Envoy will
	// return a 404 response.
	//
	// .. attention::
	//
	//	Internally, Envoy always uses the HTTP/2 “:authority“ header to represent the HTTP/1
	//	“Host“ header. Thus, if attempting to match on “Host“, match on “:authority“ instead.
	//
	// .. 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
	// HTTP status code - 500 Internal Server Error.
	RouteAction_INTERNAL_SERVER_ERROR RouteAction_ClusterNotFoundResponseCode = 2
)

func (RouteAction_ClusterNotFoundResponseCode) Descriptor 

func (RouteAction_ClusterNotFoundResponseCode) Descriptor() protoreflect.EnumDescriptor

func (RouteAction_ClusterNotFoundResponseCode) Enum 

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 

func (x RouteAction_ClusterNotFoundResponseCode) Number() protoreflect.EnumNumber

func (RouteAction_ClusterNotFoundResponseCode) String 

func (x RouteAction_ClusterNotFoundResponseCode) String() string

func (RouteAction_ClusterNotFoundResponseCode) Type 

func (RouteAction_ClusterNotFoundResponseCode) Type() protoreflect.EnumType

type RouteAction_ClusterSpecifierPlugin 

type RouteAction_ClusterSpecifierPlugin struct {
	// Name of the cluster specifier plugin to use to determine the cluster for requests on this route.
	// The cluster specifier plugin name must be defined in the associated
	// :ref:`cluster specifier plugins <envoy_v3_api_field_config.route.v3.RouteConfiguration.cluster_specifier_plugins>`
	// in the :ref:`name <envoy_v3_api_field_config.core.v3.TypedExtensionConfig.name>` field.
	ClusterSpecifierPlugin string `protobuf:"bytes,37,opt,name=cluster_specifier_plugin,json=clusterSpecifierPlugin,proto3,oneof"`
}

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 

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 

func (x *RouteAction_HashPolicy) GetQueryParameter() *RouteAction_HashPolicy_QueryParameter

func (*RouteAction_HashPolicy) GetTerminal 

func (x *RouteAction_HashPolicy) GetTerminal() bool

func (*RouteAction_HashPolicy) ProtoMessage 

func (*RouteAction_HashPolicy) ProtoMessage()

func (*RouteAction_HashPolicy) ProtoReflect 

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

func (*RouteAction_HashPolicy) Reset 

func (x *RouteAction_HashPolicy) Reset()

func (*RouteAction_HashPolicy) String 

func (x *RouteAction_HashPolicy) String() string

type RouteAction_HashPolicy_ConnectionProperties 

type RouteAction_HashPolicy_ConnectionProperties struct {

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

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

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

func (*RouteAction_HashPolicy_ConnectionProperties) Reset 

func (x *RouteAction_HashPolicy_ConnectionProperties) Reset()

func (*RouteAction_HashPolicy_ConnectionProperties) String 

func (x *RouteAction_HashPolicy_ConnectionProperties) String() string

type RouteAction_HashPolicy_ConnectionProperties_ 

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

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

Envoy supports two types of cookie affinity:

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

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

func (*RouteAction_HashPolicy_Cookie) 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() *durationpb.Duration

func (*RouteAction_HashPolicy_Cookie) ProtoMessage 

func (*RouteAction_HashPolicy_Cookie) ProtoMessage()

func (*RouteAction_HashPolicy_Cookie) ProtoReflect 

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

func (*RouteAction_HashPolicy_Cookie) Reset 

func (x *RouteAction_HashPolicy_Cookie) Reset()

func (*RouteAction_HashPolicy_Cookie) String 

func (x *RouteAction_HashPolicy_Cookie) String() string

type RouteAction_HashPolicy_Cookie_ 

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

type RouteAction_HashPolicy_FilterState 

type RouteAction_HashPolicy_FilterState struct {

	// The name of the Object in the per-request filterState, which is an
	// Envoy::Hashable object. If there is no data associated with the key,
	// or the stored object is not Envoy::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 

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

Deprecated: Use RouteAction_HashPolicy_FilterState.ProtoReflect.Descriptor instead.

func (*RouteAction_HashPolicy_FilterState) GetKey 

func (x *RouteAction_HashPolicy_FilterState) GetKey() string

func (*RouteAction_HashPolicy_FilterState) ProtoMessage 

func (*RouteAction_HashPolicy_FilterState) ProtoMessage()

func (*RouteAction_HashPolicy_FilterState) ProtoReflect 

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

func (*RouteAction_HashPolicy_FilterState) Reset 

func (x *RouteAction_HashPolicy_FilterState) Reset()

func (*RouteAction_HashPolicy_FilterState) String 

func (x *RouteAction_HashPolicy_FilterState) String() string

type RouteAction_HashPolicy_FilterState_ 

type RouteAction_HashPolicy_FilterState_ struct {
	// Filter state hash policy.
	FilterState *RouteAction_HashPolicy_FilterState `protobuf:"bytes,6,opt,name=filter_state,json=filterState,proto3,oneof"`
}

type RouteAction_HashPolicy_Header 

type RouteAction_HashPolicy_Header struct {

	// The name of the request header that will be used to obtain the hash
	// key. If the request header is not present, no hash will be produced.
	HeaderName string `protobuf:"bytes,1,opt,name=header_name,json=headerName,proto3" json:"header_name,omitempty"`
	// If specified, the request header value will be rewritten and used
	// to produce the hash key.
	RegexRewrite *v32.RegexMatchAndSubstitute `protobuf:"bytes,2,opt,name=regex_rewrite,json=regexRewrite,proto3" json:"regex_rewrite,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) GetRegexRewrite 

func (x *RouteAction_HashPolicy_Header) GetRegexRewrite() *v32.RegexMatchAndSubstitute

func (*RouteAction_HashPolicy_Header) ProtoMessage 

func (*RouteAction_HashPolicy_Header) ProtoMessage()

func (*RouteAction_HashPolicy_Header) ProtoReflect 

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

func (*RouteAction_HashPolicy_Header) Reset 

func (x *RouteAction_HashPolicy_Header) Reset()

func (*RouteAction_HashPolicy_Header) String 

func (x *RouteAction_HashPolicy_Header) String() string

type RouteAction_HashPolicy_Header_ 

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

type RouteAction_HashPolicy_QueryParameter 

type RouteAction_HashPolicy_QueryParameter struct {

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

func (*RouteAction_HashPolicy_QueryParameter) Descriptor deprecated 

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

Deprecated: Use RouteAction_HashPolicy_QueryParameter.ProtoReflect.Descriptor instead.

func (*RouteAction_HashPolicy_QueryParameter) GetName 

func (x *RouteAction_HashPolicy_QueryParameter) GetName() string

func (*RouteAction_HashPolicy_QueryParameter) ProtoMessage 

func (*RouteAction_HashPolicy_QueryParameter) ProtoMessage()

func (*RouteAction_HashPolicy_QueryParameter) ProtoReflect 

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

func (*RouteAction_HashPolicy_QueryParameter) Reset 

func (x *RouteAction_HashPolicy_QueryParameter) Reset()

func (*RouteAction_HashPolicy_QueryParameter) String 

func (x *RouteAction_HashPolicy_QueryParameter) String() string

type RouteAction_HashPolicy_QueryParameter_ 

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

type RouteAction_HostRewriteHeader 

type RouteAction_HostRewriteHeader struct {
	// Indicates that during forwarding, the host header will be swapped with the content of given
	// downstream or :ref:`custom <config_http_conn_man_headers_custom_request_headers>` header.
	// If header value is empty, host header is left intact. Using this option will append the
	// :ref:`config_http_conn_man_headers_x-forwarded-host` header if
	// :ref:`append_x_forwarded_host <envoy_v3_api_field_config.route.v3.RouteAction.append_x_forwarded_host>`
	// is set.
	//
	// .. 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.
	HostRewriteHeader string `protobuf:"bytes,29,opt,name=host_rewrite_header,json=hostRewriteHeader,proto3,oneof"`
}

type RouteAction_HostRewriteLiteral 

type RouteAction_HostRewriteLiteral struct {
	// Indicates that during forwarding, the host header will be swapped with
	// this value. Using this option will append the
	// :ref:`config_http_conn_man_headers_x-forwarded-host` header if
	// :ref:`append_x_forwarded_host <envoy_v3_api_field_config.route.v3.RouteAction.append_x_forwarded_host>`
	// is set.
	HostRewriteLiteral string `protobuf:"bytes,6,opt,name=host_rewrite_literal,json=hostRewriteLiteral,proto3,oneof"`
}

type RouteAction_HostRewritePathRegex 

type RouteAction_HostRewritePathRegex struct {
	// Indicates that during forwarding, the host header will be swapped with
	// the result of the regex substitution executed on path value with query and fragment removed.
	// This is useful for transitioning variable content between path segment and subdomain.
	// Using this option will append the
	// :ref:`config_http_conn_man_headers_x-forwarded-host` header if
	// :ref:`append_x_forwarded_host <envoy_v3_api_field_config.route.v3.RouteAction.append_x_forwarded_host>`
	// is set.
	//
	// For example with the following config:
	//
	//	.. code-block:: yaml
	//
	//	  host_rewrite_path_regex:
	//	    pattern:
	//	      google_re2: {}
	//	      regex: "^/(.+)/.+$"
	//	    substitution: \1
	//
	// Would rewrite the host header to “envoyproxy.io“ given the path “/envoyproxy.io/some/path“.
	HostRewritePathRegex *v32.RegexMatchAndSubstitute `protobuf:"bytes,35,opt,name=host_rewrite_path_regex,json=hostRewritePathRegex,proto3,oneof"`
}

type RouteAction_InlineClusterSpecifierPlugin 

type RouteAction_InlineClusterSpecifierPlugin struct {
	// Custom cluster specifier plugin configuration to use to determine the cluster for requests
	// on this route.
	InlineClusterSpecifierPlugin *ClusterSpecifierPlugin `protobuf:"bytes,39,opt,name=inline_cluster_specifier_plugin,json=inlineClusterSpecifierPlugin,proto3,oneof"`
}

type RouteAction_InternalRedirectAction deprecated 

type RouteAction_InternalRedirectAction int32

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

Deprecated: Marked as deprecated in envoy/config/route/v3/route_components.proto. 

const (
	RouteAction_PASS_THROUGH_INTERNAL_REDIRECT RouteAction_InternalRedirectAction = 0
	RouteAction_HANDLE_INTERNAL_REDIRECT       RouteAction_InternalRedirectAction = 1
)

func (RouteAction_InternalRedirectAction) Descriptor 

func (RouteAction_InternalRedirectAction) Descriptor() protoreflect.EnumDescriptor

func (RouteAction_InternalRedirectAction) Enum 

func (x RouteAction_InternalRedirectAction) Enum() *RouteAction_InternalRedirectAction

func (RouteAction_InternalRedirectAction) EnumDescriptor deprecated 

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

Deprecated: Use RouteAction_InternalRedirectAction.Descriptor instead.

func (RouteAction_InternalRedirectAction) Number 

func (x RouteAction_InternalRedirectAction) Number() protoreflect.EnumNumber

func (RouteAction_InternalRedirectAction) String 

func (x RouteAction_InternalRedirectAction) String() string

func (RouteAction_InternalRedirectAction) Type 

func (RouteAction_InternalRedirectAction) Type() protoreflect.EnumType

type RouteAction_MaxStreamDuration 

type RouteAction_MaxStreamDuration struct {

	// Specifies the maximum duration allowed for streams on the route. If not specified, the value
	// from the :ref:`max_stream_duration
	// <envoy_v3_api_field_config.core.v3.HttpProtocolOptions.max_stream_duration>` field in
	// :ref:`HttpConnectionManager.common_http_protocol_options
	// <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.common_http_protocol_options>`
	// is used. If this field is set explicitly to zero, any
	// HttpConnectionManager max_stream_duration timeout will be disabled for
	// this route.
	MaxStreamDuration *durationpb.Duration `protobuf:"bytes,1,opt,name=max_stream_duration,json=maxStreamDuration,proto3" json:"max_stream_duration,omitempty"`
	// If present, and the request contains a `grpc-timeout header
	// <https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md>`_, use that value as the
	// “max_stream_duration“, but limit the applied timeout to the maximum value specified here.
	// If set to 0, the “grpc-timeout“ header is used without modification.
	GrpcTimeoutHeaderMax *durationpb.Duration `protobuf:"bytes,2,opt,name=grpc_timeout_header_max,json=grpcTimeoutHeaderMax,proto3" json:"grpc_timeout_header_max,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 for 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. If, after applying the offset, the resulting timeout is zero or negative,
	// the stream will timeout immediately.
	GrpcTimeoutHeaderOffset *durationpb.Duration `` /* 134-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*RouteAction_MaxStreamDuration) Descriptor deprecated 

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

Deprecated: Use RouteAction_MaxStreamDuration.ProtoReflect.Descriptor instead.

func (*RouteAction_MaxStreamDuration) GetGrpcTimeoutHeaderMax 

func (x *RouteAction_MaxStreamDuration) GetGrpcTimeoutHeaderMax() *durationpb.Duration

func (*RouteAction_MaxStreamDuration) GetGrpcTimeoutHeaderOffset 

func (x *RouteAction_MaxStreamDuration) GetGrpcTimeoutHeaderOffset() *durationpb.Duration

func (*RouteAction_MaxStreamDuration) GetMaxStreamDuration 

func (x *RouteAction_MaxStreamDuration) GetMaxStreamDuration() *durationpb.Duration

func (*RouteAction_MaxStreamDuration) ProtoMessage 

func (*RouteAction_MaxStreamDuration) ProtoMessage()

func (*RouteAction_MaxStreamDuration) ProtoReflect 

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

func (*RouteAction_MaxStreamDuration) Reset 

func (x *RouteAction_MaxStreamDuration) Reset()

func (*RouteAction_MaxStreamDuration) String 

func (x *RouteAction_MaxStreamDuration) String() string

type RouteAction_RequestMirrorPolicy 

type RouteAction_RequestMirrorPolicy struct {

	// Only one of “cluster“ and “cluster_header“ can be specified.
	// [#next-major-version: Need to add back the validation rule: (validate.rules).string = {min_len: 1}]
	// 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"`
	// Only one of “cluster“ and “cluster_header“ can be specified.
	// Envoy will determine the cluster to route to by reading the value of the
	// HTTP header named by cluster_header from the request headers. Only the first value in header is used,
	// and no shadow request will happen if the value is not found in headers. Envoy will not wait for
	// the shadow cluster to respond before returning the response from the primary cluster.
	//
	// .. 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,5,opt,name=cluster_header,json=clusterHeader,proto3" json:"cluster_header,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 *v31.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 *wrapperspb.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.

.. note:: 

Shadowing doesn't support Http CONNECT and upgrades.

[#next-free-field: 6]

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

func (x *RouteAction_RequestMirrorPolicy) GetClusterHeader() string

func (*RouteAction_RequestMirrorPolicy) GetRuntimeFraction 

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

func (*RouteAction_RequestMirrorPolicy) GetTraceSampled 

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

func (*RouteAction_RequestMirrorPolicy) ProtoMessage 

func (*RouteAction_RequestMirrorPolicy) ProtoMessage()

func (*RouteAction_RequestMirrorPolicy) ProtoReflect 

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

func (*RouteAction_RequestMirrorPolicy) Reset 

func (x *RouteAction_RequestMirrorPolicy) Reset()

func (*RouteAction_RequestMirrorPolicy) String 

func (x *RouteAction_RequestMirrorPolicy) String() string

type RouteAction_UpgradeConfig 

type RouteAction_UpgradeConfig struct {

	// The case-insensitive name of this upgrade, e.g. "websocket".
	// For each upgrade type present in upgrade_configs, requests with
	// Upgrade: [upgrade_type] will be proxied upstream.
	UpgradeType string `protobuf:"bytes,1,opt,name=upgrade_type,json=upgradeType,proto3" json:"upgrade_type,omitempty"`
	// Determines if upgrades are available on this route. Defaults to true.
	Enabled *wrapperspb.BoolValue `protobuf:"bytes,2,opt,name=enabled,proto3" json:"enabled,omitempty"`
	// Configuration for sending data upstream as a raw data payload. This is used for
	// CONNECT requests, when forwarding CONNECT payload as raw TCP.
	// Note that CONNECT support is currently considered alpha in Envoy.
	// [#comment: TODO(htuch): Replace the above comment with an alpha tag.]
	ConnectConfig *RouteAction_UpgradeConfig_ConnectConfig `protobuf:"bytes,3,opt,name=connect_config,json=connectConfig,proto3" json:"connect_config,omitempty"`
	// contains filtered or unexported fields
}

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

func (*RouteAction_UpgradeConfig) Descriptor deprecated 

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

Deprecated: Use RouteAction_UpgradeConfig.ProtoReflect.Descriptor instead.

func (*RouteAction_UpgradeConfig) GetConnectConfig 

func (x *RouteAction_UpgradeConfig) GetConnectConfig() *RouteAction_UpgradeConfig_ConnectConfig

func (*RouteAction_UpgradeConfig) GetEnabled 

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

func (*RouteAction_UpgradeConfig) GetUpgradeType 

func (x *RouteAction_UpgradeConfig) GetUpgradeType() string

func (*RouteAction_UpgradeConfig) ProtoMessage 

func (*RouteAction_UpgradeConfig) ProtoMessage()

func (*RouteAction_UpgradeConfig) ProtoReflect 

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

func (*RouteAction_UpgradeConfig) Reset 

func (x *RouteAction_UpgradeConfig) Reset()

func (*RouteAction_UpgradeConfig) String 

func (x *RouteAction_UpgradeConfig) String() string

type RouteAction_UpgradeConfig_ConnectConfig 

type RouteAction_UpgradeConfig_ConnectConfig struct {

	// If present, the proxy protocol header will be prepended to the CONNECT payload sent upstream.
	ProxyProtocolConfig *v31.ProxyProtocolConfig `protobuf:"bytes,1,opt,name=proxy_protocol_config,json=proxyProtocolConfig,proto3" json:"proxy_protocol_config,omitempty"`
	// If set, the route will also allow forwarding POST payload as raw TCP.
	AllowPost bool `protobuf:"varint,2,opt,name=allow_post,json=allowPost,proto3" json:"allow_post,omitempty"`
	// contains filtered or unexported fields
}

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

func (*RouteAction_UpgradeConfig_ConnectConfig) Descriptor deprecated 

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

Deprecated: Use RouteAction_UpgradeConfig_ConnectConfig.ProtoReflect.Descriptor instead.

func (*RouteAction_UpgradeConfig_ConnectConfig) GetAllowPost 

func (x *RouteAction_UpgradeConfig_ConnectConfig) GetAllowPost() bool

func (*RouteAction_UpgradeConfig_ConnectConfig) GetProxyProtocolConfig 

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

func (*RouteAction_UpgradeConfig_ConnectConfig) ProtoMessage 

func (*RouteAction_UpgradeConfig_ConnectConfig) ProtoMessage()

func (*RouteAction_UpgradeConfig_ConnectConfig) ProtoReflect 

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

func (*RouteAction_UpgradeConfig_ConnectConfig) Reset 

func (x *RouteAction_UpgradeConfig_ConnectConfig) Reset()

func (*RouteAction_UpgradeConfig_ConnectConfig) String 

func (x *RouteAction_UpgradeConfig_ConnectConfig) String() string

type RouteAction_WeightedClusters 

type RouteAction_WeightedClusters struct {
	// Multiple upstream clusters can be specified for a given route. The
	// request is routed to one of the upstream clusters based on weights
	// assigned to each cluster. See
	// :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 RouteConfiguration 

type RouteConfiguration struct {

	// The name of the route configuration. For example, it might match
	// :ref:`route_config_name
	// <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.Rds.route_config_name>` in
	// :ref:`envoy_v3_api_msg_extensions.filters.network.http_connection_manager.v3.Rds`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// An array of virtual hosts that make up the route table.
	VirtualHosts []*VirtualHost `protobuf:"bytes,2,rep,name=virtual_hosts,json=virtualHosts,proto3" json:"virtual_hosts,omitempty"`
	// An array of virtual hosts will be dynamically loaded via the VHDS API.
	// Both “virtual_hosts“ and “vhds“ fields will be used when present. “virtual_hosts“ can be used
	// for a base routing table or for infrequently changing virtual hosts. “vhds“ is used for
	// on-demand discovery of virtual hosts. The contents of these two fields will be merged to
	// generate a routing table for a given RouteConfiguration, with “vhds“ derived configuration
	// taking precedence.
	Vhds *Vhds `protobuf:"bytes,9,opt,name=vhds,proto3" json:"vhds,omitempty"`
	// Optionally specifies a list of HTTP headers that the connection manager
	// will consider to be internal only. If they are found on external requests they will be cleaned
	// prior to filter invocation. See :ref:`config_http_conn_man_headers_x-envoy-internal` for more
	// information.
	InternalOnlyHeaders []string `protobuf:"bytes,3,rep,name=internal_only_headers,json=internalOnlyHeaders,proto3" json:"internal_only_headers,omitempty"`
	// Specifies a list of HTTP headers that should be added to each response that
	// the connection manager encodes. Headers specified at this level are applied
	// after headers from any enclosed :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost` or
	// :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`. For more information, including details on
	// header value syntax, see the documentation on :ref:`custom request headers
	// <config_http_conn_man_headers_custom_request_headers>`.
	ResponseHeadersToAdd []*v3.HeaderValueOption `protobuf:"bytes,4,rep,name=response_headers_to_add,json=responseHeadersToAdd,proto3" json:"response_headers_to_add,omitempty"`
	// Specifies a list of HTTP headers that should be removed from each response
	// that the connection manager encodes.
	ResponseHeadersToRemove []string `` /* 134-byte string literal not displayed */
	// Specifies a list of HTTP headers that should be added to each request
	// routed by the HTTP connection manager. Headers specified at this level are
	// applied after headers from any enclosed :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost` or
	// :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`. For more information, including details on
	// header value syntax, see the documentation on :ref:`custom request headers
	// <config_http_conn_man_headers_custom_request_headers>`.
	RequestHeadersToAdd []*v3.HeaderValueOption `protobuf:"bytes,6,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
	// routed by the HTTP connection manager.
	RequestHeadersToRemove []string `` /* 131-byte string literal not displayed */
	// By default, headers that should be added/removed are evaluated from most to least specific:
	//
	// * route level
	// * virtual host level
	// * connection manager level
	//
	// To allow setting overrides at the route or virtual host level, this order can be reversed
	// by setting this option to true. Defaults to false.
	MostSpecificHeaderMutationsWins bool `` /* 162-byte string literal not displayed */
	// An optional boolean that specifies whether the clusters that the route
	// table refers to will be validated by the cluster manager. If set to true
	// and a route refers to a non-existent cluster, the route table will not
	// load. If set to false and a route refers to a non-existent cluster, the
	// route table will load and the router filter will return a 404 if the route
	// is selected at runtime. This setting defaults to true if the route table
	// is statically defined via the :ref:`route_config
	// <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.route_config>`
	// option. This setting default to false if the route table is loaded dynamically via the
	// :ref:`rds
	// <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.rds>`
	// option. Users may wish to override the default behavior in certain cases (for example when
	// using CDS with a static route table).
	ValidateClusters *wrapperspb.BoolValue `protobuf:"bytes,7,opt,name=validate_clusters,json=validateClusters,proto3" json:"validate_clusters,omitempty"`
	// The maximum bytes of the response :ref:`direct response body
	// <envoy_v3_api_field_config.route.v3.DirectResponseAction.body>` size. If not specified the default
	// is 4096.
	//
	// .. warning::
	//
	//	Envoy currently holds the content of :ref:`direct response body
	//	<envoy_v3_api_field_config.route.v3.DirectResponseAction.body>` in memory. Be careful setting
	//	this to be larger than the default 4KB, since the allocated memory for direct response body
	//	is not subject to data plane buffering controls.
	MaxDirectResponseBodySizeBytes *wrapperspb.UInt32Value `` /* 160-byte string literal not displayed */
	// A list of plugins and their configurations which may be used by a
	// :ref:`cluster specifier plugin name <envoy_v3_api_field_config.route.v3.RouteAction.cluster_specifier_plugin>`
	// within the route. All “extension.name“ fields in this list must be unique.
	ClusterSpecifierPlugins []*ClusterSpecifierPlugin `` /* 133-byte string literal not displayed */
	// Specify a set of default request mirroring policies which apply to all routes under its virtual hosts.
	// Note that policies are not merged, the most specific non-empty one becomes the mirror policies.
	RequestMirrorPolicies []*RouteAction_RequestMirrorPolicy `` /* 127-byte string literal not displayed */
	// By default, port in :authority header (if any) is used in host matching.
	// With this option enabled, Envoy will ignore the port number in the :authority header (if any) when picking VirtualHost.
	// NOTE: this option will not strip the port number (if any) contained in route config
	// :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost`.domains field.
	IgnorePortInHostMatching bool `` /* 141-byte string literal not displayed */
	// Ignore path-parameters in path-matching.
	// Before RFC3986, URI were like(RFC1808): <scheme>://<net_loc>/<path>;<params>?<query>#<fragment>
	// Envoy by default takes ":path" as "<path>;<params>".
	// For users who want to only match path on the "<path>" portion, this option should be true.
	IgnorePathParametersInPathMatching bool `` /* 173-byte string literal not displayed */
	// The typed_per_filter_config field can be used to provide RouteConfiguration level per filter config.
	// The key should match the :ref:`filter config name
	// <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpFilter.name>`.
	// The canonical filter name (e.g., “envoy.filters.http.buffer“ for the HTTP buffer filter) can also
	// be used for the backwards compatibility. If there is no entry referred by the filter config name, the
	// entry referred by the canonical filter name will be provided to the filters as fallback.
	//
	// Use of this field is filter specific;
	// see the :ref:`HTTP filter documentation <config_http_filters>` for if and how it is utilized.
	// [#comment: An entry's value may be wrapped in a
	// :ref:`FilterConfig<envoy_v3_api_msg_config.route.v3.FilterConfig>`
	// message to specify additional options.]
	TypedPerFilterConfig map[string]*anypb.Any `` /* 214-byte string literal not displayed */
	// contains filtered or unexported fields
}

[#next-free-field: 17]

func (*RouteConfiguration) Descriptor deprecated 

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

Deprecated: Use RouteConfiguration.ProtoReflect.Descriptor instead.

func (*RouteConfiguration) GetClusterSpecifierPlugins 

func (x *RouteConfiguration) GetClusterSpecifierPlugins() []*ClusterSpecifierPlugin

func (*RouteConfiguration) GetIgnorePathParametersInPathMatching 

func (x *RouteConfiguration) GetIgnorePathParametersInPathMatching() bool

func (*RouteConfiguration) GetIgnorePortInHostMatching 

func (x *RouteConfiguration) GetIgnorePortInHostMatching() bool

func (*RouteConfiguration) GetInternalOnlyHeaders 

func (x *RouteConfiguration) GetInternalOnlyHeaders() []string

func (*RouteConfiguration) GetMaxDirectResponseBodySizeBytes 

func (x *RouteConfiguration) GetMaxDirectResponseBodySizeBytes() *wrapperspb.UInt32Value

func (*RouteConfiguration) GetMostSpecificHeaderMutationsWins 

func (x *RouteConfiguration) GetMostSpecificHeaderMutationsWins() bool

func (*RouteConfiguration) GetName 

func (x *RouteConfiguration) GetName() string

func (*RouteConfiguration) GetRequestHeadersToAdd 

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

func (*RouteConfiguration) GetRequestHeadersToRemove 

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

func (*RouteConfiguration) GetRequestMirrorPolicies 

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

func (*RouteConfiguration) GetResponseHeadersToAdd 

func (x *RouteConfiguration) GetResponseHeadersToAdd() []*v3.HeaderValueOption

func (*RouteConfiguration) GetResponseHeadersToRemove 

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

func (*RouteConfiguration) GetTypedPerFilterConfig 

func (x *RouteConfiguration) GetTypedPerFilterConfig() map[string]*anypb.Any

func (*RouteConfiguration) GetValidateClusters 

func (x *RouteConfiguration) GetValidateClusters() *wrapperspb.BoolValue

func (*RouteConfiguration) GetVhds 

func (x *RouteConfiguration) GetVhds() *Vhds

func (*RouteConfiguration) GetVirtualHosts 

func (x *RouteConfiguration) GetVirtualHosts() []*VirtualHost

func (*RouteConfiguration) ProtoMessage 

func (*RouteConfiguration) ProtoMessage()

func (*RouteConfiguration) ProtoReflect 

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

func (*RouteConfiguration) Reset 

func (x *RouteConfiguration) Reset()

func (*RouteConfiguration) String 

func (x *RouteConfiguration) String() string

type RouteList 

type RouteList struct {

	// The list of routes that will be matched and run, in order. The first route that matches will be used.
	Routes []*Route `protobuf:"bytes,1,rep,name=routes,proto3" json:"routes,omitempty"`
	// contains filtered or unexported fields
}

This can be used in route matcher :ref:`VirtualHost.matcher <envoy_v3_api_field_config.route.v3.VirtualHost.matcher>`. When the matcher matches, routes will be matched and run.

func (*RouteList) Descriptor deprecated 

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

Deprecated: Use RouteList.ProtoReflect.Descriptor instead.

func (*RouteList) GetRoutes 

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

func (*RouteList) ProtoMessage 

func (*RouteList) ProtoMessage()

func (*RouteList) ProtoReflect 

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

func (*RouteList) Reset 

func (x *RouteList) Reset()

func (*RouteList) String 

func (x *RouteList) String() string

type RouteMatch 

type RouteMatch struct {

	// Types that are assignable to PathSpecifier:
	//
	//	*RouteMatch_Prefix
	//	*RouteMatch_Path
	//	*RouteMatch_SafeRegex
	//	*RouteMatch_ConnectMatcher_
	//	*RouteMatch_PathSeparatedPrefix
	//	*RouteMatch_PathMatchPolicy
	PathSpecifier isRouteMatch_PathSpecifier `protobuf_oneof:"path_specifier"`
	// Indicates that prefix/path matching should be case sensitive. The default
	// is true. Ignored for safe_regex matching.
	CaseSensitive *wrapperspb.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 *v31.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.
	//
	// .. note::
	//
	//	If query parameters are used to pass request message fields when
	//	`grpc_json_transcoder <https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/grpc_json_transcoder_filter>`_
	//	is used, the transcoded message fields maybe different. The query parameters are
	//	url encoded, but the message fields are not. For example, if a query
	//	parameter is "foo%20bar", the message field will be "foo bar".
	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"`
	// Specifies a set of dynamic metadata matchers on which the route should match.
	// The router will check the dynamic metadata against all the specified dynamic metadata matchers.
	// If the number of specified dynamic metadata matchers is nonzero, they all must match the
	// dynamic metadata for a match to occur.
	DynamicMetadata []*v32.MetadataMatcher `protobuf:"bytes,13,rep,name=dynamic_metadata,json=dynamicMetadata,proto3" json:"dynamic_metadata,omitempty"`
	// contains filtered or unexported fields
}

[#next-free-field: 16]

func (*RouteMatch) Descriptor deprecated 

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

Deprecated: Use RouteMatch.ProtoReflect.Descriptor instead.

func (*RouteMatch) GetCaseSensitive 

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

func (*RouteMatch) GetConnectMatcher 

func (x *RouteMatch) GetConnectMatcher() *RouteMatch_ConnectMatcher

func (*RouteMatch) GetDynamicMetadata 

func (x *RouteMatch) GetDynamicMetadata() []*v32.MetadataMatcher

func (*RouteMatch) GetGrpc 

func (x *RouteMatch) GetGrpc() *RouteMatch_GrpcRouteMatchOptions

func (*RouteMatch) GetHeaders 

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

func (*RouteMatch) GetPath 

func (x *RouteMatch) GetPath() string

func (*RouteMatch) GetPathMatchPolicy 

func (x *RouteMatch) GetPathMatchPolicy() *v31.TypedExtensionConfig

func (*RouteMatch) GetPathSeparatedPrefix 

func (x *RouteMatch) GetPathSeparatedPrefix() string

func (*RouteMatch) GetPathSpecifier 

func (m *RouteMatch) GetPathSpecifier() isRouteMatch_PathSpecifier

func (*RouteMatch) GetPrefix 

func (x *RouteMatch) GetPrefix() string

func (*RouteMatch) GetQueryParameters 

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

func (*RouteMatch) GetRuntimeFraction 

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

func (*RouteMatch) GetSafeRegex 

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

func (*RouteMatch) GetTlsContext 

func (x *RouteMatch) GetTlsContext() *RouteMatch_TlsContextMatchOptions

func (*RouteMatch) ProtoMessage 

func (*RouteMatch) ProtoMessage()

func (*RouteMatch) ProtoReflect 

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

func (*RouteMatch) Reset 

func (x *RouteMatch) Reset()

func (*RouteMatch) String 

func (x *RouteMatch) String() string

type RouteMatch_ConnectMatcher 

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

An extensible message for matching CONNECT requests.

func (*RouteMatch_ConnectMatcher) Descriptor deprecated 

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

Deprecated: Use RouteMatch_ConnectMatcher.ProtoReflect.Descriptor instead.

func (*RouteMatch_ConnectMatcher) ProtoMessage 

func (*RouteMatch_ConnectMatcher) ProtoMessage()

func (*RouteMatch_ConnectMatcher) ProtoReflect 

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

func (*RouteMatch_ConnectMatcher) Reset 

func (x *RouteMatch_ConnectMatcher) Reset()

func (*RouteMatch_ConnectMatcher) String 

func (x *RouteMatch_ConnectMatcher) String() string

type RouteMatch_ConnectMatcher_ 

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

type RouteMatch_GrpcRouteMatchOptions 

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

func (*RouteMatch_GrpcRouteMatchOptions) Descriptor deprecated 

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

Deprecated: Use RouteMatch_GrpcRouteMatchOptions.ProtoReflect.Descriptor instead.

func (*RouteMatch_GrpcRouteMatchOptions) ProtoMessage 

func (*RouteMatch_GrpcRouteMatchOptions) ProtoMessage()

func (*RouteMatch_GrpcRouteMatchOptions) ProtoReflect 

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

func (*RouteMatch_GrpcRouteMatchOptions) Reset 

func (x *RouteMatch_GrpcRouteMatchOptions) Reset()

func (*RouteMatch_GrpcRouteMatchOptions) String 

func (x *RouteMatch_GrpcRouteMatchOptions) String() string

type RouteMatch_Path 

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

type RouteMatch_PathMatchPolicy 

type RouteMatch_PathMatchPolicy struct {
	// [#extension-category: envoy.path.match]
	PathMatchPolicy *v31.TypedExtensionConfig `protobuf:"bytes,15,opt,name=path_match_policy,json=pathMatchPolicy,proto3,oneof"`
}

type RouteMatch_PathSeparatedPrefix 

type RouteMatch_PathSeparatedPrefix struct {
	// If specified, the route is a path-separated prefix rule meaning that the
	// “:path“ header (without the query string) must either exactly match the
	// “path_separated_prefix“ or have it as a prefix, followed by “/“
	//
	// For example, “/api/dev“ would match
	// “/api/dev“, “/api/dev/“, “/api/dev/v1“, and “/api/dev?param=true“
	// but would not match “/api/developer“
	//
	// Expect the value to not contain “?“ or “#“ and not to end in “/“
	PathSeparatedPrefix string `protobuf:"bytes,14,opt,name=path_separated_prefix,json=pathSeparatedPrefix,proto3,oneof"`
}

type RouteMatch_Prefix 

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

type RouteMatch_SafeRegex 

type RouteMatch_SafeRegex struct {
	// If specified, the route is a regular expression rule meaning that the
	// regex must match the “:path“ header once the query string is removed. The entire path
	// (without the query string) must match the regex. The rule will not match if only a
	// subsequence of the “:path“ header matches the regex.
	//
	// [#next-major-version: In the v3 API we should redo how path specification works such
	// that we utilize StringMatcher, and additionally have consistent options around whether we
	// strip query strings, do a case sensitive match, etc. In the interim it will be too disruptive
	// to deprecate the existing options. We should even consider whether we want to do away with
	// path_specifier entirely and just rely on a set of header matchers which can already match
	// on :path, etc. The issue with that is it is unclear how to generically deal with query string
	// stripping. This needs more thought.]
	SafeRegex *v32.RegexMatcher `protobuf:"bytes,10,opt,name=safe_regex,json=safeRegex,proto3,oneof"`
}

type RouteMatch_TlsContextMatchOptions 

type RouteMatch_TlsContextMatchOptions struct {

	// If specified, the route will match against whether or not a certificate is presented.
	// If not specified, certificate presentation status (true or false) will not be considered when route matching.
	Presented *wrapperspb.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 *wrapperspb.BoolValue `protobuf:"bytes,2,opt,name=validated,proto3" json:"validated,omitempty"`
	// contains filtered or unexported fields
}

func (*RouteMatch_TlsContextMatchOptions) Descriptor deprecated 

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

Deprecated: Use RouteMatch_TlsContextMatchOptions.ProtoReflect.Descriptor instead.

func (*RouteMatch_TlsContextMatchOptions) GetPresented 

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

func (*RouteMatch_TlsContextMatchOptions) GetValidated 

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

func (*RouteMatch_TlsContextMatchOptions) ProtoMessage 

func (*RouteMatch_TlsContextMatchOptions) ProtoMessage()

func (*RouteMatch_TlsContextMatchOptions) ProtoReflect 

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

func (*RouteMatch_TlsContextMatchOptions) Reset 

func (x *RouteMatch_TlsContextMatchOptions) Reset()

func (*RouteMatch_TlsContextMatchOptions) String 

func (x *RouteMatch_TlsContextMatchOptions) String() string

type Route_DirectResponse 

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

type Route_FilterAction 

type Route_FilterAction struct {
	// [#not-implemented-hide:]
	// A filter-defined action (e.g., it could dynamically generate the RouteAction).
	// [#comment: TODO(samflattery): Remove cleanup in route_fuzz_test.cc when
	// implemented]
	FilterAction *FilterAction `protobuf:"bytes,17,opt,name=filter_action,json=filterAction,proto3,oneof"`
}

type Route_NonForwardingAction 

type Route_NonForwardingAction struct {
	// [#not-implemented-hide:]
	// An action used when the route will generate a response directly,
	// without forwarding to an upstream host. This will be used in non-proxy
	// xDS clients like the gRPC server. It could also be used in the future
	// in Envoy for a filter that directly generates responses for requests.
	NonForwardingAction *NonForwardingAction `protobuf:"bytes,18,opt,name=non_forwarding_action,json=nonForwardingAction,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 ScopedRouteConfiguration 

type ScopedRouteConfiguration struct {

	// Whether the RouteConfiguration should be loaded on demand.
	OnDemand bool `protobuf:"varint,4,opt,name=on_demand,json=onDemand,proto3" json:"on_demand,omitempty"`
	// The name assigned to the routing scope.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The resource name to use for a :ref:`envoy_v3_api_msg_service.discovery.v3.DiscoveryRequest` to an
	// RDS server to fetch the :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` associated
	// with this scope.
	RouteConfigurationName string `` /* 129-byte string literal not displayed */
	// The :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` associated with the scope.
	RouteConfiguration *RouteConfiguration `protobuf:"bytes,5,opt,name=route_configuration,json=routeConfiguration,proto3" json:"route_configuration,omitempty"`
	// The key to match against.
	Key *ScopedRouteConfiguration_Key `protobuf:"bytes,3,opt,name=key,proto3" json:"key,omitempty"`
	// contains filtered or unexported fields
}

Specifies a routing scope, which associates a :ref:`Key<envoy_v3_api_msg_config.route.v3.ScopedRouteConfiguration.Key>` to a :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. The :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` can be obtained dynamically via RDS (:ref:`route_configuration_name<envoy_v3_api_field_config.route.v3.ScopedRouteConfiguration.route_configuration_name>`) or specified inline (:ref:`route_configuration<envoy_v3_api_field_config.route.v3.ScopedRouteConfiguration.route_configuration>`).

The HTTP connection manager builds up a table consisting of these Key to RouteConfiguration mappings, and looks up the RouteConfiguration to use per request according to the algorithm specified in the :ref:`scope_key_builder<envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.ScopedRoutes.scope_key_builder>` assigned to the HttpConnectionManager.

For example, with the following configurations (in YAML):

HttpConnectionManager config:

.. code:: 

...
scoped_routes:
  name: foo-scoped-routes
  scope_key_builder:
    fragments:
      - header_value_extractor:
          name: X-Route-Selector
          element_separator: ,
          element:
            separator: =
            key: vip

ScopedRouteConfiguration resources (specified statically via :ref:`scoped_route_configurations_list<envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.ScopedRoutes.scoped_route_configurations_list>` or obtained dynamically via SRDS):

.. code:: 

(1)
 name: route-scope1
 route_configuration_name: route-config1
 key:
    fragments:
      - string_key: 172.10.10.20

(2)
 name: route-scope2
 route_configuration_name: route-config2
 key:
   fragments:
     - string_key: 172.20.20.30

A request from a client such as:

.. code:: 

GET / HTTP/1.1
Host: foo.com
X-Route-Selector: vip=172.10.10.20

would result in the routing table defined by the “route-config1“ RouteConfiguration being assigned to the HTTP request/stream.

[#next-free-field: 6]

func (*ScopedRouteConfiguration) Descriptor deprecated 

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

Deprecated: Use ScopedRouteConfiguration.ProtoReflect.Descriptor instead.

func (*ScopedRouteConfiguration) GetKey 

func (x *ScopedRouteConfiguration) GetKey() *ScopedRouteConfiguration_Key

func (*ScopedRouteConfiguration) GetName 

func (x *ScopedRouteConfiguration) GetName() string

func (*ScopedRouteConfiguration) GetOnDemand 

func (x *ScopedRouteConfiguration) GetOnDemand() bool

func (*ScopedRouteConfiguration) GetRouteConfiguration 

func (x *ScopedRouteConfiguration) GetRouteConfiguration() *RouteConfiguration

func (*ScopedRouteConfiguration) GetRouteConfigurationName 

func (x *ScopedRouteConfiguration) GetRouteConfigurationName() string

func (*ScopedRouteConfiguration) ProtoMessage 

func (*ScopedRouteConfiguration) ProtoMessage()

func (*ScopedRouteConfiguration) ProtoReflect 

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

func (*ScopedRouteConfiguration) Reset 

func (x *ScopedRouteConfiguration) Reset()

func (*ScopedRouteConfiguration) String 

func (x *ScopedRouteConfiguration) String() string

type ScopedRouteConfiguration_Key 

type ScopedRouteConfiguration_Key struct {

	// The ordered set of fragments to match against. The order must match the
	// fragments in the corresponding
	// :ref:`scope_key_builder<envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.ScopedRoutes.scope_key_builder>`.
	Fragments []*ScopedRouteConfiguration_Key_Fragment `protobuf:"bytes,1,rep,name=fragments,proto3" json:"fragments,omitempty"`
	// contains filtered or unexported fields
}

Specifies a key which is matched against the output of the :ref:`scope_key_builder<envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.ScopedRoutes.scope_key_builder>` specified in the HttpConnectionManager. The matching is done per HTTP request and is dependent on the order of the fragments contained in the Key.

func (*ScopedRouteConfiguration_Key) Descriptor deprecated 

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

Deprecated: Use ScopedRouteConfiguration_Key.ProtoReflect.Descriptor instead.

func (*ScopedRouteConfiguration_Key) GetFragments 

func (x *ScopedRouteConfiguration_Key) GetFragments() []*ScopedRouteConfiguration_Key_Fragment

func (*ScopedRouteConfiguration_Key) ProtoMessage 

func (*ScopedRouteConfiguration_Key) ProtoMessage()

func (*ScopedRouteConfiguration_Key) ProtoReflect 

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

func (*ScopedRouteConfiguration_Key) Reset 

func (x *ScopedRouteConfiguration_Key) Reset()

func (*ScopedRouteConfiguration_Key) String 

func (x *ScopedRouteConfiguration_Key) String() string

type ScopedRouteConfiguration_Key_Fragment 

type ScopedRouteConfiguration_Key_Fragment struct {

	// Types that are assignable to Type:
	//
	//	*ScopedRouteConfiguration_Key_Fragment_StringKey
	Type isScopedRouteConfiguration_Key_Fragment_Type `protobuf_oneof:"type"`
	// contains filtered or unexported fields
}

func (*ScopedRouteConfiguration_Key_Fragment) Descriptor deprecated 

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

Deprecated: Use ScopedRouteConfiguration_Key_Fragment.ProtoReflect.Descriptor instead.

func (*ScopedRouteConfiguration_Key_Fragment) GetStringKey 

func (x *ScopedRouteConfiguration_Key_Fragment) GetStringKey() string

func (*ScopedRouteConfiguration_Key_Fragment) GetType 

func (m *ScopedRouteConfiguration_Key_Fragment) GetType() isScopedRouteConfiguration_Key_Fragment_Type

func (*ScopedRouteConfiguration_Key_Fragment) ProtoMessage 

func (*ScopedRouteConfiguration_Key_Fragment) ProtoMessage()

func (*ScopedRouteConfiguration_Key_Fragment) ProtoReflect 

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

func (*ScopedRouteConfiguration_Key_Fragment) Reset 

func (x *ScopedRouteConfiguration_Key_Fragment) Reset()

func (*ScopedRouteConfiguration_Key_Fragment) String 

func (x *ScopedRouteConfiguration_Key_Fragment) String() string

type ScopedRouteConfiguration_Key_Fragment_StringKey 

type ScopedRouteConfiguration_Key_Fragment_StringKey struct {
	// A string to match against.
	StringKey string `protobuf:"bytes,1,opt,name=string_key,json=stringKey,proto3,oneof"`
}

type Tracing 

type Tracing struct {

	// Target percentage of requests managed by this HTTP connection manager that will be force
	// traced if the :ref:`x-client-trace-id <config_http_conn_man_headers_x-client-trace-id>`
	// header is set. This field is a direct analog for the runtime variable
	// 'tracing.client_enabled' in the :ref:`HTTP Connection Manager
	// <config_http_conn_man_runtime>`.
	// Default: 100%
	ClientSampling *v33.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 *v33.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 *v33.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_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing.custom_tags>`
	// configured in the HTTP connection manager. If two tags with the same name are configured
	// each in the HTTP connection manager and the route level, the one configured here takes
	// priority.
	CustomTags []*v34.CustomTag `protobuf:"bytes,4,rep,name=custom_tags,json=customTags,proto3" json:"custom_tags,omitempty"`
	// contains filtered or unexported fields
}

func (*Tracing) Descriptor deprecated 

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

Deprecated: Use Tracing.ProtoReflect.Descriptor instead.

func (*Tracing) GetClientSampling 

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

func (*Tracing) GetCustomTags 

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

func (*Tracing) GetOverallSampling 

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

func (*Tracing) GetRandomSampling 

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

func (*Tracing) ProtoMessage 

func (*Tracing) ProtoMessage()

func (*Tracing) ProtoReflect 

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

func (*Tracing) Reset 

func (x *Tracing) Reset()

func (*Tracing) String 

func (x *Tracing) String() string

type Vhds 

type Vhds struct {

	// Configuration source specifier for VHDS.
	ConfigSource *v3.ConfigSource `protobuf:"bytes,1,opt,name=config_source,json=configSource,proto3" json:"config_source,omitempty"`
	// contains filtered or unexported fields
}

func (*Vhds) Descriptor deprecated 

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

Deprecated: Use Vhds.ProtoReflect.Descriptor instead.

func (*Vhds) GetConfigSource 

func (x *Vhds) GetConfigSource() *v3.ConfigSource

func (*Vhds) ProtoMessage 

func (*Vhds) ProtoMessage()

func (*Vhds) ProtoReflect 

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

func (*Vhds) Reset 

func (x *Vhds) Reset()

func (*Vhds) String 

func (x *Vhds) String() string

type VirtualCluster 

type VirtualCluster struct {

	// Specifies a list of header matchers to use for matching requests. Each specified header must
	// match. The pseudo-headers “:path“ and “:method“ can be used to match the request path and
	// method, respectively.
	Headers []*HeaderMatcher `protobuf:"bytes,4,rep,name=headers,proto3" json:"headers,omitempty"`
	// Specifies the name of the virtual cluster. The virtual cluster name as well
	// as the virtual host name are used when emitting statistics. The statistics are emitted by the
	// router filter and are documented :ref:`here <config_http_filters_router_stats>`.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

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

Documentation for :ref:`virtual cluster statistics <config_http_filters_router_vcluster_stats>`.

.. note:: 

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

func (*VirtualCluster) Descriptor deprecated 

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

Deprecated: Use VirtualCluster.ProtoReflect.Descriptor instead.

func (*VirtualCluster) GetHeaders 

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

func (*VirtualCluster) GetName 

func (x *VirtualCluster) GetName() string

func (*VirtualCluster) ProtoMessage 

func (*VirtualCluster) ProtoMessage()

func (*VirtualCluster) ProtoReflect 

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

func (*VirtualCluster) Reset 

func (x *VirtualCluster) Reset()

func (*VirtualCluster) String 

func (x *VirtualCluster) String() string

type VirtualHost 

type VirtualHost struct {

	// The logical name of the virtual host. This is used when emitting certain
	// statistics but is not relevant for routing.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// A list of domains (host/authority header) that will be matched to this
	// virtual host. Wildcard hosts are supported in the suffix or prefix form.
	//
	// Domain search order:
	//  1. Exact domain names: “www.foo.com“.
	//  2. Suffix domain wildcards: “*.foo.com“ or “*-bar.foo.com“.
	//  3. Prefix domain wildcards: “foo.*“ or “foo-*“.
	//  4. Special wildcard “*“ matching any domain.
	//
	// .. note::
	//
	//	The wildcard will not match the empty string.
	//	e.g. “*-bar.foo.com“ will match “baz-bar.foo.com“ but not “-bar.foo.com“.
	//	The longest wildcards match first.
	//	Only a single virtual host in the entire route configuration can match on “*“. A domain
	//	must be unique across all virtual hosts or the config will fail to load.
	//
	// Domains cannot contain control characters. This is validated by the well_known_regex HTTP_HEADER_VALUE.
	Domains []string `protobuf:"bytes,2,rep,name=domains,proto3" json:"domains,omitempty"`
	// The list of routes that will be matched, in order, for incoming requests.
	// The first route that matches will be used.
	// Only one of this and “matcher“ can be specified.
	Routes []*Route `protobuf:"bytes,3,rep,name=routes,proto3" json:"routes,omitempty"`
	// [#next-major-version: This should be included in a oneof with routes wrapped in a message.]
	// The match tree to use when resolving route actions for incoming requests. Only one of this and “routes“
	// can be specified.
	Matcher *v3.Matcher `protobuf:"bytes,21,opt,name=matcher,proto3" json:"matcher,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 `` /* 150-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_v3_api_msg_config.route.v3.Route` and before headers from the
	// enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. For more information, including
	// details on header value syntax, see the documentation on :ref:`custom request headers
	// <config_http_conn_man_headers_custom_request_headers>`.
	RequestHeadersToAdd []*v31.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_v3_api_msg_config.route.v3.Route` and before headers from the
	// enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. For more information, including
	// details on header value syntax, see the documentation on :ref:`custom request headers
	// <config_http_conn_man_headers_custom_request_headers>`.
	ResponseHeadersToAdd []*v31.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. This field is ignored if related cors policy is
	// found in the
	// :ref:`VirtualHost.typed_per_filter_config<envoy_v3_api_field_config.route.v3.VirtualHost.typed_per_filter_config>`.
	//
	// .. attention::
	//
	//	This option has been deprecated. Please use
	//	:ref:`VirtualHost.typed_per_filter_config<envoy_v3_api_field_config.route.v3.VirtualHost.typed_per_filter_config>`
	//	to configure the CORS HTTP filter.
	//
	// Deprecated: Marked as deprecated in envoy/config/route/v3/route_components.proto.
	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 :ref:`filter config name
	// <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpFilter.name>`.
	// The canonical filter name (e.g., “envoy.filters.http.buffer“ for the HTTP buffer filter) can also
	// be used for the backwards compatibility. If there is no entry referred by the filter config name, the
	// entry referred by the canonical filter name will be provided to the filters as fallback.
	//
	// Use of this field is filter specific;
	// see the :ref:`HTTP filter documentation <config_http_filters>` for if and how it is utilized.
	// [#comment: An entry's value may be wrapped in a
	// :ref:`FilterConfig<envoy_v3_api_msg_config.route.v3.FilterConfig>`
	// message to specify additional options.]
	TypedPerFilterConfig map[string]*anypb.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_v3_api_field_extensions.filters.http.router.v3.Router.suppress_envoy_headers>` flag.
	//
	// [#next-major-version: rename to include_attempt_count_in_request.]
	IncludeRequestAttemptCount bool `` /* 145-byte string literal not displayed */
	// Decides whether the :ref:`x-envoy-attempt-count
	// <config_http_filters_router_x-envoy-attempt-count>` header should be included
	// in the downstream response. Setting this option will cause the router to override any existing header
	// value, so in the case of two Envoys on the request path with this option enabled, the downstream
	// will see the attempt count as perceived by the Envoy closest upstream from itself. Defaults to false.
	// This header is unaffected by the
	// :ref:`suppress_envoy_headers
	// <envoy_v3_api_field_extensions.filters.http.router.v3.Router.suppress_envoy_headers>` flag.
	IncludeAttemptCountInResponse bool `` /* 156-byte string literal not displayed */
	// Indicates the retry policy for all routes in this virtual host. Note that setting a
	// route level entry will take precedence over this config and it'll be treated
	// independently (e.g.: values are not inherited).
	RetryPolicy *RetryPolicy `protobuf:"bytes,16,opt,name=retry_policy,json=retryPolicy,proto3" json:"retry_policy,omitempty"`
	// [#not-implemented-hide:]
	// Specifies the configuration for retry policy extension. Note that setting a route level entry
	// will take precedence over this config and it'll be treated independently (e.g.: values are not
	// inherited). :ref:`Retry policy <envoy_v3_api_field_config.route.v3.VirtualHost.retry_policy>` should not be
	// set if this field is used.
	RetryPolicyTypedConfig *anypb.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"`
	// Decides whether to include the :ref:`x-envoy-is-timeout-retry <config_http_filters_router_x-envoy-is-timeout-retry>`
	// request header in retries initiated by per try timeouts.
	IncludeIsTimeoutRetryHeader bool `` /* 150-byte string literal not displayed */
	// 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 *wrapperspb.UInt32Value `` /* 146-byte string literal not displayed */
	// Specify a set of default request mirroring policies for every route under this virtual host.
	// It takes precedence over the route config mirror policy entirely.
	// That is, policies are not merged, the most specific non-empty one becomes the mirror policies.
	RequestMirrorPolicies []*RouteAction_RequestMirrorPolicy `` /* 127-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: 24]

func (*VirtualHost) Descriptor deprecated 

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

Deprecated: Use VirtualHost.ProtoReflect.Descriptor instead.

func (*VirtualHost) GetCors deprecated 

func (x *VirtualHost) GetCors() *CorsPolicy

Deprecated: Marked as deprecated in envoy/config/route/v3/route_components.proto.

func (*VirtualHost) GetDomains 

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

func (*VirtualHost) GetHedgePolicy 

func (x *VirtualHost) GetHedgePolicy() *HedgePolicy

func (*VirtualHost) GetIncludeAttemptCountInResponse 

func (x *VirtualHost) GetIncludeAttemptCountInResponse() bool

func (*VirtualHost) GetIncludeIsTimeoutRetryHeader 

func (x *VirtualHost) GetIncludeIsTimeoutRetryHeader() bool

func (*VirtualHost) GetIncludeRequestAttemptCount 

func (x *VirtualHost) GetIncludeRequestAttemptCount() bool

func (*VirtualHost) GetMatcher 

func (x *VirtualHost) GetMatcher() *v3.Matcher

func (*VirtualHost) GetName 

func (x *VirtualHost) GetName() string

func (*VirtualHost) GetPerRequestBufferLimitBytes 

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

func (*VirtualHost) GetRateLimits 

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

func (*VirtualHost) GetRequestHeadersToAdd 

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

func (*VirtualHost) GetRequestHeadersToRemove 

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

func (*VirtualHost) GetRequestMirrorPolicies 

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

func (*VirtualHost) GetRequireTls 

func (x *VirtualHost) GetRequireTls() VirtualHost_TlsRequirementType

func (*VirtualHost) GetResponseHeadersToAdd 

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

func (*VirtualHost) GetResponseHeadersToRemove 

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

func (*VirtualHost) GetRetryPolicy 

func (x *VirtualHost) GetRetryPolicy() *RetryPolicy

func (*VirtualHost) GetRetryPolicyTypedConfig 

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

func (*VirtualHost) GetRoutes 

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

func (*VirtualHost) GetTypedPerFilterConfig 

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

func (*VirtualHost) GetVirtualClusters 

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

func (*VirtualHost) ProtoMessage 

func (*VirtualHost) ProtoMessage()

func (*VirtualHost) ProtoReflect 

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

func (*VirtualHost) Reset 

func (x *VirtualHost) Reset()

func (*VirtualHost) String 

func (x *VirtualHost) String() string

type VirtualHost_TlsRequirementType 

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

func (VirtualHost_TlsRequirementType) Descriptor 

func (VirtualHost_TlsRequirementType) Descriptor() protoreflect.EnumDescriptor

func (VirtualHost_TlsRequirementType) Enum 

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 

func (x VirtualHost_TlsRequirementType) Number() protoreflect.EnumNumber

func (VirtualHost_TlsRequirementType) String 

func (x VirtualHost_TlsRequirementType) String() string

func (VirtualHost_TlsRequirementType) Type 

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, if this is greater than 0.
	// This field is now deprecated, and the client will use the sum of all
	// cluster weights. It is up to the management server to supply the correct weights.
	//
	// Deprecated: Marked as deprecated in envoy/config/route/v3/route_components.proto.
	TotalWeight *wrapperspb.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"`
	// Types that are assignable to RandomValueSpecifier:
	//
	//	*WeightedCluster_HeaderName
	RandomValueSpecifier isWeightedCluster_RandomValueSpecifier `protobuf_oneof:"random_value_specifier"`
	// contains filtered or unexported fields
}

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

func (*WeightedCluster) Descriptor deprecated 

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

Deprecated: Use WeightedCluster.ProtoReflect.Descriptor instead.

func (*WeightedCluster) GetClusters 

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

func (*WeightedCluster) GetHeaderName 

func (x *WeightedCluster) GetHeaderName() string

func (*WeightedCluster) GetRandomValueSpecifier 

func (m *WeightedCluster) GetRandomValueSpecifier() isWeightedCluster_RandomValueSpecifier

func (*WeightedCluster) GetRuntimeKeyPrefix 

func (x *WeightedCluster) GetRuntimeKeyPrefix() string

func (*WeightedCluster) GetTotalWeight deprecated 

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

Deprecated: Marked as deprecated in envoy/config/route/v3/route_components.proto.

func (*WeightedCluster) ProtoMessage 

func (*WeightedCluster) ProtoMessage()

func (*WeightedCluster) ProtoReflect 

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

func (*WeightedCluster) Reset 

func (x *WeightedCluster) Reset()

func (*WeightedCluster) String 

func (x *WeightedCluster) String() string

type WeightedCluster_ClusterWeight 

type WeightedCluster_ClusterWeight struct {

	// Only one of “name“ and “cluster_header“ may be specified.
	// [#next-major-version: Need to add back the validation rule: (validate.rules).string = {min_len: 1}]
	// 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"`
	// Only one of “name“ and “cluster_header“ may be specified.
	// [#next-major-version: Need to add back the validation rule: (validate.rules).string = {min_len: 1 }]
	// 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,12,opt,name=cluster_header,json=clusterHeader,proto3" json:"cluster_header,omitempty"`
	// The weight of the cluster. This value is relative to the other clusters'
	// weights. 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 be greater than 0, and must not exceed
	// uint32_t maximal value (4294967295).
	Weight *wrapperspb.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_v3_api_field_config.route.v3.RouteAction.metadata_match>`, with
	// values here taking precedence. The filter name should be specified as “envoy.lb“.
	MetadataMatch *v31.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_v3_api_msg_config.route.v3.RouteAction`.
	// Headers specified at this level are applied before headers from the enclosing
	// :ref:`envoy_v3_api_msg_config.route.v3.Route`, :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost`, and
	// :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. For more information, including details on
	// header value syntax, see the documentation on :ref:`custom request headers
	// <config_http_conn_man_headers_custom_request_headers>`.
	RequestHeadersToAdd []*v31.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_v3_api_msg_config.route.v3.RouteAction`.
	RequestHeadersToRemove []string `` /* 131-byte string literal not displayed */
	// Specifies a list of headers to be added to responses when this cluster is selected
	// through the enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`.
	// Headers specified at this level are applied before headers from the enclosing
	// :ref:`envoy_v3_api_msg_config.route.v3.Route`, :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost`, and
	// :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. For more information, including details on
	// header value syntax, see the documentation on :ref:`custom request headers
	// <config_http_conn_man_headers_custom_request_headers>`.
	ResponseHeadersToAdd []*v31.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_v3_api_msg_config.route.v3.RouteAction`.
	ResponseHeadersToRemove []string `` /* 134-byte string literal not displayed */
	// The per_filter_config field can be used to provide weighted cluster-specific configurations
	// for filters.
	// The key should match the :ref:`filter config name
	// <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpFilter.name>`.
	// The canonical filter name (e.g., “envoy.filters.http.buffer“ for the HTTP buffer filter) can also
	// be used for the backwards compatibility. If there is no entry referred by the filter config name, the
	// entry referred by the canonical filter name will be provided to the filters as fallback.
	//
	// Use of this field is filter specific;
	// see the :ref:`HTTP filter documentation <config_http_filters>` for if and how it is utilized.
	// [#comment: An entry's value may be wrapped in a
	// :ref:`FilterConfig<envoy_v3_api_msg_config.route.v3.FilterConfig>`
	// message to specify additional options.]
	TypedPerFilterConfig map[string]*anypb.Any `` /* 214-byte string literal not displayed */
	// Types that are assignable to HostRewriteSpecifier:
	//
	//	*WeightedCluster_ClusterWeight_HostRewriteLiteral
	HostRewriteSpecifier isWeightedCluster_ClusterWeight_HostRewriteSpecifier `protobuf_oneof:"host_rewrite_specifier"`
	// contains filtered or unexported fields
}

[#next-free-field: 13]

func (*WeightedCluster_ClusterWeight) Descriptor deprecated 

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

Deprecated: Use WeightedCluster_ClusterWeight.ProtoReflect.Descriptor instead.

func (*WeightedCluster_ClusterWeight) GetClusterHeader 

func (x *WeightedCluster_ClusterWeight) GetClusterHeader() string

func (*WeightedCluster_ClusterWeight) GetHostRewriteLiteral 

func (x *WeightedCluster_ClusterWeight) GetHostRewriteLiteral() string

func (*WeightedCluster_ClusterWeight) GetHostRewriteSpecifier 

func (m *WeightedCluster_ClusterWeight) GetHostRewriteSpecifier() isWeightedCluster_ClusterWeight_HostRewriteSpecifier

func (*WeightedCluster_ClusterWeight) GetMetadataMatch 

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

func (*WeightedCluster_ClusterWeight) GetName 

func (x *WeightedCluster_ClusterWeight) GetName() string

func (*WeightedCluster_ClusterWeight) GetRequestHeadersToAdd 

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

func (*WeightedCluster_ClusterWeight) GetRequestHeadersToRemove 

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

func (*WeightedCluster_ClusterWeight) GetResponseHeadersToAdd 

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

func (*WeightedCluster_ClusterWeight) GetResponseHeadersToRemove 

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

func (*WeightedCluster_ClusterWeight) GetTypedPerFilterConfig 

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

func (*WeightedCluster_ClusterWeight) GetWeight 

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

func (*WeightedCluster_ClusterWeight) ProtoMessage 

func (*WeightedCluster_ClusterWeight) ProtoMessage()

func (*WeightedCluster_ClusterWeight) ProtoReflect 

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

type WeightedCluster_ClusterWeight_HostRewriteLiteral 

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

type WeightedCluster_HeaderName 

type WeightedCluster_HeaderName struct {
	// Specifies the header name that is used to look up the random value passed in the request header.
	// This is used to ensure consistent cluster picking across multiple proxy levels for weighted traffic.
	// If header is not present or invalid, Envoy will fall back to use the internally generated random value.
	// This header is expected to be single-valued header as we only want to have one selected value throughout
	// the process for the consistency. And the value is a unsigned number between 0 and UINT64_MAX.
	HeaderName string `protobuf:"bytes,4,opt,name=header_name,json=headerName,proto3,oneof"`
}

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.