Uses of Package
io.envoyproxy.envoy.config.route.v3
Packages that use io.envoyproxy.envoy.config.route.v3
Package
Description
Interfaces and implementations that are internal to gRPC.
-
Classes in io.envoyproxy.envoy.config.route.v3 used by io.envoyproxy.envoy.config.accesslog.v3ClassDescription.. attention:: Internally, Envoy always uses the HTTP/2 ``:authority`` header to represent the HTTP/1 ``Host`` header... attention:: Internally, Envoy always uses the HTTP/2 ``:authority`` header to represent the HTTP/1 ``Host`` header.
-
Classes in io.envoyproxy.envoy.config.route.v3 used by io.envoyproxy.envoy.config.rbac.v3ClassDescription.. attention:: Internally, Envoy always uses the HTTP/2 ``:authority`` header to represent the HTTP/1 ``Host`` header... attention:: Internally, Envoy always uses the HTTP/2 ``:authority`` header to represent the HTTP/1 ``Host`` header.
-
Classes in io.envoyproxy.envoy.config.route.v3 used by io.envoyproxy.envoy.config.route.v3ClassDescriptionConfiguration for a cluster specifier plugin.Configuration for a cluster specifier plugin.Cors policy configuration. .. attention:: This message has been deprecated.Cors policy configuration. .. attention:: This message has been deprecated.Protobuf type
envoy.config.route.v3.DecoratorProtobuf typeenvoy.config.route.v3.DecoratorProtobuf typeenvoy.config.route.v3.DirectResponseActionProtobuf typeenvoy.config.route.v3.DirectResponseActionA filter-defined action type.A filter-defined action type.A simple wrapper for an HTTP filter config.A simple wrapper for an HTTP filter config... attention:: Internally, Envoy always uses the HTTP/2 ``:authority`` header to represent the HTTP/1 ``Host`` header... attention:: Internally, Envoy always uses the HTTP/2 ``:authority`` header to represent the HTTP/1 ``Host`` header.HTTP request hedging :ref:`architecture overview <arch_overview_http_routing_hedging>`.HTTP request hedging :ref:`architecture overview <arch_overview_http_routing_hedging>`.HTTP Internal Redirect :ref:`architecture overview <arch_overview_internal_redirects>`.HTTP Internal Redirect :ref:`architecture overview <arch_overview_internal_redirects>`.[#not-implemented-hide:][#not-implemented-hide:]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.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.Global rate limiting :ref:`architecture overview <arch_overview_global_rate_limit>`.[#next-free-field: 12][#next-free-field: 12]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.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.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>` actionThe 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>` actionThe following descriptor entry is appended to the descriptor: .. code-block:: cpp ("generic_key", "<descriptor_value>")The following descriptor entry is appended to the descriptor: .. code-block:: cpp ("generic_key", "<descriptor_value>")The following descriptor entry is appended to the descriptor: .. code-block:: cpp ("header_match", "<descriptor_value>")The following descriptor entry is appended to the descriptor: .. code-block:: cpp ("header_match", "<descriptor_value>")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>")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>")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]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]Protobuf enumenvoy.config.route.v3.RateLimit.Action.MetaData.SourceThe following descriptor entry is appended to the descriptor: .. code-block:: cpp ("query_match", "<descriptor_value>")The following descriptor entry is appended to the descriptor: .. code-block:: cpp ("query_match", "<descriptor_value>")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>")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>")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>")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>")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.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.Global rate limiting :ref:`architecture overview <arch_overview_global_rate_limit>`.Protobuf typeenvoy.config.route.v3.RateLimit.OverrideProtobuf typeenvoy.config.route.v3.RateLimit.OverrideFetches the override from the dynamic metadata.Fetches the override from the dynamic metadata.[#next-free-field: 10][#next-free-field: 10]Protobuf enumenvoy.config.route.v3.RedirectAction.RedirectResponseCodeHTTP retry :ref:`architecture overview <arch_overview_http_routing_retry>`.HTTP retry :ref:`architecture overview <arch_overview_http_routing_retry>`.A retry back-off strategy that applies when the upstream server rate limits the request.A retry back-off strategy that applies when the upstream server rate limits the request.Protobuf typeenvoy.config.route.v3.RetryPolicy.ResetHeaderProtobuf typeenvoy.config.route.v3.RetryPolicy.ResetHeaderProtobuf enumenvoy.config.route.v3.RetryPolicy.ResetHeaderFormatProtobuf typeenvoy.config.route.v3.RetryPolicy.RetryBackOffProtobuf typeenvoy.config.route.v3.RetryPolicy.RetryBackOffProtobuf typeenvoy.config.route.v3.RetryPolicy.RetryHostPredicateProtobuf typeenvoy.config.route.v3.RetryPolicy.RetryHostPredicateProtobuf typeenvoy.config.route.v3.RetryPolicy.RetryPriorityProtobuf typeenvoy.config.route.v3.RetryPolicy.RetryPriorityA 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>`.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: 42][#next-free-field: 42]Protobuf enumenvoy.config.route.v3.RouteAction.ClusterNotFoundResponseCodeSpecifies the route's hashing policy if the upstream cluster uses a hashing :ref:`load balancer <arch_overview_load_balancing_types>`.Specifies the route's hashing policy if the upstream cluster uses a hashing :ref:`load balancer <arch_overview_load_balancing_types>`.Protobuf typeenvoy.config.route.v3.RouteAction.HashPolicy.ConnectionPropertiesProtobuf typeenvoy.config.route.v3.RouteAction.HashPolicy.ConnectionPropertiesEnvoy supports two types of cookie affinity: 1.Envoy supports two types of cookie affinity: 1.CookieAttribute defines an API for adding additional attributes for a HTTP cookie.CookieAttribute defines an API for adding additional attributes for a HTTP cookie.Protobuf typeenvoy.config.route.v3.RouteAction.HashPolicy.FilterStateProtobuf typeenvoy.config.route.v3.RouteAction.HashPolicy.FilterStateProtobuf typeenvoy.config.route.v3.RouteAction.HashPolicy.HeaderProtobuf typeenvoy.config.route.v3.RouteAction.HashPolicy.HeaderProtobuf typeenvoy.config.route.v3.RouteAction.HashPolicy.QueryParameterProtobuf typeenvoy.config.route.v3.RouteAction.HashPolicy.QueryParameterDeprecated.Protobuf typeenvoy.config.route.v3.RouteAction.MaxStreamDurationProtobuf typeenvoy.config.route.v3.RouteAction.MaxStreamDurationThe router is capable of shadowing traffic from one cluster to another.The router is capable of shadowing traffic from one cluster to another.Allows enabling and disabling upgrades on a per-route basis.Allows enabling and disabling upgrades on a per-route basis.Configuration for sending data upstream as a raw data payload.Configuration for sending data upstream as a raw data payload.[#next-free-field: 18][#next-free-field: 18]This can be used in route matcher :ref:`VirtualHost.matcher <envoy_v3_api_field_config.route.v3.VirtualHost.matcher>`.This can be used in route matcher :ref:`VirtualHost.matcher <envoy_v3_api_field_config.route.v3.VirtualHost.matcher>`.[#next-free-field: 16][#next-free-field: 16]An extensible message for matching CONNECT or CONNECT-UDP requests.An extensible message for matching CONNECT or CONNECT-UDP requests.Protobuf typeenvoy.config.route.v3.RouteMatch.GrpcRouteMatchOptionsProtobuf typeenvoy.config.route.v3.RouteMatch.GrpcRouteMatchOptionsProtobuf typeenvoy.config.route.v3.RouteMatch.TlsContextMatchOptionsProtobuf typeenvoy.config.route.v3.RouteMatch.TlsContextMatchOptionsSpecifies 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`.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`.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.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.Protobuf typeenvoy.config.route.v3.ScopedRouteConfiguration.Key.FragmentProtobuf typeenvoy.config.route.v3.ScopedRouteConfiguration.Key.FragmentProtobuf typeenvoy.config.route.v3.TracingProtobuf typeenvoy.config.route.v3.TracingProtobuf typeenvoy.config.route.v3.VhdsProtobuf typeenvoy.config.route.v3.VhdsA 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.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 top level element in the routing configuration is a virtual host.The top level element in the routing configuration is a virtual host.Protobuf enumenvoy.config.route.v3.VirtualHost.TlsRequirementTypeCompared 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.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.[#next-free-field: 13][#next-free-field: 13] -
Classes in io.envoyproxy.envoy.config.route.v3 used by io.envoyproxy.envoy.extensions.filters.http.fault.v3ClassDescription.. attention:: Internally, Envoy always uses the HTTP/2 ``:authority`` header to represent the HTTP/1 ``Host`` header... attention:: Internally, Envoy always uses the HTTP/2 ``:authority`` header to represent the HTTP/1 ``Host`` header.
-
Classes in io.envoyproxy.envoy.config.route.v3 used by io.envoyproxy.envoy.extensions.filters.network.http_connection_manager.v3ClassDescription[#next-free-field: 18][#next-free-field: 18]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`.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`.
-
Classes in io.envoyproxy.envoy.config.route.v3 used by io.grpc.xds.internalClassDescription.. attention:: Internally, Envoy always uses the HTTP/2 ``:authority`` header to represent the HTTP/1 ``Host`` header.