| Class | Description |
|---|---|
| CorsPolicy |
[#next-free-field: 12]
Protobuf type
envoy.api.v2.route.CorsPolicy |
| CorsPolicy.Builder |
[#next-free-field: 12]
Protobuf type
envoy.api.v2.route.CorsPolicy |
| Decorator |
Protobuf type
envoy.api.v2.route.Decorator |
| Decorator.Builder |
Protobuf type
envoy.api.v2.route.Decorator |
| DirectResponseAction |
Protobuf type
envoy.api.v2.route.DirectResponseAction |
| DirectResponseAction.Builder |
Protobuf type
envoy.api.v2.route.DirectResponseAction |
| FilterAction |
A filter-defined action type.
|
| FilterAction.Builder |
A filter-defined action type.
|
| HeaderMatcher |
.. attention::
Internally, Envoy always uses the HTTP/2 *:authority* header to represent the HTTP/1 *Host*
header.
|
| HeaderMatcher.Builder |
.. attention::
Internally, Envoy always uses the HTTP/2 *:authority* header to represent the HTTP/1 *Host*
header.
|
| HedgePolicy |
HTTP request hedging :ref:`architecture overview <arch_overview_http_routing_hedging>`.
|
| HedgePolicy.Builder |
HTTP request hedging :ref:`architecture overview <arch_overview_http_routing_hedging>`.
|
| QueryParameterMatcher |
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.
|
| QueryParameterMatcher.Builder |
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.
|
| RateLimit |
Global rate limiting :ref:`architecture overview <arch_overview_global_rate_limit>`.
|
| RateLimit.Action |
[#next-free-field: 7]
Protobuf type
envoy.api.v2.route.RateLimit.Action |
| RateLimit.Action.Builder |
[#next-free-field: 7]
Protobuf type
envoy.api.v2.route.RateLimit.Action |
| RateLimit.Action.DestinationCluster |
The following descriptor entry is appended to the descriptor:
.. code-block:: cpp
("destination_cluster", "<routed target cluster>")
Once a request matches against a route table rule, a routed cluster is determined by one of
the following :ref:`route table configuration <envoy_api_msg_RouteConfiguration>`
settings:
* :ref:`cluster <envoy_api_field_route.RouteAction.cluster>` indicates the upstream cluster
to route to
|
| RateLimit.Action.DestinationCluster.Builder |
The following descriptor entry is appended to the descriptor:
.. code-block:: cpp
("destination_cluster", "<routed target cluster>")
Once a request matches against a route table rule, a routed cluster is determined by one of
the following :ref:`route table configuration <envoy_api_msg_RouteConfiguration>`
settings:
* :ref:`cluster <envoy_api_field_route.RouteAction.cluster>` indicates the upstream cluster
to route to
|
| RateLimit.Action.GenericKey |
The following descriptor entry is appended to the descriptor:
.. code-block:: cpp
("generic_key", "<descriptor_value>")
Protobuf type
envoy.api.v2.route.RateLimit.Action.GenericKey |
| RateLimit.Action.GenericKey.Builder |
The following descriptor entry is appended to the descriptor:
.. code-block:: cpp
("generic_key", "<descriptor_value>")
Protobuf type
envoy.api.v2.route.RateLimit.Action.GenericKey |
| RateLimit.Action.HeaderValueMatch |
The following descriptor entry is appended to the descriptor:
.. code-block:: cpp
("header_match", "<descriptor_value>")
Protobuf type
envoy.api.v2.route.RateLimit.Action.HeaderValueMatch |
| RateLimit.Action.HeaderValueMatch.Builder |
The following descriptor entry is appended to the descriptor:
.. code-block:: cpp
("header_match", "<descriptor_value>")
Protobuf type
envoy.api.v2.route.RateLimit.Action.HeaderValueMatch |
| RateLimit.Action.RemoteAddress |
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>")
Protobuf type
envoy.api.v2.route.RateLimit.Action.RemoteAddress |
| RateLimit.Action.RemoteAddress.Builder |
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>")
Protobuf type
envoy.api.v2.route.RateLimit.Action.RemoteAddress |
| RateLimit.Action.RequestHeaders |
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>")
Protobuf type
envoy.api.v2.route.RateLimit.Action.RequestHeaders |
| RateLimit.Action.RequestHeaders.Builder |
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>")
Protobuf type
envoy.api.v2.route.RateLimit.Action.RequestHeaders |
| RateLimit.Action.SourceCluster |
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.
|
| RateLimit.Action.SourceCluster.Builder |
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.
|
| RateLimit.Builder |
Global rate limiting :ref:`architecture overview <arch_overview_global_rate_limit>`.
|
| RedirectAction |
[#next-free-field: 9]
Protobuf type
envoy.api.v2.route.RedirectAction |
| RedirectAction.Builder |
[#next-free-field: 9]
Protobuf type
envoy.api.v2.route.RedirectAction |
| RetryPolicy |
HTTP retry :ref:`architecture overview <arch_overview_http_routing_retry>`.
|
| RetryPolicy.Builder |
HTTP retry :ref:`architecture overview <arch_overview_http_routing_retry>`.
|
| RetryPolicy.RetryBackOff |
Protobuf type
envoy.api.v2.route.RetryPolicy.RetryBackOff |
| RetryPolicy.RetryBackOff.Builder |
Protobuf type
envoy.api.v2.route.RetryPolicy.RetryBackOff |
| RetryPolicy.RetryHostPredicate |
Protobuf type
envoy.api.v2.route.RetryPolicy.RetryHostPredicate |
| RetryPolicy.RetryHostPredicate.Builder |
Protobuf type
envoy.api.v2.route.RetryPolicy.RetryHostPredicate |
| RetryPolicy.RetryPriority |
Protobuf type
envoy.api.v2.route.RetryPolicy.RetryPriority |
| RetryPolicy.RetryPriority.Builder |
Protobuf type
envoy.api.v2.route.RetryPolicy.RetryPriority |
| Route |
A route is both a specification of how to match a request as well as an indication of what to do
next (e.g., redirect, forward, rewrite, etc.).
.. attention::
Envoy supports routing on HTTP method via :ref:`header matching
<envoy_api_msg_route.HeaderMatcher>`.
|
| Route.Builder |
A route is both a specification of how to match a request as well as an indication of what to do
next (e.g., redirect, forward, rewrite, etc.).
.. attention::
Envoy supports routing on HTTP method via :ref:`header matching
<envoy_api_msg_route.HeaderMatcher>`.
|
| RouteAction |
[#next-free-field: 34]
Protobuf type
envoy.api.v2.route.RouteAction |
| RouteAction.Builder |
[#next-free-field: 34]
Protobuf type
envoy.api.v2.route.RouteAction |
| RouteAction.HashPolicy |
Specifies the route's hashing policy if the upstream cluster uses a hashing :ref:`load balancer
<arch_overview_load_balancing_types>`.
|
| RouteAction.HashPolicy.Builder |
Specifies the route's hashing policy if the upstream cluster uses a hashing :ref:`load balancer
<arch_overview_load_balancing_types>`.
|
| RouteAction.HashPolicy.ConnectionProperties |
Protobuf type
envoy.api.v2.route.RouteAction.HashPolicy.ConnectionProperties |
| RouteAction.HashPolicy.ConnectionProperties.Builder |
Protobuf type
envoy.api.v2.route.RouteAction.HashPolicy.ConnectionProperties |
| RouteAction.HashPolicy.Cookie |
Envoy supports two types of cookie affinity:
1.
|
| RouteAction.HashPolicy.Cookie.Builder |
Envoy supports two types of cookie affinity:
1.
|
| RouteAction.HashPolicy.FilterState |
Protobuf type
envoy.api.v2.route.RouteAction.HashPolicy.FilterState |
| RouteAction.HashPolicy.FilterState.Builder |
Protobuf type
envoy.api.v2.route.RouteAction.HashPolicy.FilterState |
| RouteAction.HashPolicy.Header |
Protobuf type
envoy.api.v2.route.RouteAction.HashPolicy.Header |
| RouteAction.HashPolicy.Header.Builder |
Protobuf type
envoy.api.v2.route.RouteAction.HashPolicy.Header |
| RouteAction.HashPolicy.QueryParameter |
Protobuf type
envoy.api.v2.route.RouteAction.HashPolicy.QueryParameter |
| RouteAction.HashPolicy.QueryParameter.Builder |
Protobuf type
envoy.api.v2.route.RouteAction.HashPolicy.QueryParameter |
| RouteAction.RequestMirrorPolicy |
The router is capable of shadowing traffic from one cluster to another.
|
| RouteAction.RequestMirrorPolicy.Builder |
The router is capable of shadowing traffic from one cluster to another.
|
| RouteAction.UpgradeConfig |
Allows enabling and disabling upgrades on a per-route basis.
|
| RouteAction.UpgradeConfig.Builder |
Allows enabling and disabling upgrades on a per-route basis.
|
| RouteComponentsProto | |
| RouteMatch |
[#next-free-field: 12]
Protobuf type
envoy.api.v2.route.RouteMatch |
| RouteMatch.Builder |
[#next-free-field: 12]
Protobuf type
envoy.api.v2.route.RouteMatch |
| RouteMatch.GrpcRouteMatchOptions |
Protobuf type
envoy.api.v2.route.RouteMatch.GrpcRouteMatchOptions |
| RouteMatch.GrpcRouteMatchOptions.Builder |
Protobuf type
envoy.api.v2.route.RouteMatch.GrpcRouteMatchOptions |
| RouteMatch.TlsContextMatchOptions |
Protobuf type
envoy.api.v2.route.RouteMatch.TlsContextMatchOptions |
| RouteMatch.TlsContextMatchOptions.Builder |
Protobuf type
envoy.api.v2.route.RouteMatch.TlsContextMatchOptions |
| RouteProto | |
| Tracing |
Protobuf type
envoy.api.v2.route.Tracing |
| Tracing.Builder |
Protobuf type
envoy.api.v2.route.Tracing |
| VirtualCluster |
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.
|
| VirtualCluster.Builder |
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.
|
| VirtualHost |
The top level element in the routing configuration is a virtual host.
|
| VirtualHost.Builder |
The top level element in the routing configuration is a virtual host.
|
| WeightedCluster |
Compared to the :ref:`cluster <envoy_api_field_route.RouteAction.cluster>` field that specifies a
single upstream cluster as the target of a request, the :ref:`weighted_clusters
<envoy_api_field_route.RouteAction.weighted_clusters>` option allows for specification of
multiple upstream clusters along with weights that indicate the percentage of
traffic to be forwarded to each cluster.
|
| WeightedCluster.Builder |
Compared to the :ref:`cluster <envoy_api_field_route.RouteAction.cluster>` field that specifies a
single upstream cluster as the target of a request, the :ref:`weighted_clusters
<envoy_api_field_route.RouteAction.weighted_clusters>` option allows for specification of
multiple upstream clusters along with weights that indicate the percentage of
traffic to be forwarded to each cluster.
|
| WeightedCluster.ClusterWeight |
[#next-free-field: 11]
Protobuf type
envoy.api.v2.route.WeightedCluster.ClusterWeight |
| WeightedCluster.ClusterWeight.Builder |
[#next-free-field: 11]
Protobuf type
envoy.api.v2.route.WeightedCluster.ClusterWeight |
| Enum | Description |
|---|---|
| CorsPolicy.EnabledSpecifierCase | |
| HeaderMatcher.HeaderMatchSpecifierCase | |
| QueryParameterMatcher.QueryParameterMatchSpecifierCase | |
| RateLimit.Action.ActionSpecifierCase | |
| RedirectAction.PathRewriteSpecifierCase | |
| RedirectAction.RedirectResponseCode |
Protobuf enum
envoy.api.v2.route.RedirectAction.RedirectResponseCode |
| RedirectAction.SchemeRewriteSpecifierCase | |
| RetryPolicy.RetryHostPredicate.ConfigTypeCase | |
| RetryPolicy.RetryPriority.ConfigTypeCase | |
| Route.ActionCase | |
| RouteAction.ClusterNotFoundResponseCode |
Protobuf enum
envoy.api.v2.route.RouteAction.ClusterNotFoundResponseCode |
| RouteAction.ClusterSpecifierCase | |
| RouteAction.HashPolicy.PolicySpecifierCase | |
| RouteAction.HostRewriteSpecifierCase | |
| RouteAction.InternalRedirectAction |
Configures :ref:`internal redirect <arch_overview_internal_redirects>` behavior.
|
| RouteMatch.PathSpecifierCase | |
| VirtualHost.TlsRequirementType |
Protobuf enum
envoy.api.v2.route.VirtualHost.TlsRequirementType |
Copyright © 2018–2021 The Envoy Project. All rights reserved.