RouteActionOrBuilder (api 0.1.28 API)

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

RouteAction, RouteAction.Builder
```
public interface RouteActionOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`com.google.protobuf.BoolValue`	`getAutoHostRewrite()` Indicates that during forwarding, the host header will be swapped with the hostname of the upstream host chosen by the cluster manager.
`com.google.protobuf.BoolValueOrBuilder`	`getAutoHostRewriteOrBuilder()` Indicates that during forwarding, the host header will be swapped with the hostname of the upstream host chosen by the cluster manager.
`String`	`getCluster()` Indicates the upstream cluster to which the request should be routed to.
`com.google.protobuf.ByteString`	`getClusterBytes()` Indicates the upstream cluster to which the request should be routed to.
`String`	`getClusterHeader()` Envoy will determine the cluster to route to by reading the value of the HTTP header named by cluster_header from the request headers.
`com.google.protobuf.ByteString`	`getClusterHeaderBytes()` Envoy will determine the cluster to route to by reading the value of the HTTP header named by cluster_header from the request headers.
`RouteAction.ClusterNotFoundResponseCode`	`getClusterNotFoundResponseCode()` The HTTP status code to use when configured cluster is not found.
`int`	`getClusterNotFoundResponseCodeValue()` The HTTP status code to use when configured cluster is not found.
`RouteAction.ClusterSpecifierCase`	`getClusterSpecifierCase()`
`CorsPolicy`	`getCors()` Indicates that the route has a CORS policy.
`CorsPolicyOrBuilder`	`getCorsOrBuilder()` Indicates that the route has a CORS policy.
`com.google.protobuf.Duration`	`getGrpcTimeoutOffset()` Deprecated.
`com.google.protobuf.DurationOrBuilder`	`getGrpcTimeoutOffsetOrBuilder()` Deprecated.
`RouteAction.HashPolicy`	`getHashPolicy(int index)` Specifies a list of hash policies to use for ring hash load balancing.
`int`	`getHashPolicyCount()` Specifies a list of hash policies to use for ring hash load balancing.
`List<RouteAction.HashPolicy>`	`getHashPolicyList()` Specifies a list of hash policies to use for ring hash load balancing.
`RouteAction.HashPolicyOrBuilder`	`getHashPolicyOrBuilder(int index)` Specifies a list of hash policies to use for ring hash load balancing.
`List<? extends RouteAction.HashPolicyOrBuilder>`	`getHashPolicyOrBuilderList()` Specifies a list of hash policies to use for ring hash load balancing.
`HedgePolicy`	`getHedgePolicy()` Indicates that the route has a hedge policy.
`HedgePolicyOrBuilder`	`getHedgePolicyOrBuilder()` Indicates that the route has a hedge policy.
`String`	`getHostRewriteHeader()` 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.
`com.google.protobuf.ByteString`	`getHostRewriteHeaderBytes()` 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.
`String`	`getHostRewriteLiteral()` Indicates that during forwarding, the host header will be swapped with this value.
`com.google.protobuf.ByteString`	`getHostRewriteLiteralBytes()` Indicates that during forwarding, the host header will be swapped with this value.
`RegexMatchAndSubstitute`	`getHostRewritePathRegex()` 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.
`RegexMatchAndSubstituteOrBuilder`	`getHostRewritePathRegexOrBuilder()` 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.
`RouteAction.HostRewriteSpecifierCase`	`getHostRewriteSpecifierCase()`
`com.google.protobuf.Duration`	`getIdleTimeout()` Specifies the idle timeout for the route.
`com.google.protobuf.DurationOrBuilder`	`getIdleTimeoutOrBuilder()` Specifies the idle timeout for the route.
`com.google.protobuf.BoolValue`	`getIncludeVhRateLimits()` Deprecated.
`com.google.protobuf.BoolValueOrBuilder`	`getIncludeVhRateLimitsOrBuilder()` Deprecated.
`RouteAction.InternalRedirectAction`	`getInternalRedirectAction()` Deprecated.
`int`	`getInternalRedirectActionValue()` Deprecated.
`InternalRedirectPolicy`	`getInternalRedirectPolicy()` If present, Envoy will try to follow an upstream redirect response instead of proxying the response back to the downstream.
`InternalRedirectPolicyOrBuilder`	`getInternalRedirectPolicyOrBuilder()` If present, Envoy will try to follow an upstream redirect response instead of proxying the response back to the downstream.
`com.google.protobuf.Duration`	`getMaxGrpcTimeout()` Deprecated.
`com.google.protobuf.DurationOrBuilder`	`getMaxGrpcTimeoutOrBuilder()` Deprecated.
`com.google.protobuf.UInt32Value`	`getMaxInternalRedirects()` Deprecated.
`com.google.protobuf.UInt32ValueOrBuilder`	`getMaxInternalRedirectsOrBuilder()` Deprecated.
`RouteAction.MaxStreamDuration`	`getMaxStreamDuration()` Specifies the maximum stream duration for this route.
`RouteAction.MaxStreamDurationOrBuilder`	`getMaxStreamDurationOrBuilder()` Specifies the maximum stream duration for this route.
`Metadata`	`getMetadataMatch()` Optional endpoint metadata match criteria used by the subset load balancer.
`MetadataOrBuilder`	`getMetadataMatchOrBuilder()` Optional endpoint metadata match criteria used by the subset load balancer.
`String`	`getPrefixRewrite()` Indicates that during forwarding, the matched prefix (or path) should be swapped with this value.
`com.google.protobuf.ByteString`	`getPrefixRewriteBytes()` Indicates that during forwarding, the matched prefix (or path) should be swapped with this value.
`RoutingPriority`	`getPriority()` Optionally specifies the :ref:`routing priority <arch_overview_http_routing_priority>`.
`int`	`getPriorityValue()` Optionally specifies the :ref:`routing priority <arch_overview_http_routing_priority>`.
`RateLimit`	`getRateLimits(int index)` Specifies a set of rate limit configurations that could be applied to the route.
`int`	`getRateLimitsCount()` Specifies a set of rate limit configurations that could be applied to the route.
`List<RateLimit>`	`getRateLimitsList()` Specifies a set of rate limit configurations that could be applied to the route.
`RateLimitOrBuilder`	`getRateLimitsOrBuilder(int index)` Specifies a set of rate limit configurations that could be applied to the route.
`List<? extends RateLimitOrBuilder>`	`getRateLimitsOrBuilderList()` Specifies a set of rate limit configurations that could be applied to the route.
`RegexMatchAndSubstitute`	`getRegexRewrite()` 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.
`RegexMatchAndSubstituteOrBuilder`	`getRegexRewriteOrBuilder()` 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.
`RouteAction.RequestMirrorPolicy`	`getRequestMirrorPolicies(int index)` Indicates that the route has request mirroring policies.
`int`	`getRequestMirrorPoliciesCount()` Indicates that the route has request mirroring policies.
`List<RouteAction.RequestMirrorPolicy>`	`getRequestMirrorPoliciesList()` Indicates that the route has request mirroring policies.
`RouteAction.RequestMirrorPolicyOrBuilder`	`getRequestMirrorPoliciesOrBuilder(int index)` Indicates that the route has request mirroring policies.
`List<? extends RouteAction.RequestMirrorPolicyOrBuilder>`	`getRequestMirrorPoliciesOrBuilderList()` Indicates that the route has request mirroring policies.
`RetryPolicy`	`getRetryPolicy()` Indicates that the route has a retry policy.
`RetryPolicyOrBuilder`	`getRetryPolicyOrBuilder()` Indicates that the route has a retry policy.
`com.google.protobuf.Any`	`getRetryPolicyTypedConfig()` [#not-implemented-hide:] Specifies the configuration for retry policy extension.
`com.google.protobuf.AnyOrBuilder`	`getRetryPolicyTypedConfigOrBuilder()` [#not-implemented-hide:] Specifies the configuration for retry policy extension.
`com.google.protobuf.Duration`	`getTimeout()` Specifies the upstream timeout for the route.
`com.google.protobuf.DurationOrBuilder`	`getTimeoutOrBuilder()` Specifies the upstream timeout for the route.
`RouteAction.UpgradeConfig`	`getUpgradeConfigs(int index)` `repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;`
`int`	`getUpgradeConfigsCount()` `repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;`
`List<RouteAction.UpgradeConfig>`	`getUpgradeConfigsList()` `repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;`
`RouteAction.UpgradeConfigOrBuilder`	`getUpgradeConfigsOrBuilder(int index)` `repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;`
`List<? extends RouteAction.UpgradeConfigOrBuilder>`	`getUpgradeConfigsOrBuilderList()` `repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;`
`WeightedCluster`	`getWeightedClusters()` Multiple upstream clusters can be specified for a given route.
`WeightedClusterOrBuilder`	`getWeightedClustersOrBuilder()` Multiple upstream clusters can be specified for a given route.
`boolean`	`hasAutoHostRewrite()` Indicates that during forwarding, the host header will be swapped with the hostname of the upstream host chosen by the cluster manager.
`boolean`	`hasCors()` Indicates that the route has a CORS policy.
`boolean`	`hasGrpcTimeoutOffset()` Deprecated.
`boolean`	`hasHedgePolicy()` Indicates that the route has a hedge policy.
`boolean`	`hasHostRewritePathRegex()` 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.
`boolean`	`hasIdleTimeout()` Specifies the idle timeout for the route.
`boolean`	`hasIncludeVhRateLimits()` Deprecated.
`boolean`	`hasInternalRedirectPolicy()` If present, Envoy will try to follow an upstream redirect response instead of proxying the response back to the downstream.
`boolean`	`hasMaxGrpcTimeout()` Deprecated.
`boolean`	`hasMaxInternalRedirects()` Deprecated.
`boolean`	`hasMaxStreamDuration()` Specifies the maximum stream duration for this route.
`boolean`	`hasMetadataMatch()` Optional endpoint metadata match criteria used by the subset load balancer.
`boolean`	`hasRegexRewrite()` 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.
`boolean`	`hasRetryPolicy()` Indicates that the route has a retry policy.
`boolean`	`hasRetryPolicyTypedConfig()` [#not-implemented-hide:] Specifies the configuration for retry policy extension.
`boolean`	`hasTimeout()` Specifies the upstream timeout for the route.
`boolean`	`hasWeightedClusters()` Multiple upstream clusters can be specified for a given route.

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

Method Detail

getCluster

String getCluster()

 Indicates the upstream cluster to which the request should be routed
 to.

string cluster = 1 [(.validate.rules) = { ... }

getClusterBytes

com.google.protobuf.ByteString getClusterBytes()

 Indicates the upstream cluster to which the request should be routed
 to.

string cluster = 1 [(.validate.rules) = { ... }

getClusterHeader

String getClusterHeader()

 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.

string cluster_header = 2 [(.validate.rules) = { ... }

getClusterHeaderBytes

com.google.protobuf.ByteString getClusterHeaderBytes()

 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.

string cluster_header = 2 [(.validate.rules) = { ... }

hasWeightedClusters

boolean hasWeightedClusters()

 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.

.envoy.config.route.v3.WeightedCluster weighted_clusters = 3;

getWeightedClusters

WeightedCluster getWeightedClusters()

 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.

.envoy.config.route.v3.WeightedCluster weighted_clusters = 3;

getWeightedClustersOrBuilder

WeightedClusterOrBuilder getWeightedClustersOrBuilder()

 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.

.envoy.config.route.v3.WeightedCluster weighted_clusters = 3;

getClusterNotFoundResponseCodeValue

int getClusterNotFoundResponseCodeValue()

 The HTTP status code to use when configured cluster is not found.
 The default response code is 503 Service Unavailable.

.envoy.config.route.v3.RouteAction.ClusterNotFoundResponseCode cluster_not_found_response_code = 20 [(.validate.rules) = { ... }

getClusterNotFoundResponseCode

RouteAction.ClusterNotFoundResponseCode getClusterNotFoundResponseCode()

 The HTTP status code to use when configured cluster is not found.
 The default response code is 503 Service Unavailable.

.envoy.config.route.v3.RouteAction.ClusterNotFoundResponseCode cluster_not_found_response_code = 20 [(.validate.rules) = { ... }

hasMetadataMatch

boolean hasMetadataMatch()

 Optional endpoint metadata match criteria used by the subset load balancer. Only endpoints
 in the upstream cluster with metadata matching what's set in this field will be considered
 for load balancing. If using :ref:`weighted_clusters
 <envoy_api_field_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*.

.envoy.config.core.v3.Metadata metadata_match = 4;

getMetadataMatch

Metadata getMetadataMatch()

 Optional endpoint metadata match criteria used by the subset load balancer. Only endpoints
 in the upstream cluster with metadata matching what's set in this field will be considered
 for load balancing. If using :ref:`weighted_clusters
 <envoy_api_field_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*.

.envoy.config.core.v3.Metadata metadata_match = 4;

getMetadataMatchOrBuilder

MetadataOrBuilder getMetadataMatchOrBuilder()

 Optional endpoint metadata match criteria used by the subset load balancer. Only endpoints
 in the upstream cluster with metadata matching what's set in this field will be considered
 for load balancing. If using :ref:`weighted_clusters
 <envoy_api_field_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*.

.envoy.config.core.v3.Metadata metadata_match = 4;

getPrefixRewrite

String getPrefixRewrite()

 Indicates that during forwarding, the matched prefix (or path) should be
 swapped with this value. This option allows application URLs to be rooted
 at a different path from those exposed at the reverse proxy layer. The router filter will
 place the original path before rewrite into the :ref:`x-envoy-original-path
 <config_http_filters_router_x-envoy-original-path>` header.
 Only one of *prefix_rewrite* or
 :ref:`regex_rewrite <envoy_api_field_config.route.v3.RouteAction.regex_rewrite>`
 may be specified.
 .. attention::
   Pay careful attention to the use of trailing slashes in the
   :ref:`route's match <envoy_api_field_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_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*.

string prefix_rewrite = 5 [(.validate.rules) = { ... }

getPrefixRewriteBytes

com.google.protobuf.ByteString getPrefixRewriteBytes()

 Indicates that during forwarding, the matched prefix (or path) should be
 swapped with this value. This option allows application URLs to be rooted
 at a different path from those exposed at the reverse proxy layer. The router filter will
 place the original path before rewrite into the :ref:`x-envoy-original-path
 <config_http_filters_router_x-envoy-original-path>` header.
 Only one of *prefix_rewrite* or
 :ref:`regex_rewrite <envoy_api_field_config.route.v3.RouteAction.regex_rewrite>`
 may be specified.
 .. attention::
   Pay careful attention to the use of trailing slashes in the
   :ref:`route's match <envoy_api_field_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_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*.

string prefix_rewrite = 5 [(.validate.rules) = { ... }

hasRegexRewrite

boolean hasRegexRewrite()

 Indicates that during forwarding, portions of the path that match the
 pattern should be rewritten, even allowing the substitution of capture
 groups from the pattern into the new path as specified by the rewrite
 substitution string. This is useful to allow application paths to be
 rewritten in a way that is aware of segments with variable content like
 identifiers. The router filter will place the original path as it was
 before the rewrite into the :ref:`x-envoy-original-path
 <config_http_filters_router_x-envoy-original-path>` header.
 Only one of :ref:`prefix_rewrite <envoy_api_field_config.route.v3.RouteAction.prefix_rewrite>`
 or *regex_rewrite* may be specified.
 Examples using Google's `RE2 <https://github.com/google/re2>`_ engine:
 * The path pattern ``^/service/([^/]+)(/.*)$`` paired with a substitution
   string of ``\2/instance/\1`` would transform ``/service/foo/v1/api``
   into ``/v1/api/instance/foo``.
 * The pattern ``one`` paired with a substitution string of ``two`` would
   transform ``/xxx/one/yyy/one/zzz`` into ``/xxx/two/yyy/two/zzz``.
 * The pattern ``^(.*?)one(.*)$`` paired with a substitution string of
   ``\1two\2`` would replace only the first occurrence of ``one``,
   transforming path ``/xxx/one/yyy/one/zzz`` into ``/xxx/two/yyy/one/zzz``.
 * The pattern ``(?i)/xxx/`` paired with a substitution string of ``/yyy/``
   would do a case-insensitive match and transform path ``/aaa/XxX/bbb`` to
   ``/aaa/yyy/bbb``.

.envoy.type.matcher.v3.RegexMatchAndSubstitute regex_rewrite = 32;

getRegexRewrite

RegexMatchAndSubstitute getRegexRewrite()

 Indicates that during forwarding, portions of the path that match the
 pattern should be rewritten, even allowing the substitution of capture
 groups from the pattern into the new path as specified by the rewrite
 substitution string. This is useful to allow application paths to be
 rewritten in a way that is aware of segments with variable content like
 identifiers. The router filter will place the original path as it was
 before the rewrite into the :ref:`x-envoy-original-path
 <config_http_filters_router_x-envoy-original-path>` header.
 Only one of :ref:`prefix_rewrite <envoy_api_field_config.route.v3.RouteAction.prefix_rewrite>`
 or *regex_rewrite* may be specified.
 Examples using Google's `RE2 <https://github.com/google/re2>`_ engine:
 * The path pattern ``^/service/([^/]+)(/.*)$`` paired with a substitution
   string of ``\2/instance/\1`` would transform ``/service/foo/v1/api``
   into ``/v1/api/instance/foo``.
 * The pattern ``one`` paired with a substitution string of ``two`` would
   transform ``/xxx/one/yyy/one/zzz`` into ``/xxx/two/yyy/two/zzz``.
 * The pattern ``^(.*?)one(.*)$`` paired with a substitution string of
   ``\1two\2`` would replace only the first occurrence of ``one``,
   transforming path ``/xxx/one/yyy/one/zzz`` into ``/xxx/two/yyy/one/zzz``.
 * The pattern ``(?i)/xxx/`` paired with a substitution string of ``/yyy/``
   would do a case-insensitive match and transform path ``/aaa/XxX/bbb`` to
   ``/aaa/yyy/bbb``.

.envoy.type.matcher.v3.RegexMatchAndSubstitute regex_rewrite = 32;

getRegexRewriteOrBuilder

RegexMatchAndSubstituteOrBuilder getRegexRewriteOrBuilder()

 Indicates that during forwarding, portions of the path that match the
 pattern should be rewritten, even allowing the substitution of capture
 groups from the pattern into the new path as specified by the rewrite
 substitution string. This is useful to allow application paths to be
 rewritten in a way that is aware of segments with variable content like
 identifiers. The router filter will place the original path as it was
 before the rewrite into the :ref:`x-envoy-original-path
 <config_http_filters_router_x-envoy-original-path>` header.
 Only one of :ref:`prefix_rewrite <envoy_api_field_config.route.v3.RouteAction.prefix_rewrite>`
 or *regex_rewrite* may be specified.
 Examples using Google's `RE2 <https://github.com/google/re2>`_ engine:
 * The path pattern ``^/service/([^/]+)(/.*)$`` paired with a substitution
   string of ``\2/instance/\1`` would transform ``/service/foo/v1/api``
   into ``/v1/api/instance/foo``.
 * The pattern ``one`` paired with a substitution string of ``two`` would
   transform ``/xxx/one/yyy/one/zzz`` into ``/xxx/two/yyy/two/zzz``.
 * The pattern ``^(.*?)one(.*)$`` paired with a substitution string of
   ``\1two\2`` would replace only the first occurrence of ``one``,
   transforming path ``/xxx/one/yyy/one/zzz`` into ``/xxx/two/yyy/one/zzz``.
 * The pattern ``(?i)/xxx/`` paired with a substitution string of ``/yyy/``
   would do a case-insensitive match and transform path ``/aaa/XxX/bbb`` to
   ``/aaa/yyy/bbb``.

.envoy.type.matcher.v3.RegexMatchAndSubstitute regex_rewrite = 32;

getHostRewriteLiteral

String getHostRewriteLiteral()

 Indicates that during forwarding, the host header will be swapped with
 this value.

string host_rewrite_literal = 6 [(.validate.rules) = { ... }

getHostRewriteLiteralBytes

com.google.protobuf.ByteString getHostRewriteLiteralBytes()

 Indicates that during forwarding, the host header will be swapped with
 this value.

string host_rewrite_literal = 6 [(.validate.rules) = { ... }

hasAutoHostRewrite

boolean hasAutoHostRewrite()

 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.

.google.protobuf.BoolValue auto_host_rewrite = 7;

getAutoHostRewrite

com.google.protobuf.BoolValue getAutoHostRewrite()

 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.

.google.protobuf.BoolValue auto_host_rewrite = 7;

getAutoHostRewriteOrBuilder

com.google.protobuf.BoolValueOrBuilder getAutoHostRewriteOrBuilder()

 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.

.google.protobuf.BoolValue auto_host_rewrite = 7;

getHostRewriteHeader

String getHostRewriteHeader()

 Indicates that during forwarding, the host header will be swapped with the content of given
 downstream or :ref:`custom <config_http_conn_man_headers_custom_request_headers>` header.
 If header value is empty, host header is left intact.
 .. attention::
   Pay attention to the potential security implications of using this option. Provided header
   must come from trusted source.
 .. note::
   If the header appears multiple times only the first value is used.

string host_rewrite_header = 29 [(.validate.rules) = { ... }

getHostRewriteHeaderBytes

com.google.protobuf.ByteString getHostRewriteHeaderBytes()

 Indicates that during forwarding, the host header will be swapped with the content of given
 downstream or :ref:`custom <config_http_conn_man_headers_custom_request_headers>` header.
 If header value is empty, host header is left intact.
 .. attention::
   Pay attention to the potential security implications of using this option. Provided header
   must come from trusted source.
 .. note::
   If the header appears multiple times only the first value is used.

string host_rewrite_header = 29 [(.validate.rules) = { ... }

hasHostRewritePathRegex

boolean hasHostRewritePathRegex()

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

.envoy.type.matcher.v3.RegexMatchAndSubstitute host_rewrite_path_regex = 35;

getHostRewritePathRegex

RegexMatchAndSubstitute getHostRewritePathRegex()

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

.envoy.type.matcher.v3.RegexMatchAndSubstitute host_rewrite_path_regex = 35;

getHostRewritePathRegexOrBuilder

RegexMatchAndSubstituteOrBuilder getHostRewritePathRegexOrBuilder()

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

.envoy.type.matcher.v3.RegexMatchAndSubstitute host_rewrite_path_regex = 35;

hasTimeout

boolean hasTimeout()

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

.google.protobuf.Duration timeout = 8;

getTimeout

com.google.protobuf.Duration getTimeout()

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

.google.protobuf.Duration timeout = 8;

getTimeoutOrBuilder

com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder()

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

.google.protobuf.Duration timeout = 8;

hasIdleTimeout

boolean hasIdleTimeout()

 Specifies the idle timeout for the route. If not specified, there is no per-route idle timeout,
 although the connection manager wide :ref:`stream_idle_timeout
 <envoy_api_field_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_api_field_config.route.v3.RouteAction.timeout>`, which provides an upper bound
 on the upstream response time; :ref:`idle_timeout
 <envoy_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_api_enum_value_config.overload.v3.ScaleTimersOverloadActionConfig.TimerType.HTTP_DOWNSTREAM_STREAM_IDLE>`.

.google.protobuf.Duration idle_timeout = 24;

getIdleTimeout

com.google.protobuf.Duration getIdleTimeout()

 Specifies the idle timeout for the route. If not specified, there is no per-route idle timeout,
 although the connection manager wide :ref:`stream_idle_timeout
 <envoy_api_field_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_api_field_config.route.v3.RouteAction.timeout>`, which provides an upper bound
 on the upstream response time; :ref:`idle_timeout
 <envoy_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_api_enum_value_config.overload.v3.ScaleTimersOverloadActionConfig.TimerType.HTTP_DOWNSTREAM_STREAM_IDLE>`.

.google.protobuf.Duration idle_timeout = 24;

getIdleTimeoutOrBuilder

com.google.protobuf.DurationOrBuilder getIdleTimeoutOrBuilder()

 Specifies the idle timeout for the route. If not specified, there is no per-route idle timeout,
 although the connection manager wide :ref:`stream_idle_timeout
 <envoy_api_field_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_api_field_config.route.v3.RouteAction.timeout>`, which provides an upper bound
 on the upstream response time; :ref:`idle_timeout
 <envoy_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_api_enum_value_config.overload.v3.ScaleTimersOverloadActionConfig.TimerType.HTTP_DOWNSTREAM_STREAM_IDLE>`.

.google.protobuf.Duration idle_timeout = 24;

hasRetryPolicy

boolean hasRetryPolicy()

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

.envoy.config.route.v3.RetryPolicy retry_policy = 9;

getRetryPolicy

RetryPolicy getRetryPolicy()

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

.envoy.config.route.v3.RetryPolicy retry_policy = 9;

getRetryPolicyOrBuilder

RetryPolicyOrBuilder getRetryPolicyOrBuilder()

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

.envoy.config.route.v3.RetryPolicy retry_policy = 9;

hasRetryPolicyTypedConfig

boolean hasRetryPolicyTypedConfig()

 [#not-implemented-hide:]
 Specifies the configuration for retry policy extension. Note that if this is set, it'll take
 precedence over the virtual host level retry policy entirely (e.g.: policies are not merged,
 most internal one becomes the enforced policy). :ref:`Retry policy <envoy_api_field_config.route.v3.VirtualHost.retry_policy>`
 should not be set if this field is used.

.google.protobuf.Any retry_policy_typed_config = 33;

getRetryPolicyTypedConfig

com.google.protobuf.Any getRetryPolicyTypedConfig()

 [#not-implemented-hide:]
 Specifies the configuration for retry policy extension. Note that if this is set, it'll take
 precedence over the virtual host level retry policy entirely (e.g.: policies are not merged,
 most internal one becomes the enforced policy). :ref:`Retry policy <envoy_api_field_config.route.v3.VirtualHost.retry_policy>`
 should not be set if this field is used.

.google.protobuf.Any retry_policy_typed_config = 33;

getRetryPolicyTypedConfigOrBuilder

com.google.protobuf.AnyOrBuilder getRetryPolicyTypedConfigOrBuilder()

 [#not-implemented-hide:]
 Specifies the configuration for retry policy extension. Note that if this is set, it'll take
 precedence over the virtual host level retry policy entirely (e.g.: policies are not merged,
 most internal one becomes the enforced policy). :ref:`Retry policy <envoy_api_field_config.route.v3.VirtualHost.retry_policy>`
 should not be set if this field is used.

.google.protobuf.Any retry_policy_typed_config = 33;

getRequestMirrorPoliciesList

List<RouteAction.RequestMirrorPolicy> getRequestMirrorPoliciesList()

 Indicates that the route has request mirroring policies.

repeated .envoy.config.route.v3.RouteAction.RequestMirrorPolicy request_mirror_policies = 30;

getRequestMirrorPolicies

RouteAction.RequestMirrorPolicy getRequestMirrorPolicies(int index)

 Indicates that the route has request mirroring policies.

repeated .envoy.config.route.v3.RouteAction.RequestMirrorPolicy request_mirror_policies = 30;

getRequestMirrorPoliciesCount
```
int getRequestMirrorPoliciesCount()
```
```
 Indicates that the route has request mirroring policies.
 
```
repeated .envoy.config.route.v3.RouteAction.RequestMirrorPolicy request_mirror_policies = 30;

getRequestMirrorPoliciesOrBuilderList

List<? extends RouteAction.RequestMirrorPolicyOrBuilder> getRequestMirrorPoliciesOrBuilderList()

 Indicates that the route has request mirroring policies.

repeated .envoy.config.route.v3.RouteAction.RequestMirrorPolicy request_mirror_policies = 30;

getRequestMirrorPoliciesOrBuilder

RouteAction.RequestMirrorPolicyOrBuilder getRequestMirrorPoliciesOrBuilder(int index)

 Indicates that the route has request mirroring policies.

repeated .envoy.config.route.v3.RouteAction.RequestMirrorPolicy request_mirror_policies = 30;

getPriorityValue

int getPriorityValue()

 Optionally specifies the :ref:`routing priority <arch_overview_http_routing_priority>`.

.envoy.config.core.v3.RoutingPriority priority = 11 [(.validate.rules) = { ... }

getPriority

RoutingPriority getPriority()

 Optionally specifies the :ref:`routing priority <arch_overview_http_routing_priority>`.

.envoy.config.core.v3.RoutingPriority priority = 11 [(.validate.rules) = { ... }