Interface RouteActionOrBuilder
-
- 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 Description boolean
getAppendXForwardedHost()
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.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.java.lang.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.java.lang.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()
java.lang.String
getClusterSpecifierPlugin()
Name of the cluster specifier plugin to use to determine the cluster for requests on this route.com.google.protobuf.ByteString
getClusterSpecifierPluginBytes()
Name of the cluster specifier plugin to use to determine the cluster for requests on this route.CorsPolicy
getCors()
Deprecated.envoy.config.route.v3.RouteAction.cors is deprecated.CorsPolicyOrBuilder
getCorsOrBuilder()
Deprecated.TypedExtensionConfig
getEarlyDataPolicy()
Specifies how to send request over TLS early data.TypedExtensionConfigOrBuilder
getEarlyDataPolicyOrBuilder()
Specifies how to send request over TLS early data.com.google.protobuf.Duration
getGrpcTimeoutOffset()
Deprecated.envoy.config.route.v3.RouteAction.grpc_timeout_offset is 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.java.util.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.java.util.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.java.lang.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.java.lang.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.envoy.config.route.v3.RouteAction.include_vh_rate_limits is deprecated.com.google.protobuf.BoolValueOrBuilder
getIncludeVhRateLimitsOrBuilder()
Deprecated.ClusterSpecifierPlugin
getInlineClusterSpecifierPlugin()
Custom cluster specifier plugin configuration to use to determine the cluster for requests on this route.ClusterSpecifierPluginOrBuilder
getInlineClusterSpecifierPluginOrBuilder()
Custom cluster specifier plugin configuration to use to determine the cluster for requests on this route.RouteAction.InternalRedirectAction
getInternalRedirectAction()
Deprecated.envoy.config.route.v3.RouteAction.internal_redirect_action is deprecated.int
getInternalRedirectActionValue()
Deprecated.envoy.config.route.v3.RouteAction.internal_redirect_action is 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.envoy.config.route.v3.RouteAction.max_grpc_timeout is deprecated.com.google.protobuf.DurationOrBuilder
getMaxGrpcTimeoutOrBuilder()
Deprecated.com.google.protobuf.UInt32Value
getMaxInternalRedirects()
Deprecated.envoy.config.route.v3.RouteAction.max_internal_redirects is 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.TypedExtensionConfig
getPathRewritePolicy()
[#extension-category: envoy.path.rewrite]TypedExtensionConfigOrBuilder
getPathRewritePolicyOrBuilder()
[#extension-category: envoy.path.rewrite]java.lang.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.java.util.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.java.util.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)
Specify a set of route request mirroring policies.int
getRequestMirrorPoliciesCount()
Specify a set of route request mirroring policies.java.util.List<RouteAction.RequestMirrorPolicy>
getRequestMirrorPoliciesList()
Specify a set of route request mirroring policies.RouteAction.RequestMirrorPolicyOrBuilder
getRequestMirrorPoliciesOrBuilder(int index)
Specify a set of route request mirroring policies.java.util.List<? extends RouteAction.RequestMirrorPolicyOrBuilder>
getRequestMirrorPoliciesOrBuilderList()
Specify a set of route 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;
java.util.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;
java.util.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
hasCluster()
Indicates the upstream cluster to which the request should be routed to.boolean
hasClusterHeader()
Envoy will determine the cluster to route to by reading the value of the HTTP header named by cluster_header from the request headers.boolean
hasClusterSpecifierPlugin()
Name of the cluster specifier plugin to use to determine the cluster for requests on this route.boolean
hasCors()
Deprecated.envoy.config.route.v3.RouteAction.cors is deprecated.boolean
hasEarlyDataPolicy()
Specifies how to send request over TLS early data.boolean
hasGrpcTimeoutOffset()
Deprecated.envoy.config.route.v3.RouteAction.grpc_timeout_offset is deprecated.boolean
hasHedgePolicy()
Indicates that the route has a hedge policy.boolean
hasHostRewriteHeader()
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.boolean
hasHostRewriteLiteral()
Indicates that during forwarding, the host header will be swapped with this value.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.envoy.config.route.v3.RouteAction.include_vh_rate_limits is deprecated.boolean
hasInlineClusterSpecifierPlugin()
Custom cluster specifier plugin configuration to use to determine the cluster for requests on this route.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.envoy.config.route.v3.RouteAction.max_grpc_timeout is deprecated.boolean
hasMaxInternalRedirects()
Deprecated.envoy.config.route.v3.RouteAction.max_internal_redirects is 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
hasPathRewritePolicy()
[#extension-category: envoy.path.rewrite]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
-
-
-
-
Method Detail
-
hasCluster
boolean hasCluster()
Indicates the upstream cluster to which the request should be routed to.
string cluster = 1 [(.validate.rules) = { ... }
- Returns:
- Whether the cluster field is set.
-
getCluster
java.lang.String getCluster()
Indicates the upstream cluster to which the request should be routed to.
string cluster = 1 [(.validate.rules) = { ... }
- Returns:
- The cluster.
-
getClusterBytes
com.google.protobuf.ByteString getClusterBytes()
Indicates the upstream cluster to which the request should be routed to.
string cluster = 1 [(.validate.rules) = { ... }
- Returns:
- The bytes for cluster.
-
hasClusterHeader
boolean hasClusterHeader()
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) = { ... }
- Returns:
- Whether the clusterHeader field is set.
-
getClusterHeader
java.lang.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) = { ... }
- Returns:
- The clusterHeader.
-
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) = { ... }
- Returns:
- The bytes for clusterHeader.
-
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;
- Returns:
- Whether the weightedClusters field is set.
-
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;
- Returns:
- The weightedClusters.
-
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;
-
hasClusterSpecifierPlugin
boolean hasClusterSpecifierPlugin()
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.
string cluster_specifier_plugin = 37;
- Returns:
- Whether the clusterSpecifierPlugin field is set.
-
getClusterSpecifierPlugin
java.lang.String getClusterSpecifierPlugin()
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.
string cluster_specifier_plugin = 37;
- Returns:
- The clusterSpecifierPlugin.
-
getClusterSpecifierPluginBytes
com.google.protobuf.ByteString getClusterSpecifierPluginBytes()
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.
string cluster_specifier_plugin = 37;
- Returns:
- The bytes for clusterSpecifierPlugin.
-
hasInlineClusterSpecifierPlugin
boolean hasInlineClusterSpecifierPlugin()
Custom cluster specifier plugin configuration to use to determine the cluster for requests on this route.
.envoy.config.route.v3.ClusterSpecifierPlugin inline_cluster_specifier_plugin = 39;
- Returns:
- Whether the inlineClusterSpecifierPlugin field is set.
-
getInlineClusterSpecifierPlugin
ClusterSpecifierPlugin getInlineClusterSpecifierPlugin()
Custom cluster specifier plugin configuration to use to determine the cluster for requests on this route.
.envoy.config.route.v3.ClusterSpecifierPlugin inline_cluster_specifier_plugin = 39;
- Returns:
- The inlineClusterSpecifierPlugin.
-
getInlineClusterSpecifierPluginOrBuilder
ClusterSpecifierPluginOrBuilder getInlineClusterSpecifierPluginOrBuilder()
Custom cluster specifier plugin configuration to use to determine the cluster for requests on this route.
.envoy.config.route.v3.ClusterSpecifierPlugin inline_cluster_specifier_plugin = 39;
-
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) = { ... }
- Returns:
- The enum numeric value on the wire for clusterNotFoundResponseCode.
-
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) = { ... }
- Returns:
- The clusterNotFoundResponseCode.
-
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_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``.
.envoy.config.core.v3.Metadata metadata_match = 4;
- Returns:
- Whether the metadataMatch field is set.
-
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_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``.
.envoy.config.core.v3.Metadata metadata_match = 4;
- Returns:
- The metadataMatch.
-
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_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``.
.envoy.config.core.v3.Metadata metadata_match = 4;
-
getPrefixRewrite
java.lang.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 :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``.
string prefix_rewrite = 5 [(.validate.rules) = { ... }
- Returns:
- The prefixRewrite.
-
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 :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``.
string prefix_rewrite = 5 [(.validate.rules) = { ... }
- Returns:
- The bytes for prefixRewrite.
-
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:`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``.
.envoy.type.matcher.v3.RegexMatchAndSubstitute regex_rewrite = 32;
- Returns:
- Whether the regexRewrite field is set.
-
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:`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``.
.envoy.type.matcher.v3.RegexMatchAndSubstitute regex_rewrite = 32;
- Returns:
- The regexRewrite.
-
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:`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``.
.envoy.type.matcher.v3.RegexMatchAndSubstitute regex_rewrite = 32;
-
hasPathRewritePolicy
boolean hasPathRewritePolicy()
[#extension-category: envoy.path.rewrite]
.envoy.config.core.v3.TypedExtensionConfig path_rewrite_policy = 41;
- Returns:
- Whether the pathRewritePolicy field is set.
-
getPathRewritePolicy
TypedExtensionConfig getPathRewritePolicy()
[#extension-category: envoy.path.rewrite]
.envoy.config.core.v3.TypedExtensionConfig path_rewrite_policy = 41;
- Returns:
- The pathRewritePolicy.
-
getPathRewritePolicyOrBuilder
TypedExtensionConfigOrBuilder getPathRewritePolicyOrBuilder()
[#extension-category: envoy.path.rewrite]
.envoy.config.core.v3.TypedExtensionConfig path_rewrite_policy = 41;
-
hasHostRewriteLiteral
boolean hasHostRewriteLiteral()
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.
string host_rewrite_literal = 6 [(.validate.rules) = { ... }
- Returns:
- Whether the hostRewriteLiteral field is set.
-
getHostRewriteLiteral
java.lang.String getHostRewriteLiteral()
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.
string host_rewrite_literal = 6 [(.validate.rules) = { ... }
- Returns:
- The hostRewriteLiteral.
-
getHostRewriteLiteralBytes
com.google.protobuf.ByteString getHostRewriteLiteralBytes()
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.
string host_rewrite_literal = 6 [(.validate.rules) = { ... }
- Returns:
- The bytes for hostRewriteLiteral.
-
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``, or when :ref:`hostname <envoy_v3_api_field_config.endpoint.v3.Endpoint.hostname>` field is not empty. 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.
.google.protobuf.BoolValue auto_host_rewrite = 7;
- Returns:
- Whether the autoHostRewrite field is set.
-
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``, or when :ref:`hostname <envoy_v3_api_field_config.endpoint.v3.Endpoint.hostname>` field is not empty. 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.
.google.protobuf.BoolValue auto_host_rewrite = 7;
- Returns:
- The autoHostRewrite.
-
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``, or when :ref:`hostname <envoy_v3_api_field_config.endpoint.v3.Endpoint.hostname>` field is not empty. 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.
.google.protobuf.BoolValue auto_host_rewrite = 7;
-
hasHostRewriteHeader
boolean hasHostRewriteHeader()
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.
string host_rewrite_header = 29 [(.validate.rules) = { ... }
- Returns:
- Whether the hostRewriteHeader field is set.
-
getHostRewriteHeader
java.lang.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. 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.
string host_rewrite_header = 29 [(.validate.rules) = { ... }
- Returns:
- The hostRewriteHeader.
-
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. 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.
string host_rewrite_header = 29 [(.validate.rules) = { ... }
- Returns:
- The bytes for hostRewriteHeader.
-
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. 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``.
.envoy.type.matcher.v3.RegexMatchAndSubstitute host_rewrite_path_regex = 35;
- Returns:
- Whether the hostRewritePathRegex field is set.
-
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. 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``.
.envoy.type.matcher.v3.RegexMatchAndSubstitute host_rewrite_path_regex = 35;
- Returns:
- The hostRewritePathRegex.
-
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. 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``.
.envoy.type.matcher.v3.RegexMatchAndSubstitute host_rewrite_path_regex = 35;
-
getAppendXForwardedHost
boolean getAppendXForwardedHost()
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.
bool append_x_forwarded_host = 38;
- Returns:
- The appendXForwardedHost.
-
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;
- Returns:
- Whether the timeout field is set.
-
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;
- Returns:
- The timeout.
-
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_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>`.
.google.protobuf.Duration idle_timeout = 24;
- Returns:
- Whether the idleTimeout field is set.
-
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_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>`.
.google.protobuf.Duration idle_timeout = 24;
- Returns:
- The idleTimeout.
-
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_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>`.
.google.protobuf.Duration idle_timeout = 24;
-
hasEarlyDataPolicy
boolean hasEarlyDataPolicy()
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]
.envoy.config.core.v3.TypedExtensionConfig early_data_policy = 40;
- Returns:
- Whether the earlyDataPolicy field is set.
-
getEarlyDataPolicy
TypedExtensionConfig getEarlyDataPolicy()
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]
.envoy.config.core.v3.TypedExtensionConfig early_data_policy = 40;
- Returns:
- The earlyDataPolicy.
-
getEarlyDataPolicyOrBuilder
TypedExtensionConfigOrBuilder getEarlyDataPolicyOrBuilder()
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]
.envoy.config.core.v3.TypedExtensionConfig early_data_policy = 40;
-
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;
- Returns:
- Whether the retryPolicy field is set.
-
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;
- Returns:
- The retryPolicy.
-
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_v3_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;
- Returns:
- Whether the retryPolicyTypedConfig field is set.
-
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_v3_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;
- Returns:
- The retryPolicyTypedConfig.
-
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_v3_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
java.util.List<RouteAction.RequestMirrorPolicy> getRequestMirrorPoliciesList()
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.
repeated .envoy.config.route.v3.RouteAction.RequestMirrorPolicy request_mirror_policies = 30;
-
getRequestMirrorPolicies
RouteAction.RequestMirrorPolicy getRequestMirrorPolicies(int index)
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.
repeated .envoy.config.route.v3.RouteAction.RequestMirrorPolicy request_mirror_policies = 30;
-
getRequestMirrorPoliciesCount
int getRequestMirrorPoliciesCount()
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.
repeated .envoy.config.route.v3.RouteAction.RequestMirrorPolicy request_mirror_policies = 30;
-
getRequestMirrorPoliciesOrBuilderList
java.util.List<? extends RouteAction.RequestMirrorPolicyOrBuilder> getRequestMirrorPoliciesOrBuilderList()
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.
repeated .envoy.config.route.v3.RouteAction.RequestMirrorPolicy request_mirror_policies = 30;
-
getRequestMirrorPoliciesOrBuilder
RouteAction.RequestMirrorPolicyOrBuilder getRequestMirrorPoliciesOrBuilder(int index)
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.
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) = { ... }
- Returns:
- The enum numeric value on the wire for priority.
-
getPriority
RoutingPriority getPriority()
Optionally specifies the :ref:`routing priority <arch_overview_http_routing_priority>`.
.envoy.config.core.v3.RoutingPriority priority = 11 [(.validate.rules) = { ... }
- Returns:
- The priority.
-
getRateLimitsList
java.util.List<RateLimit> getRateLimitsList()
Specifies a set of rate limit configurations that could be applied to the route.
repeated .envoy.config.route.v3.RateLimit rate_limits = 13;
-
getRateLimits
RateLimit getRateLimits(int index)
Specifies a set of rate limit configurations that could be applied to the route.
repeated .envoy.config.route.v3.RateLimit rate_limits = 13;
-
getRateLimitsCount
int getRateLimitsCount()
Specifies a set of rate limit configurations that could be applied to the route.
repeated .envoy.config.route.v3.RateLimit rate_limits = 13;
-
getRateLimitsOrBuilderList
java.util.List<? extends RateLimitOrBuilder> getRateLimitsOrBuilderList()
Specifies a set of rate limit configurations that could be applied to the route.
repeated .envoy.config.route.v3.RateLimit rate_limits = 13;
-
getRateLimitsOrBuilder
RateLimitOrBuilder getRateLimitsOrBuilder(int index)
Specifies a set of rate limit configurations that could be applied to the route.
repeated .envoy.config.route.v3.RateLimit rate_limits = 13;
-
hasIncludeVhRateLimits
@Deprecated boolean hasIncludeVhRateLimits()
Deprecated.envoy.config.route.v3.RouteAction.include_vh_rate_limits is deprecated. See envoy/config/route/v3/route_components.proto;l=1295Specifies 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>`
.google.protobuf.BoolValue include_vh_rate_limits = 14 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Returns:
- Whether the includeVhRateLimits field is set.
-
getIncludeVhRateLimits
@Deprecated com.google.protobuf.BoolValue getIncludeVhRateLimits()
Deprecated.envoy.config.route.v3.RouteAction.include_vh_rate_limits is deprecated. See envoy/config/route/v3/route_components.proto;l=1295Specifies 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>`
.google.protobuf.BoolValue include_vh_rate_limits = 14 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Returns:
- The includeVhRateLimits.
-
getIncludeVhRateLimitsOrBuilder
@Deprecated com.google.protobuf.BoolValueOrBuilder getIncludeVhRateLimitsOrBuilder()
Deprecated.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>`
.google.protobuf.BoolValue include_vh_rate_limits = 14 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
-
getHashPolicyList
java.util.List<RouteAction.HashPolicy> getHashPolicyList()
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.
repeated .envoy.config.route.v3.RouteAction.HashPolicy hash_policy = 15;
-
getHashPolicy
RouteAction.HashPolicy getHashPolicy(int index)
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.
repeated .envoy.config.route.v3.RouteAction.HashPolicy hash_policy = 15;
-
getHashPolicyCount
int getHashPolicyCount()
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.
repeated .envoy.config.route.v3.RouteAction.HashPolicy hash_policy = 15;
-
getHashPolicyOrBuilderList
java.util.List<? extends RouteAction.HashPolicyOrBuilder> getHashPolicyOrBuilderList()
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.
repeated .envoy.config.route.v3.RouteAction.HashPolicy hash_policy = 15;
-
getHashPolicyOrBuilder
RouteAction.HashPolicyOrBuilder getHashPolicyOrBuilder(int index)
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.
repeated .envoy.config.route.v3.RouteAction.HashPolicy hash_policy = 15;
-
hasCors
@Deprecated boolean hasCors()
Deprecated.envoy.config.route.v3.RouteAction.cors is deprecated. See envoy/config/route/v3/route_components.proto;l=1322Indicates 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.
.envoy.config.route.v3.CorsPolicy cors = 17 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Returns:
- Whether the cors field is set.
-
getCors
@Deprecated CorsPolicy getCors()
Deprecated.envoy.config.route.v3.RouteAction.cors is deprecated. See envoy/config/route/v3/route_components.proto;l=1322Indicates 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.
.envoy.config.route.v3.CorsPolicy cors = 17 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Returns:
- The cors.
-
getCorsOrBuilder
@Deprecated CorsPolicyOrBuilder getCorsOrBuilder()
Deprecated.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.
.envoy.config.route.v3.CorsPolicy cors = 17 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
-
hasMaxGrpcTimeout
@Deprecated boolean hasMaxGrpcTimeout()
Deprecated.envoy.config.route.v3.RouteAction.max_grpc_timeout is deprecated. See envoy/config/route/v3/route_components.proto;l=1344Deprecated 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>`.
.google.protobuf.Duration max_grpc_timeout = 23 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Returns:
- Whether the maxGrpcTimeout field is set.
-
getMaxGrpcTimeout
@Deprecated com.google.protobuf.Duration getMaxGrpcTimeout()
Deprecated.envoy.config.route.v3.RouteAction.max_grpc_timeout is deprecated. See envoy/config/route/v3/route_components.proto;l=1344Deprecated 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>`.
.google.protobuf.Duration max_grpc_timeout = 23 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Returns:
- The maxGrpcTimeout.
-
getMaxGrpcTimeoutOrBuilder
@Deprecated com.google.protobuf.DurationOrBuilder getMaxGrpcTimeoutOrBuilder()
Deprecated.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>`.
.google.protobuf.Duration max_grpc_timeout = 23 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
-
hasGrpcTimeoutOffset
@Deprecated boolean hasGrpcTimeoutOffset()
Deprecated.envoy.config.route.v3.RouteAction.grpc_timeout_offset is deprecated. See envoy/config/route/v3/route_components.proto;l=1355Deprecated 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).
.google.protobuf.Duration grpc_timeout_offset = 28 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Returns:
- Whether the grpcTimeoutOffset field is set.
-
getGrpcTimeoutOffset
@Deprecated com.google.protobuf.Duration getGrpcTimeoutOffset()
Deprecated.envoy.config.route.v3.RouteAction.grpc_timeout_offset is deprecated. See envoy/config/route/v3/route_components.proto;l=1355Deprecated 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).
.google.protobuf.Duration grpc_timeout_offset = 28 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Returns:
- The grpcTimeoutOffset.
-
getGrpcTimeoutOffsetOrBuilder
@Deprecated com.google.protobuf.DurationOrBuilder getGrpcTimeoutOffsetOrBuilder()
Deprecated.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).
.google.protobuf.Duration grpc_timeout_offset = 28 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
-
getUpgradeConfigsList
java.util.List<RouteAction.UpgradeConfig> getUpgradeConfigsList()
repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;
-
getUpgradeConfigs
RouteAction.UpgradeConfig getUpgradeConfigs(int index)
repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;
-
getUpgradeConfigsCount
int getUpgradeConfigsCount()
repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;
-
getUpgradeConfigsOrBuilderList
java.util.List<? extends RouteAction.UpgradeConfigOrBuilder> getUpgradeConfigsOrBuilderList()
repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;
-
getUpgradeConfigsOrBuilder
RouteAction.UpgradeConfigOrBuilder getUpgradeConfigsOrBuilder(int index)
repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;
-
hasInternalRedirectPolicy
boolean hasInternalRedirectPolicy()
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>`.
.envoy.config.route.v3.InternalRedirectPolicy internal_redirect_policy = 34;
- Returns:
- Whether the internalRedirectPolicy field is set.
-
getInternalRedirectPolicy
InternalRedirectPolicy getInternalRedirectPolicy()
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>`.
.envoy.config.route.v3.InternalRedirectPolicy internal_redirect_policy = 34;
- Returns:
- The internalRedirectPolicy.
-
getInternalRedirectPolicyOrBuilder
InternalRedirectPolicyOrBuilder getInternalRedirectPolicyOrBuilder()
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>`.
.envoy.config.route.v3.InternalRedirectPolicy internal_redirect_policy = 34;
-
getInternalRedirectActionValue
@Deprecated int getInternalRedirectActionValue()
Deprecated.envoy.config.route.v3.RouteAction.internal_redirect_action is deprecated. See envoy/config/route/v3/route_components.proto;l=1366.envoy.config.route.v3.RouteAction.InternalRedirectAction internal_redirect_action = 26 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Returns:
- The enum numeric value on the wire for internalRedirectAction.
-
getInternalRedirectAction
@Deprecated RouteAction.InternalRedirectAction getInternalRedirectAction()
Deprecated.envoy.config.route.v3.RouteAction.internal_redirect_action is deprecated. See envoy/config/route/v3/route_components.proto;l=1366.envoy.config.route.v3.RouteAction.InternalRedirectAction internal_redirect_action = 26 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Returns:
- The internalRedirectAction.
-
hasMaxInternalRedirects
@Deprecated boolean hasMaxInternalRedirects()
Deprecated.envoy.config.route.v3.RouteAction.max_internal_redirects is deprecated. See envoy/config/route/v3/route_components.proto;l=1383An 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.
.google.protobuf.UInt32Value max_internal_redirects = 31 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Returns:
- Whether the maxInternalRedirects field is set.
-
getMaxInternalRedirects
@Deprecated com.google.protobuf.UInt32Value getMaxInternalRedirects()
Deprecated.envoy.config.route.v3.RouteAction.max_internal_redirects is deprecated. See envoy/config/route/v3/route_components.proto;l=1383An 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.
.google.protobuf.UInt32Value max_internal_redirects = 31 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Returns:
- The maxInternalRedirects.
-
getMaxInternalRedirectsOrBuilder
@Deprecated com.google.protobuf.UInt32ValueOrBuilder getMaxInternalRedirectsOrBuilder()
Deprecated.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.
.google.protobuf.UInt32Value max_internal_redirects = 31 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
-
hasHedgePolicy
boolean hasHedgePolicy()
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).
.envoy.config.route.v3.HedgePolicy hedge_policy = 27;
- Returns:
- Whether the hedgePolicy field is set.
-
getHedgePolicy
HedgePolicy getHedgePolicy()
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).
.envoy.config.route.v3.HedgePolicy hedge_policy = 27;
- Returns:
- The hedgePolicy.
-
getHedgePolicyOrBuilder
HedgePolicyOrBuilder getHedgePolicyOrBuilder()
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).
.envoy.config.route.v3.HedgePolicy hedge_policy = 27;
-
hasMaxStreamDuration
boolean hasMaxStreamDuration()
Specifies the maximum stream duration for this route.
.envoy.config.route.v3.RouteAction.MaxStreamDuration max_stream_duration = 36;
- Returns:
- Whether the maxStreamDuration field is set.
-
getMaxStreamDuration
RouteAction.MaxStreamDuration getMaxStreamDuration()
Specifies the maximum stream duration for this route.
.envoy.config.route.v3.RouteAction.MaxStreamDuration max_stream_duration = 36;
- Returns:
- The maxStreamDuration.
-
getMaxStreamDurationOrBuilder
RouteAction.MaxStreamDurationOrBuilder getMaxStreamDurationOrBuilder()
Specifies the maximum stream duration for this route.
.envoy.config.route.v3.RouteAction.MaxStreamDuration max_stream_duration = 36;
-
getClusterSpecifierCase
RouteAction.ClusterSpecifierCase getClusterSpecifierCase()
-
getHostRewriteSpecifierCase
RouteAction.HostRewriteSpecifierCase getHostRewriteSpecifierCase()
-
-