| Class | Description |
|---|---|
| CorsPolicy |
[#next-free-field: 12]
Protobuf type
envoy.config.route.v4alpha.CorsPolicy |
| CorsPolicy.Builder |
[#next-free-field: 12]
Protobuf type
envoy.config.route.v4alpha.CorsPolicy |
| Decorator |
Protobuf type
envoy.config.route.v4alpha.Decorator |
| Decorator.Builder |
Protobuf type
envoy.config.route.v4alpha.Decorator |
| DirectResponseAction |
Protobuf type
envoy.config.route.v4alpha.DirectResponseAction |
| DirectResponseAction.Builder |
Protobuf type
envoy.config.route.v4alpha.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>`.
|
| InternalRedirectPolicy |
HTTP Internal Redirect :ref:`architecture overview <arch_overview_internal_redirects>`.
|
| InternalRedirectPolicy.Builder |
HTTP Internal Redirect :ref:`architecture overview <arch_overview_internal_redirects>`.
|
| 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: 10]
Protobuf type
envoy.config.route.v4alpha.RateLimit.Action |
| RateLimit.Action.Builder |
[#next-free-field: 10]
Protobuf type
envoy.config.route.v4alpha.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_config.route.v4alpha.RouteConfiguration>`
settings:
* :ref:`cluster <envoy_api_field_config.route.v4alpha.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_config.route.v4alpha.RouteConfiguration>`
settings:
* :ref:`cluster <envoy_api_field_config.route.v4alpha.RouteAction.cluster>` indicates the upstream cluster
to route to
|
| RateLimit.Action.DynamicMetaData |
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_api_msg_config.route.v4alpha.RateLimit.Action.MetaData>` action
Protobuf type
envoy.config.route.v4alpha.RateLimit.Action.DynamicMetaData |
| RateLimit.Action.DynamicMetaData.Builder |
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_api_msg_config.route.v4alpha.RateLimit.Action.MetaData>` action
Protobuf type
envoy.config.route.v4alpha.RateLimit.Action.DynamicMetaData |
| RateLimit.Action.GenericKey |
The following descriptor entry is appended to the descriptor:
.. code-block:: cpp
("generic_key", "<descriptor_value>")
Protobuf type
envoy.config.route.v4alpha.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.config.route.v4alpha.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.config.route.v4alpha.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.config.route.v4alpha.RateLimit.Action.HeaderValueMatch |
| RateLimit.Action.MetaData |
The following descriptor entry is appended when the metadata contains a key value:
.. code-block:: cpp
("<descriptor_key>", "<value_queried_from_metadata>")
Protobuf type
envoy.config.route.v4alpha.RateLimit.Action.MetaData |
| RateLimit.Action.MetaData.Builder |
The following descriptor entry is appended when the metadata contains a key value:
.. code-block:: cpp
("<descriptor_key>", "<value_queried_from_metadata>")
Protobuf type
envoy.config.route.v4alpha.RateLimit.Action.MetaData |
| 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.config.route.v4alpha.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.config.route.v4alpha.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.config.route.v4alpha.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.config.route.v4alpha.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>`.
|
| RateLimit.Override |
Protobuf type
envoy.config.route.v4alpha.RateLimit.Override |
| RateLimit.Override.Builder |
Protobuf type
envoy.config.route.v4alpha.RateLimit.Override |
| RateLimit.Override.DynamicMetadata |
Fetches the override from the dynamic metadata.
|
| RateLimit.Override.DynamicMetadata.Builder |
Fetches the override from the dynamic metadata.
|
| RedirectAction |
[#next-free-field: 10]
Protobuf type
envoy.config.route.v4alpha.RedirectAction |
| RedirectAction.Builder |
[#next-free-field: 10]
Protobuf type
envoy.config.route.v4alpha.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.RateLimitedRetryBackOff |
A retry back-off strategy that applies when the upstream server rate limits
the request.
|
| RetryPolicy.RateLimitedRetryBackOff.Builder |
A retry back-off strategy that applies when the upstream server rate limits
the request.
|
| RetryPolicy.ResetHeader |
Protobuf type
envoy.config.route.v4alpha.RetryPolicy.ResetHeader |
| RetryPolicy.ResetHeader.Builder |
Protobuf type
envoy.config.route.v4alpha.RetryPolicy.ResetHeader |
| RetryPolicy.RetryBackOff |
Protobuf type
envoy.config.route.v4alpha.RetryPolicy.RetryBackOff |
| RetryPolicy.RetryBackOff.Builder |
Protobuf type
envoy.config.route.v4alpha.RetryPolicy.RetryBackOff |
| RetryPolicy.RetryHostPredicate |
Protobuf type
envoy.config.route.v4alpha.RetryPolicy.RetryHostPredicate |
| RetryPolicy.RetryHostPredicate.Builder |
Protobuf type
envoy.config.route.v4alpha.RetryPolicy.RetryHostPredicate |
| RetryPolicy.RetryPriority |
Protobuf type
envoy.config.route.v4alpha.RetryPolicy.RetryPriority |
| RetryPolicy.RetryPriority.Builder |
Protobuf type
envoy.config.route.v4alpha.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_config.route.v4alpha.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_config.route.v4alpha.HeaderMatcher>`.
|
| RouteAction |
[#next-free-field: 37]
Protobuf type
envoy.config.route.v4alpha.RouteAction |
| RouteAction.Builder |
[#next-free-field: 37]
Protobuf type
envoy.config.route.v4alpha.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.config.route.v4alpha.RouteAction.HashPolicy.ConnectionProperties |
| RouteAction.HashPolicy.ConnectionProperties.Builder |
Protobuf type
envoy.config.route.v4alpha.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.config.route.v4alpha.RouteAction.HashPolicy.FilterState |
| RouteAction.HashPolicy.FilterState.Builder |
Protobuf type
envoy.config.route.v4alpha.RouteAction.HashPolicy.FilterState |
| RouteAction.HashPolicy.Header |
Protobuf type
envoy.config.route.v4alpha.RouteAction.HashPolicy.Header |
| RouteAction.HashPolicy.Header.Builder |
Protobuf type
envoy.config.route.v4alpha.RouteAction.HashPolicy.Header |
| RouteAction.HashPolicy.QueryParameter |
Protobuf type
envoy.config.route.v4alpha.RouteAction.HashPolicy.QueryParameter |
| RouteAction.HashPolicy.QueryParameter.Builder |
Protobuf type
envoy.config.route.v4alpha.RouteAction.HashPolicy.QueryParameter |
| RouteAction.MaxStreamDuration |
Protobuf type
envoy.config.route.v4alpha.RouteAction.MaxStreamDuration |
| RouteAction.MaxStreamDuration.Builder |
Protobuf type
envoy.config.route.v4alpha.RouteAction.MaxStreamDuration |
| 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.
|
| RouteAction.UpgradeConfig.ConnectConfig |
Configuration for sending data upstream as a raw data payload.
|
| RouteAction.UpgradeConfig.ConnectConfig.Builder |
Configuration for sending data upstream as a raw data payload.
|
| RouteComponentsProto | |
| RouteConfiguration |
[#next-free-field: 11]
Protobuf type
envoy.config.route.v4alpha.RouteConfiguration |
| RouteConfiguration.Builder |
[#next-free-field: 11]
Protobuf type
envoy.config.route.v4alpha.RouteConfiguration |
| RouteMatch |
[#next-free-field: 13]
Protobuf type
envoy.config.route.v4alpha.RouteMatch |
| RouteMatch.Builder |
[#next-free-field: 13]
Protobuf type
envoy.config.route.v4alpha.RouteMatch |
| RouteMatch.ConnectMatcher |
An extensible message for matching CONNECT requests.
|
| RouteMatch.ConnectMatcher.Builder |
An extensible message for matching CONNECT requests.
|
| RouteMatch.GrpcRouteMatchOptions |
Protobuf type
envoy.config.route.v4alpha.RouteMatch.GrpcRouteMatchOptions |
| RouteMatch.GrpcRouteMatchOptions.Builder |
Protobuf type
envoy.config.route.v4alpha.RouteMatch.GrpcRouteMatchOptions |
| RouteMatch.TlsContextMatchOptions |
Protobuf type
envoy.config.route.v4alpha.RouteMatch.TlsContextMatchOptions |
| RouteMatch.TlsContextMatchOptions.Builder |
Protobuf type
envoy.config.route.v4alpha.RouteMatch.TlsContextMatchOptions |
| RouteProto | |
| ScopedRouteConfiguration |
Specifies a routing scope, which associates a
:ref:`Key<envoy_api_msg_config.route.v4alpha.ScopedRouteConfiguration.Key>` to a
:ref:`envoy_api_msg_config.route.v4alpha.RouteConfiguration` (identified by its resource name).
|
| ScopedRouteConfiguration.Builder |
Specifies a routing scope, which associates a
:ref:`Key<envoy_api_msg_config.route.v4alpha.ScopedRouteConfiguration.Key>` to a
:ref:`envoy_api_msg_config.route.v4alpha.RouteConfiguration` (identified by its resource name).
|
| ScopedRouteConfiguration.Key |
Specifies a key which is matched against the output of the
:ref:`scope_key_builder<envoy_api_field_extensions.filters.network.http_connection_manager.v4alpha.ScopedRoutes.scope_key_builder>`
specified in the HttpConnectionManager.
|
| ScopedRouteConfiguration.Key.Builder |
Specifies a key which is matched against the output of the
:ref:`scope_key_builder<envoy_api_field_extensions.filters.network.http_connection_manager.v4alpha.ScopedRoutes.scope_key_builder>`
specified in the HttpConnectionManager.
|
| ScopedRouteConfiguration.Key.Fragment |
Protobuf type
envoy.config.route.v4alpha.ScopedRouteConfiguration.Key.Fragment |
| ScopedRouteConfiguration.Key.Fragment.Builder |
Protobuf type
envoy.config.route.v4alpha.ScopedRouteConfiguration.Key.Fragment |
| ScopedRouteProto | |
| Tracing |
Protobuf type
envoy.config.route.v4alpha.Tracing |
| Tracing.Builder |
Protobuf type
envoy.config.route.v4alpha.Tracing |
| Vhds |
Protobuf type
envoy.config.route.v4alpha.Vhds |
| Vhds.Builder |
Protobuf type
envoy.config.route.v4alpha.Vhds |
| 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_config.route.v4alpha.RouteAction.cluster>` field that specifies a
single upstream cluster as the target of a request, the :ref:`weighted_clusters
<envoy_api_field_config.route.v4alpha.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_config.route.v4alpha.RouteAction.cluster>` field that specifies a
single upstream cluster as the target of a request, the :ref:`weighted_clusters
<envoy_api_field_config.route.v4alpha.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.config.route.v4alpha.WeightedCluster.ClusterWeight |
| WeightedCluster.ClusterWeight.Builder |
[#next-free-field: 11]
Protobuf type
envoy.config.route.v4alpha.WeightedCluster.ClusterWeight |
Copyright © 2018–2021 The Envoy Project. All rights reserved.