Class RouteAction.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderType>
-
- com.google.protobuf.GeneratedMessageV3.Builder<RouteAction.Builder>
-
- io.envoyproxy.envoy.config.route.v3.RouteAction.Builder
-
- All Implemented Interfaces:
com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,RouteActionOrBuilder,Cloneable
- Enclosing class:
- RouteAction
public static final class RouteAction.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<RouteAction.Builder> implements RouteActionOrBuilder
[#next-free-field: 42]
Protobuf typeenvoy.config.route.v3.RouteAction
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description RouteAction.BuilderaddAllHashPolicy(Iterable<? extends RouteAction.HashPolicy> values)Specifies a list of hash policies to use for ring hash load balancing.RouteAction.BuilderaddAllRateLimits(Iterable<? extends RateLimit> values)Specifies a set of rate limit configurations that could be applied to the route.RouteAction.BuilderaddAllRequestMirrorPolicies(Iterable<? extends RouteAction.RequestMirrorPolicy> values)Specify a set of route request mirroring policies.RouteAction.BuilderaddAllUpgradeConfigs(Iterable<? extends RouteAction.UpgradeConfig> values)repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;RouteAction.BuilderaddHashPolicy(int index, RouteAction.HashPolicy value)Specifies a list of hash policies to use for ring hash load balancing.RouteAction.BuilderaddHashPolicy(int index, RouteAction.HashPolicy.Builder builderForValue)Specifies a list of hash policies to use for ring hash load balancing.RouteAction.BuilderaddHashPolicy(RouteAction.HashPolicy value)Specifies a list of hash policies to use for ring hash load balancing.RouteAction.BuilderaddHashPolicy(RouteAction.HashPolicy.Builder builderForValue)Specifies a list of hash policies to use for ring hash load balancing.RouteAction.HashPolicy.BuilderaddHashPolicyBuilder()Specifies a list of hash policies to use for ring hash load balancing.RouteAction.HashPolicy.BuilderaddHashPolicyBuilder(int index)Specifies a list of hash policies to use for ring hash load balancing.RouteAction.BuilderaddRateLimits(int index, RateLimit value)Specifies a set of rate limit configurations that could be applied to the route.RouteAction.BuilderaddRateLimits(int index, RateLimit.Builder builderForValue)Specifies a set of rate limit configurations that could be applied to the route.RouteAction.BuilderaddRateLimits(RateLimit value)Specifies a set of rate limit configurations that could be applied to the route.RouteAction.BuilderaddRateLimits(RateLimit.Builder builderForValue)Specifies a set of rate limit configurations that could be applied to the route.RateLimit.BuilderaddRateLimitsBuilder()Specifies a set of rate limit configurations that could be applied to the route.RateLimit.BuilderaddRateLimitsBuilder(int index)Specifies a set of rate limit configurations that could be applied to the route.RouteAction.BuilderaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)RouteAction.BuilderaddRequestMirrorPolicies(int index, RouteAction.RequestMirrorPolicy value)Specify a set of route request mirroring policies.RouteAction.BuilderaddRequestMirrorPolicies(int index, RouteAction.RequestMirrorPolicy.Builder builderForValue)Specify a set of route request mirroring policies.RouteAction.BuilderaddRequestMirrorPolicies(RouteAction.RequestMirrorPolicy value)Specify a set of route request mirroring policies.RouteAction.BuilderaddRequestMirrorPolicies(RouteAction.RequestMirrorPolicy.Builder builderForValue)Specify a set of route request mirroring policies.RouteAction.RequestMirrorPolicy.BuilderaddRequestMirrorPoliciesBuilder()Specify a set of route request mirroring policies.RouteAction.RequestMirrorPolicy.BuilderaddRequestMirrorPoliciesBuilder(int index)Specify a set of route request mirroring policies.RouteAction.BuilderaddUpgradeConfigs(int index, RouteAction.UpgradeConfig value)repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;RouteAction.BuilderaddUpgradeConfigs(int index, RouteAction.UpgradeConfig.Builder builderForValue)repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;RouteAction.BuilderaddUpgradeConfigs(RouteAction.UpgradeConfig value)repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;RouteAction.BuilderaddUpgradeConfigs(RouteAction.UpgradeConfig.Builder builderForValue)repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;RouteAction.UpgradeConfig.BuilderaddUpgradeConfigsBuilder()repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;RouteAction.UpgradeConfig.BuilderaddUpgradeConfigsBuilder(int index)repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;RouteActionbuild()RouteActionbuildPartial()RouteAction.Builderclear()RouteAction.BuilderclearAppendXForwardedHost()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.RouteAction.BuilderclearAutoHostRewrite()Indicates that during forwarding, the host header will be swapped with the hostname of the upstream host chosen by the cluster manager.RouteAction.BuilderclearCluster()Indicates the upstream cluster to which the request should be routed to.RouteAction.BuilderclearClusterHeader()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.BuilderclearClusterNotFoundResponseCode()The HTTP status code to use when configured cluster is not found.RouteAction.BuilderclearClusterSpecifier()RouteAction.BuilderclearClusterSpecifierPlugin()Name of the cluster specifier plugin to use to determine the cluster for requests on this route.RouteAction.BuilderclearCors()Indicates that the route has a CORS policy.RouteAction.BuilderclearEarlyDataPolicy()Specifies how to send request over TLS early data.RouteAction.BuilderclearField(com.google.protobuf.Descriptors.FieldDescriptor field)RouteAction.BuilderclearGrpcTimeoutOffset()Deprecated.RouteAction.BuilderclearHashPolicy()Specifies a list of hash policies to use for ring hash load balancing.RouteAction.BuilderclearHedgePolicy()Indicates that the route has a hedge policy.RouteAction.BuilderclearHostRewriteHeader()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.RouteAction.BuilderclearHostRewriteLiteral()Indicates that during forwarding, the host header will be swapped with this value.RouteAction.BuilderclearHostRewritePathRegex()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.BuilderclearHostRewriteSpecifier()RouteAction.BuilderclearIdleTimeout()Specifies the idle timeout for the route.RouteAction.BuilderclearIncludeVhRateLimits()Deprecated.RouteAction.BuilderclearInlineClusterSpecifierPlugin()Custom cluster specifier plugin configuration to use to determine the cluster for requests on this route.RouteAction.BuilderclearInternalRedirectAction()Deprecated.envoy.config.route.v3.RouteAction.internal_redirect_action is deprecated.RouteAction.BuilderclearInternalRedirectPolicy()If present, Envoy will try to follow an upstream redirect response instead of proxying the response back to the downstream.RouteAction.BuilderclearMaxGrpcTimeout()Deprecated.RouteAction.BuilderclearMaxInternalRedirects()Deprecated.RouteAction.BuilderclearMaxStreamDuration()Specifies the maximum stream duration for this route.RouteAction.BuilderclearMetadataMatch()Optional endpoint metadata match criteria used by the subset load balancer.RouteAction.BuilderclearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)RouteAction.BuilderclearPathTemplateRewrite()Indicates that during forwarding, portions of the path that match the pattern should be rewritten, even allowing the substitution of variables from the match pattern into the new path as specified by the rewrite template.RouteAction.BuilderclearPrefixRewrite()Indicates that during forwarding, the matched prefix (or path) should be swapped with this value.RouteAction.BuilderclearPriority()Optionally specifies the :ref:`routing priority <arch_overview_http_routing_priority>`.RouteAction.BuilderclearRateLimits()Specifies a set of rate limit configurations that could be applied to the route.RouteAction.BuilderclearRegexRewrite()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.BuilderclearRequestMirrorPolicies()Specify a set of route request mirroring policies.RouteAction.BuilderclearRetryPolicy()Indicates that the route has a retry policy.RouteAction.BuilderclearRetryPolicyTypedConfig()[#not-implemented-hide:] Specifies the configuration for retry policy extension.RouteAction.BuilderclearTimeout()Specifies the upstream timeout for the route.RouteAction.BuilderclearUpgradeConfigs()repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;RouteAction.BuilderclearWeightedClusters()Multiple upstream clusters can be specified for a given route.RouteAction.Builderclone()booleangetAppendXForwardedHost()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.com.google.protobuf.BoolValuegetAutoHostRewrite()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.BoolValue.BuildergetAutoHostRewriteBuilder()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.BoolValueOrBuildergetAutoHostRewriteOrBuilder()Indicates that during forwarding, the host header will be swapped with the hostname of the upstream host chosen by the cluster manager.StringgetCluster()Indicates the upstream cluster to which the request should be routed to.com.google.protobuf.ByteStringgetClusterBytes()Indicates the upstream cluster to which the request should be routed to.StringgetClusterHeader()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.ByteStringgetClusterHeaderBytes()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.ClusterNotFoundResponseCodegetClusterNotFoundResponseCode()The HTTP status code to use when configured cluster is not found.intgetClusterNotFoundResponseCodeValue()The HTTP status code to use when configured cluster is not found.RouteAction.ClusterSpecifierCasegetClusterSpecifierCase()StringgetClusterSpecifierPlugin()Name of the cluster specifier plugin to use to determine the cluster for requests on this route.com.google.protobuf.ByteStringgetClusterSpecifierPluginBytes()Name of the cluster specifier plugin to use to determine the cluster for requests on this route.CorsPolicygetCors()Indicates that the route has a CORS policy.CorsPolicy.BuildergetCorsBuilder()Indicates that the route has a CORS policy.CorsPolicyOrBuildergetCorsOrBuilder()Indicates that the route has a CORS policy.RouteActiongetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()com.google.protobuf.Descriptors.DescriptorgetDescriptorForType()TypedExtensionConfiggetEarlyDataPolicy()Specifies how to send request over TLS early data.TypedExtensionConfig.BuildergetEarlyDataPolicyBuilder()Specifies how to send request over TLS early data.TypedExtensionConfigOrBuildergetEarlyDataPolicyOrBuilder()Specifies how to send request over TLS early data.com.google.protobuf.DurationgetGrpcTimeoutOffset()Deprecated.envoy.config.route.v3.RouteAction.grpc_timeout_offset is deprecated.com.google.protobuf.Duration.BuildergetGrpcTimeoutOffsetBuilder()Deprecated.com.google.protobuf.DurationOrBuildergetGrpcTimeoutOffsetOrBuilder()Deprecated.RouteAction.HashPolicygetHashPolicy(int index)Specifies a list of hash policies to use for ring hash load balancing.RouteAction.HashPolicy.BuildergetHashPolicyBuilder(int index)Specifies a list of hash policies to use for ring hash load balancing.List<RouteAction.HashPolicy.Builder>getHashPolicyBuilderList()Specifies a list of hash policies to use for ring hash load balancing.intgetHashPolicyCount()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.HashPolicyOrBuildergetHashPolicyOrBuilder(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.HedgePolicygetHedgePolicy()Indicates that the route has a hedge policy.HedgePolicy.BuildergetHedgePolicyBuilder()Indicates that the route has a hedge policy.HedgePolicyOrBuildergetHedgePolicyOrBuilder()Indicates that the route has a hedge policy.StringgetHostRewriteHeader()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.ByteStringgetHostRewriteHeaderBytes()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.StringgetHostRewriteLiteral()Indicates that during forwarding, the host header will be swapped with this value.com.google.protobuf.ByteStringgetHostRewriteLiteralBytes()Indicates that during forwarding, the host header will be swapped with this value.RegexMatchAndSubstitutegetHostRewritePathRegex()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.RegexMatchAndSubstitute.BuildergetHostRewritePathRegexBuilder()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.RegexMatchAndSubstituteOrBuildergetHostRewritePathRegexOrBuilder()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.HostRewriteSpecifierCasegetHostRewriteSpecifierCase()com.google.protobuf.DurationgetIdleTimeout()Specifies the idle timeout for the route.com.google.protobuf.Duration.BuildergetIdleTimeoutBuilder()Specifies the idle timeout for the route.com.google.protobuf.DurationOrBuildergetIdleTimeoutOrBuilder()Specifies the idle timeout for the route.com.google.protobuf.BoolValuegetIncludeVhRateLimits()Deprecated.envoy.config.route.v3.RouteAction.include_vh_rate_limits is deprecated.com.google.protobuf.BoolValue.BuildergetIncludeVhRateLimitsBuilder()Deprecated.com.google.protobuf.BoolValueOrBuildergetIncludeVhRateLimitsOrBuilder()Deprecated.ClusterSpecifierPlugingetInlineClusterSpecifierPlugin()Custom cluster specifier plugin configuration to use to determine the cluster for requests on this route.ClusterSpecifierPlugin.BuildergetInlineClusterSpecifierPluginBuilder()Custom cluster specifier plugin configuration to use to determine the cluster for requests on this route.ClusterSpecifierPluginOrBuildergetInlineClusterSpecifierPluginOrBuilder()Custom cluster specifier plugin configuration to use to determine the cluster for requests on this route.RouteAction.InternalRedirectActiongetInternalRedirectAction()Deprecated.envoy.config.route.v3.RouteAction.internal_redirect_action is deprecated.intgetInternalRedirectActionValue()Deprecated.envoy.config.route.v3.RouteAction.internal_redirect_action is deprecated.InternalRedirectPolicygetInternalRedirectPolicy()If present, Envoy will try to follow an upstream redirect response instead of proxying the response back to the downstream.InternalRedirectPolicy.BuildergetInternalRedirectPolicyBuilder()If present, Envoy will try to follow an upstream redirect response instead of proxying the response back to the downstream.InternalRedirectPolicyOrBuildergetInternalRedirectPolicyOrBuilder()If present, Envoy will try to follow an upstream redirect response instead of proxying the response back to the downstream.com.google.protobuf.DurationgetMaxGrpcTimeout()Deprecated.envoy.config.route.v3.RouteAction.max_grpc_timeout is deprecated.com.google.protobuf.Duration.BuildergetMaxGrpcTimeoutBuilder()Deprecated.com.google.protobuf.DurationOrBuildergetMaxGrpcTimeoutOrBuilder()Deprecated.com.google.protobuf.UInt32ValuegetMaxInternalRedirects()Deprecated.envoy.config.route.v3.RouteAction.max_internal_redirects is deprecated.com.google.protobuf.UInt32Value.BuildergetMaxInternalRedirectsBuilder()Deprecated.com.google.protobuf.UInt32ValueOrBuildergetMaxInternalRedirectsOrBuilder()Deprecated.RouteAction.MaxStreamDurationgetMaxStreamDuration()Specifies the maximum stream duration for this route.RouteAction.MaxStreamDuration.BuildergetMaxStreamDurationBuilder()Specifies the maximum stream duration for this route.RouteAction.MaxStreamDurationOrBuildergetMaxStreamDurationOrBuilder()Specifies the maximum stream duration for this route.MetadatagetMetadataMatch()Optional endpoint metadata match criteria used by the subset load balancer.Metadata.BuildergetMetadataMatchBuilder()Optional endpoint metadata match criteria used by the subset load balancer.MetadataOrBuildergetMetadataMatchOrBuilder()Optional endpoint metadata match criteria used by the subset load balancer.StringgetPathTemplateRewrite()Indicates that during forwarding, portions of the path that match the pattern should be rewritten, even allowing the substitution of variables from the match pattern into the new path as specified by the rewrite template.com.google.protobuf.ByteStringgetPathTemplateRewriteBytes()Indicates that during forwarding, portions of the path that match the pattern should be rewritten, even allowing the substitution of variables from the match pattern into the new path as specified by the rewrite template.StringgetPrefixRewrite()Indicates that during forwarding, the matched prefix (or path) should be swapped with this value.com.google.protobuf.ByteStringgetPrefixRewriteBytes()Indicates that during forwarding, the matched prefix (or path) should be swapped with this value.RoutingPrioritygetPriority()Optionally specifies the :ref:`routing priority <arch_overview_http_routing_priority>`.intgetPriorityValue()Optionally specifies the :ref:`routing priority <arch_overview_http_routing_priority>`.RateLimitgetRateLimits(int index)Specifies a set of rate limit configurations that could be applied to the route.RateLimit.BuildergetRateLimitsBuilder(int index)Specifies a set of rate limit configurations that could be applied to the route.List<RateLimit.Builder>getRateLimitsBuilderList()Specifies a set of rate limit configurations that could be applied to the route.intgetRateLimitsCount()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.RateLimitOrBuildergetRateLimitsOrBuilder(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.RegexMatchAndSubstitutegetRegexRewrite()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.RegexMatchAndSubstitute.BuildergetRegexRewriteBuilder()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.RegexMatchAndSubstituteOrBuildergetRegexRewriteOrBuilder()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.RequestMirrorPolicygetRequestMirrorPolicies(int index)Specify a set of route request mirroring policies.RouteAction.RequestMirrorPolicy.BuildergetRequestMirrorPoliciesBuilder(int index)Specify a set of route request mirroring policies.List<RouteAction.RequestMirrorPolicy.Builder>getRequestMirrorPoliciesBuilderList()Specify a set of route request mirroring policies.intgetRequestMirrorPoliciesCount()Specify a set of route request mirroring policies.List<RouteAction.RequestMirrorPolicy>getRequestMirrorPoliciesList()Specify a set of route request mirroring policies.RouteAction.RequestMirrorPolicyOrBuildergetRequestMirrorPoliciesOrBuilder(int index)Specify a set of route request mirroring policies.List<? extends RouteAction.RequestMirrorPolicyOrBuilder>getRequestMirrorPoliciesOrBuilderList()Specify a set of route request mirroring policies.RetryPolicygetRetryPolicy()Indicates that the route has a retry policy.RetryPolicy.BuildergetRetryPolicyBuilder()Indicates that the route has a retry policy.RetryPolicyOrBuildergetRetryPolicyOrBuilder()Indicates that the route has a retry policy.com.google.protobuf.AnygetRetryPolicyTypedConfig()[#not-implemented-hide:] Specifies the configuration for retry policy extension.com.google.protobuf.Any.BuildergetRetryPolicyTypedConfigBuilder()[#not-implemented-hide:] Specifies the configuration for retry policy extension.com.google.protobuf.AnyOrBuildergetRetryPolicyTypedConfigOrBuilder()[#not-implemented-hide:] Specifies the configuration for retry policy extension.com.google.protobuf.DurationgetTimeout()Specifies the upstream timeout for the route.com.google.protobuf.Duration.BuildergetTimeoutBuilder()Specifies the upstream timeout for the route.com.google.protobuf.DurationOrBuildergetTimeoutOrBuilder()Specifies the upstream timeout for the route.RouteAction.UpgradeConfiggetUpgradeConfigs(int index)repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;RouteAction.UpgradeConfig.BuildergetUpgradeConfigsBuilder(int index)repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;List<RouteAction.UpgradeConfig.Builder>getUpgradeConfigsBuilderList()repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;intgetUpgradeConfigsCount()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.UpgradeConfigOrBuildergetUpgradeConfigsOrBuilder(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;WeightedClustergetWeightedClusters()Multiple upstream clusters can be specified for a given route.WeightedCluster.BuildergetWeightedClustersBuilder()Multiple upstream clusters can be specified for a given route.WeightedClusterOrBuildergetWeightedClustersOrBuilder()Multiple upstream clusters can be specified for a given route.booleanhasAutoHostRewrite()Indicates that during forwarding, the host header will be swapped with the hostname of the upstream host chosen by the cluster manager.booleanhasCluster()Indicates the upstream cluster to which the request should be routed to.booleanhasClusterHeader()Envoy will determine the cluster to route to by reading the value of the HTTP header named by cluster_header from the request headers.booleanhasClusterSpecifierPlugin()Name of the cluster specifier plugin to use to determine the cluster for requests on this route.booleanhasCors()Indicates that the route has a CORS policy.booleanhasEarlyDataPolicy()Specifies how to send request over TLS early data.booleanhasGrpcTimeoutOffset()Deprecated.envoy.config.route.v3.RouteAction.grpc_timeout_offset is deprecated.booleanhasHedgePolicy()Indicates that the route has a hedge policy.booleanhasHostRewriteHeader()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.booleanhasHostRewriteLiteral()Indicates that during forwarding, the host header will be swapped with this value.booleanhasHostRewritePathRegex()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.booleanhasIdleTimeout()Specifies the idle timeout for the route.booleanhasIncludeVhRateLimits()Deprecated.envoy.config.route.v3.RouteAction.include_vh_rate_limits is deprecated.booleanhasInlineClusterSpecifierPlugin()Custom cluster specifier plugin configuration to use to determine the cluster for requests on this route.booleanhasInternalRedirectPolicy()If present, Envoy will try to follow an upstream redirect response instead of proxying the response back to the downstream.booleanhasMaxGrpcTimeout()Deprecated.envoy.config.route.v3.RouteAction.max_grpc_timeout is deprecated.booleanhasMaxInternalRedirects()Deprecated.envoy.config.route.v3.RouteAction.max_internal_redirects is deprecated.booleanhasMaxStreamDuration()Specifies the maximum stream duration for this route.booleanhasMetadataMatch()Optional endpoint metadata match criteria used by the subset load balancer.booleanhasRegexRewrite()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.booleanhasRetryPolicy()Indicates that the route has a retry policy.booleanhasRetryPolicyTypedConfig()[#not-implemented-hide:] Specifies the configuration for retry policy extension.booleanhasTimeout()Specifies the upstream timeout for the route.booleanhasWeightedClusters()Multiple upstream clusters can be specified for a given route.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()RouteAction.BuildermergeAutoHostRewrite(com.google.protobuf.BoolValue value)Indicates that during forwarding, the host header will be swapped with the hostname of the upstream host chosen by the cluster manager.RouteAction.BuildermergeCors(CorsPolicy value)Indicates that the route has a CORS policy.RouteAction.BuildermergeEarlyDataPolicy(TypedExtensionConfig value)Specifies how to send request over TLS early data.RouteAction.BuildermergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)RouteAction.BuildermergeFrom(com.google.protobuf.Message other)RouteAction.BuildermergeFrom(RouteAction other)RouteAction.BuildermergeGrpcTimeoutOffset(com.google.protobuf.Duration value)Deprecated.RouteAction.BuildermergeHedgePolicy(HedgePolicy value)Indicates that the route has a hedge policy.RouteAction.BuildermergeHostRewritePathRegex(RegexMatchAndSubstitute value)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.BuildermergeIdleTimeout(com.google.protobuf.Duration value)Specifies the idle timeout for the route.RouteAction.BuildermergeIncludeVhRateLimits(com.google.protobuf.BoolValue value)Deprecated.RouteAction.BuildermergeInlineClusterSpecifierPlugin(ClusterSpecifierPlugin value)Custom cluster specifier plugin configuration to use to determine the cluster for requests on this route.RouteAction.BuildermergeInternalRedirectPolicy(InternalRedirectPolicy value)If present, Envoy will try to follow an upstream redirect response instead of proxying the response back to the downstream.RouteAction.BuildermergeMaxGrpcTimeout(com.google.protobuf.Duration value)Deprecated.RouteAction.BuildermergeMaxInternalRedirects(com.google.protobuf.UInt32Value value)Deprecated.RouteAction.BuildermergeMaxStreamDuration(RouteAction.MaxStreamDuration value)Specifies the maximum stream duration for this route.RouteAction.BuildermergeMetadataMatch(Metadata value)Optional endpoint metadata match criteria used by the subset load balancer.RouteAction.BuildermergeRegexRewrite(RegexMatchAndSubstitute value)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.BuildermergeRetryPolicy(RetryPolicy value)Indicates that the route has a retry policy.RouteAction.BuildermergeRetryPolicyTypedConfig(com.google.protobuf.Any value)[#not-implemented-hide:] Specifies the configuration for retry policy extension.RouteAction.BuildermergeTimeout(com.google.protobuf.Duration value)Specifies the upstream timeout for the route.RouteAction.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)RouteAction.BuildermergeWeightedClusters(WeightedCluster value)Multiple upstream clusters can be specified for a given route.RouteAction.BuilderremoveHashPolicy(int index)Specifies a list of hash policies to use for ring hash load balancing.RouteAction.BuilderremoveRateLimits(int index)Specifies a set of rate limit configurations that could be applied to the route.RouteAction.BuilderremoveRequestMirrorPolicies(int index)Specify a set of route request mirroring policies.RouteAction.BuilderremoveUpgradeConfigs(int index)repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;RouteAction.BuildersetAppendXForwardedHost(boolean value)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.RouteAction.BuildersetAutoHostRewrite(com.google.protobuf.BoolValue value)Indicates that during forwarding, the host header will be swapped with the hostname of the upstream host chosen by the cluster manager.RouteAction.BuildersetAutoHostRewrite(com.google.protobuf.BoolValue.Builder builderForValue)Indicates that during forwarding, the host header will be swapped with the hostname of the upstream host chosen by the cluster manager.RouteAction.BuildersetCluster(String value)Indicates the upstream cluster to which the request should be routed to.RouteAction.BuildersetClusterBytes(com.google.protobuf.ByteString value)Indicates the upstream cluster to which the request should be routed to.RouteAction.BuildersetClusterHeader(String value)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.BuildersetClusterHeaderBytes(com.google.protobuf.ByteString value)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.BuildersetClusterNotFoundResponseCode(RouteAction.ClusterNotFoundResponseCode value)The HTTP status code to use when configured cluster is not found.RouteAction.BuildersetClusterNotFoundResponseCodeValue(int value)The HTTP status code to use when configured cluster is not found.RouteAction.BuildersetClusterSpecifierPlugin(String value)Name of the cluster specifier plugin to use to determine the cluster for requests on this route.RouteAction.BuildersetClusterSpecifierPluginBytes(com.google.protobuf.ByteString value)Name of the cluster specifier plugin to use to determine the cluster for requests on this route.RouteAction.BuildersetCors(CorsPolicy value)Indicates that the route has a CORS policy.RouteAction.BuildersetCors(CorsPolicy.Builder builderForValue)Indicates that the route has a CORS policy.RouteAction.BuildersetEarlyDataPolicy(TypedExtensionConfig value)Specifies how to send request over TLS early data.RouteAction.BuildersetEarlyDataPolicy(TypedExtensionConfig.Builder builderForValue)Specifies how to send request over TLS early data.RouteAction.BuildersetField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)RouteAction.BuildersetGrpcTimeoutOffset(com.google.protobuf.Duration value)Deprecated.RouteAction.BuildersetGrpcTimeoutOffset(com.google.protobuf.Duration.Builder builderForValue)Deprecated.RouteAction.BuildersetHashPolicy(int index, RouteAction.HashPolicy value)Specifies a list of hash policies to use for ring hash load balancing.RouteAction.BuildersetHashPolicy(int index, RouteAction.HashPolicy.Builder builderForValue)Specifies a list of hash policies to use for ring hash load balancing.RouteAction.BuildersetHedgePolicy(HedgePolicy value)Indicates that the route has a hedge policy.RouteAction.BuildersetHedgePolicy(HedgePolicy.Builder builderForValue)Indicates that the route has a hedge policy.RouteAction.BuildersetHostRewriteHeader(String value)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.RouteAction.BuildersetHostRewriteHeaderBytes(com.google.protobuf.ByteString value)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.RouteAction.BuildersetHostRewriteLiteral(String value)Indicates that during forwarding, the host header will be swapped with this value.RouteAction.BuildersetHostRewriteLiteralBytes(com.google.protobuf.ByteString value)Indicates that during forwarding, the host header will be swapped with this value.RouteAction.BuildersetHostRewritePathRegex(RegexMatchAndSubstitute value)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.BuildersetHostRewritePathRegex(RegexMatchAndSubstitute.Builder builderForValue)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.BuildersetIdleTimeout(com.google.protobuf.Duration value)Specifies the idle timeout for the route.RouteAction.BuildersetIdleTimeout(com.google.protobuf.Duration.Builder builderForValue)Specifies the idle timeout for the route.RouteAction.BuildersetIncludeVhRateLimits(com.google.protobuf.BoolValue value)Deprecated.RouteAction.BuildersetIncludeVhRateLimits(com.google.protobuf.BoolValue.Builder builderForValue)Deprecated.RouteAction.BuildersetInlineClusterSpecifierPlugin(ClusterSpecifierPlugin value)Custom cluster specifier plugin configuration to use to determine the cluster for requests on this route.RouteAction.BuildersetInlineClusterSpecifierPlugin(ClusterSpecifierPlugin.Builder builderForValue)Custom cluster specifier plugin configuration to use to determine the cluster for requests on this route.RouteAction.BuildersetInternalRedirectAction(RouteAction.InternalRedirectAction value)Deprecated.envoy.config.route.v3.RouteAction.internal_redirect_action is deprecated.RouteAction.BuildersetInternalRedirectActionValue(int value)Deprecated.envoy.config.route.v3.RouteAction.internal_redirect_action is deprecated.RouteAction.BuildersetInternalRedirectPolicy(InternalRedirectPolicy value)If present, Envoy will try to follow an upstream redirect response instead of proxying the response back to the downstream.RouteAction.BuildersetInternalRedirectPolicy(InternalRedirectPolicy.Builder builderForValue)If present, Envoy will try to follow an upstream redirect response instead of proxying the response back to the downstream.RouteAction.BuildersetMaxGrpcTimeout(com.google.protobuf.Duration value)Deprecated.RouteAction.BuildersetMaxGrpcTimeout(com.google.protobuf.Duration.Builder builderForValue)Deprecated.RouteAction.BuildersetMaxInternalRedirects(com.google.protobuf.UInt32Value value)Deprecated.RouteAction.BuildersetMaxInternalRedirects(com.google.protobuf.UInt32Value.Builder builderForValue)Deprecated.RouteAction.BuildersetMaxStreamDuration(RouteAction.MaxStreamDuration value)Specifies the maximum stream duration for this route.RouteAction.BuildersetMaxStreamDuration(RouteAction.MaxStreamDuration.Builder builderForValue)Specifies the maximum stream duration for this route.RouteAction.BuildersetMetadataMatch(Metadata value)Optional endpoint metadata match criteria used by the subset load balancer.RouteAction.BuildersetMetadataMatch(Metadata.Builder builderForValue)Optional endpoint metadata match criteria used by the subset load balancer.RouteAction.BuildersetPathTemplateRewrite(String value)Indicates that during forwarding, portions of the path that match the pattern should be rewritten, even allowing the substitution of variables from the match pattern into the new path as specified by the rewrite template.RouteAction.BuildersetPathTemplateRewriteBytes(com.google.protobuf.ByteString value)Indicates that during forwarding, portions of the path that match the pattern should be rewritten, even allowing the substitution of variables from the match pattern into the new path as specified by the rewrite template.RouteAction.BuildersetPrefixRewrite(String value)Indicates that during forwarding, the matched prefix (or path) should be swapped with this value.RouteAction.BuildersetPrefixRewriteBytes(com.google.protobuf.ByteString value)Indicates that during forwarding, the matched prefix (or path) should be swapped with this value.RouteAction.BuildersetPriority(RoutingPriority value)Optionally specifies the :ref:`routing priority <arch_overview_http_routing_priority>`.RouteAction.BuildersetPriorityValue(int value)Optionally specifies the :ref:`routing priority <arch_overview_http_routing_priority>`.RouteAction.BuildersetRateLimits(int index, RateLimit value)Specifies a set of rate limit configurations that could be applied to the route.RouteAction.BuildersetRateLimits(int index, RateLimit.Builder builderForValue)Specifies a set of rate limit configurations that could be applied to the route.RouteAction.BuildersetRegexRewrite(RegexMatchAndSubstitute value)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.BuildersetRegexRewrite(RegexMatchAndSubstitute.Builder builderForValue)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.BuildersetRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)RouteAction.BuildersetRequestMirrorPolicies(int index, RouteAction.RequestMirrorPolicy value)Specify a set of route request mirroring policies.RouteAction.BuildersetRequestMirrorPolicies(int index, RouteAction.RequestMirrorPolicy.Builder builderForValue)Specify a set of route request mirroring policies.RouteAction.BuildersetRetryPolicy(RetryPolicy value)Indicates that the route has a retry policy.RouteAction.BuildersetRetryPolicy(RetryPolicy.Builder builderForValue)Indicates that the route has a retry policy.RouteAction.BuildersetRetryPolicyTypedConfig(com.google.protobuf.Any value)[#not-implemented-hide:] Specifies the configuration for retry policy extension.RouteAction.BuildersetRetryPolicyTypedConfig(com.google.protobuf.Any.Builder builderForValue)[#not-implemented-hide:] Specifies the configuration for retry policy extension.RouteAction.BuildersetTimeout(com.google.protobuf.Duration value)Specifies the upstream timeout for the route.RouteAction.BuildersetTimeout(com.google.protobuf.Duration.Builder builderForValue)Specifies the upstream timeout for the route.RouteAction.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)RouteAction.BuildersetUpgradeConfigs(int index, RouteAction.UpgradeConfig value)repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;RouteAction.BuildersetUpgradeConfigs(int index, RouteAction.UpgradeConfig.Builder builderForValue)repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;RouteAction.BuildersetWeightedClusters(WeightedCluster value)Multiple upstream clusters can be specified for a given route.RouteAction.BuildersetWeightedClusters(WeightedCluster.Builder builderForValue)Multiple upstream clusters can be specified for a given route.-
Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<RouteAction.Builder>
-
clear
public RouteAction.Builder clear()
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<RouteAction.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<RouteAction.Builder>
-
getDefaultInstanceForType
public RouteAction getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
public RouteAction build()
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public RouteAction buildPartial()
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
public RouteAction.Builder clone()
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<RouteAction.Builder>
-
setField
public RouteAction.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<RouteAction.Builder>
-
clearField
public RouteAction.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<RouteAction.Builder>
-
clearOneof
public RouteAction.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<RouteAction.Builder>
-
setRepeatedField
public RouteAction.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
- Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<RouteAction.Builder>
-
addRepeatedField
public RouteAction.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<RouteAction.Builder>
-
mergeFrom
public RouteAction.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<RouteAction.Builder>
-
mergeFrom
public RouteAction.Builder mergeFrom(RouteAction other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<RouteAction.Builder>
-
mergeFrom
public RouteAction.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<RouteAction.Builder>- Throws:
IOException
-
getClusterSpecifierCase
public RouteAction.ClusterSpecifierCase getClusterSpecifierCase()
- Specified by:
getClusterSpecifierCasein interfaceRouteActionOrBuilder
-
clearClusterSpecifier
public RouteAction.Builder clearClusterSpecifier()
-
getHostRewriteSpecifierCase
public RouteAction.HostRewriteSpecifierCase getHostRewriteSpecifierCase()
- Specified by:
getHostRewriteSpecifierCasein interfaceRouteActionOrBuilder
-
clearHostRewriteSpecifier
public RouteAction.Builder clearHostRewriteSpecifier()
-
hasCluster
public boolean hasCluster()
Indicates the upstream cluster to which the request should be routed to.
string cluster = 1 [(.validate.rules) = { ... }- Specified by:
hasClusterin interfaceRouteActionOrBuilder- Returns:
- Whether the cluster field is set.
-
getCluster
public String getCluster()
Indicates the upstream cluster to which the request should be routed to.
string cluster = 1 [(.validate.rules) = { ... }- Specified by:
getClusterin interfaceRouteActionOrBuilder- Returns:
- The cluster.
-
getClusterBytes
public com.google.protobuf.ByteString getClusterBytes()
Indicates the upstream cluster to which the request should be routed to.
string cluster = 1 [(.validate.rules) = { ... }- Specified by:
getClusterBytesin interfaceRouteActionOrBuilder- Returns:
- The bytes for cluster.
-
setCluster
public RouteAction.Builder setCluster(String value)
Indicates the upstream cluster to which the request should be routed to.
string cluster = 1 [(.validate.rules) = { ... }- Parameters:
value- The cluster to set.- Returns:
- This builder for chaining.
-
clearCluster
public RouteAction.Builder clearCluster()
Indicates the upstream cluster to which the request should be routed to.
string cluster = 1 [(.validate.rules) = { ... }- Returns:
- This builder for chaining.
-
setClusterBytes
public RouteAction.Builder setClusterBytes(com.google.protobuf.ByteString value)
Indicates the upstream cluster to which the request should be routed to.
string cluster = 1 [(.validate.rules) = { ... }- Parameters:
value- The bytes for cluster to set.- Returns:
- This builder for chaining.
-
hasClusterHeader
public 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) = { ... }- Specified by:
hasClusterHeaderin interfaceRouteActionOrBuilder- Returns:
- Whether the clusterHeader field is set.
-
getClusterHeader
public 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) = { ... }- Specified by:
getClusterHeaderin interfaceRouteActionOrBuilder- Returns:
- The clusterHeader.
-
getClusterHeaderBytes
public 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) = { ... }- Specified by:
getClusterHeaderBytesin interfaceRouteActionOrBuilder- Returns:
- The bytes for clusterHeader.
-
setClusterHeader
public RouteAction.Builder setClusterHeader(String value)
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) = { ... }- Parameters:
value- The clusterHeader to set.- Returns:
- This builder for chaining.
-
clearClusterHeader
public RouteAction.Builder clearClusterHeader()
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:
- This builder for chaining.
-
setClusterHeaderBytes
public RouteAction.Builder setClusterHeaderBytes(com.google.protobuf.ByteString value)
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) = { ... }- Parameters:
value- The bytes for clusterHeader to set.- Returns:
- This builder for chaining.
-
hasWeightedClusters
public 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;- Specified by:
hasWeightedClustersin interfaceRouteActionOrBuilder- Returns:
- Whether the weightedClusters field is set.
-
getWeightedClusters
public 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;- Specified by:
getWeightedClustersin interfaceRouteActionOrBuilder- Returns:
- The weightedClusters.
-
setWeightedClusters
public RouteAction.Builder setWeightedClusters(WeightedCluster value)
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;
-
setWeightedClusters
public RouteAction.Builder setWeightedClusters(WeightedCluster.Builder builderForValue)
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;
-
mergeWeightedClusters
public RouteAction.Builder mergeWeightedClusters(WeightedCluster value)
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;
-
clearWeightedClusters
public RouteAction.Builder clearWeightedClusters()
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;
-
getWeightedClustersBuilder
public WeightedCluster.Builder getWeightedClustersBuilder()
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
public 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;- Specified by:
getWeightedClustersOrBuilderin interfaceRouteActionOrBuilder
-
hasClusterSpecifierPlugin
public 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;- Specified by:
hasClusterSpecifierPluginin interfaceRouteActionOrBuilder- Returns:
- Whether the clusterSpecifierPlugin field is set.
-
getClusterSpecifierPlugin
public 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;- Specified by:
getClusterSpecifierPluginin interfaceRouteActionOrBuilder- Returns:
- The clusterSpecifierPlugin.
-
getClusterSpecifierPluginBytes
public 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;- Specified by:
getClusterSpecifierPluginBytesin interfaceRouteActionOrBuilder- Returns:
- The bytes for clusterSpecifierPlugin.
-
setClusterSpecifierPlugin
public RouteAction.Builder setClusterSpecifierPlugin(String value)
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;- Parameters:
value- The clusterSpecifierPlugin to set.- Returns:
- This builder for chaining.
-
clearClusterSpecifierPlugin
public RouteAction.Builder clearClusterSpecifierPlugin()
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:
- This builder for chaining.
-
setClusterSpecifierPluginBytes
public RouteAction.Builder setClusterSpecifierPluginBytes(com.google.protobuf.ByteString value)
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;- Parameters:
value- The bytes for clusterSpecifierPlugin to set.- Returns:
- This builder for chaining.
-
hasInlineClusterSpecifierPlugin
public 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;- Specified by:
hasInlineClusterSpecifierPluginin interfaceRouteActionOrBuilder- Returns:
- Whether the inlineClusterSpecifierPlugin field is set.
-
getInlineClusterSpecifierPlugin
public 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;- Specified by:
getInlineClusterSpecifierPluginin interfaceRouteActionOrBuilder- Returns:
- The inlineClusterSpecifierPlugin.
-
setInlineClusterSpecifierPlugin
public RouteAction.Builder setInlineClusterSpecifierPlugin(ClusterSpecifierPlugin value)
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;
-
setInlineClusterSpecifierPlugin
public RouteAction.Builder setInlineClusterSpecifierPlugin(ClusterSpecifierPlugin.Builder builderForValue)
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;
-
mergeInlineClusterSpecifierPlugin
public RouteAction.Builder mergeInlineClusterSpecifierPlugin(ClusterSpecifierPlugin value)
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;
-
clearInlineClusterSpecifierPlugin
public RouteAction.Builder clearInlineClusterSpecifierPlugin()
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;
-
getInlineClusterSpecifierPluginBuilder
public ClusterSpecifierPlugin.Builder getInlineClusterSpecifierPluginBuilder()
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;
-
getInlineClusterSpecifierPluginOrBuilder
public 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;- Specified by:
getInlineClusterSpecifierPluginOrBuilderin interfaceRouteActionOrBuilder
-
getClusterNotFoundResponseCodeValue
public 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) = { ... }- Specified by:
getClusterNotFoundResponseCodeValuein interfaceRouteActionOrBuilder- Returns:
- The enum numeric value on the wire for clusterNotFoundResponseCode.
-
setClusterNotFoundResponseCodeValue
public RouteAction.Builder setClusterNotFoundResponseCodeValue(int value)
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) = { ... }- Parameters:
value- The enum numeric value on the wire for clusterNotFoundResponseCode to set.- Returns:
- This builder for chaining.
-
getClusterNotFoundResponseCode
public 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) = { ... }- Specified by:
getClusterNotFoundResponseCodein interfaceRouteActionOrBuilder- Returns:
- The clusterNotFoundResponseCode.
-
setClusterNotFoundResponseCode
public RouteAction.Builder setClusterNotFoundResponseCode(RouteAction.ClusterNotFoundResponseCode value)
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) = { ... }- Parameters:
value- The clusterNotFoundResponseCode to set.- Returns:
- This builder for chaining.
-
clearClusterNotFoundResponseCode
public RouteAction.Builder clearClusterNotFoundResponseCode()
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:
- This builder for chaining.
-
hasMetadataMatch
public 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;- Specified by:
hasMetadataMatchin interfaceRouteActionOrBuilder- Returns:
- Whether the metadataMatch field is set.
-
getMetadataMatch
public 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;- Specified by:
getMetadataMatchin interfaceRouteActionOrBuilder- Returns:
- The metadataMatch.
-
setMetadataMatch
public RouteAction.Builder setMetadataMatch(Metadata value)
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;
-
setMetadataMatch
public RouteAction.Builder setMetadataMatch(Metadata.Builder builderForValue)
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;
-
mergeMetadataMatch
public RouteAction.Builder mergeMetadataMatch(Metadata value)
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;
-
clearMetadataMatch
public RouteAction.Builder clearMetadataMatch()
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;
-
getMetadataMatchBuilder
public Metadata.Builder getMetadataMatchBuilder()
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;
-
getMetadataMatchOrBuilder
public 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;- Specified by:
getMetadataMatchOrBuilderin interfaceRouteActionOrBuilder
-
getPrefixRewrite
public 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>` [#comment:TODO(silverstar194) add the following once path_template_rewrite is implemented: :ref:`path_template_rewrite <envoy_v3_api_field_config.route.v3.RouteAction.path_template_rewrite>`] or ``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) = { ... }- Specified by:
getPrefixRewritein interfaceRouteActionOrBuilder- Returns:
- The prefixRewrite.
-
getPrefixRewriteBytes
public 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>` [#comment:TODO(silverstar194) add the following once path_template_rewrite is implemented: :ref:`path_template_rewrite <envoy_v3_api_field_config.route.v3.RouteAction.path_template_rewrite>`] or ``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) = { ... }- Specified by:
getPrefixRewriteBytesin interfaceRouteActionOrBuilder- Returns:
- The bytes for prefixRewrite.
-
setPrefixRewrite
public RouteAction.Builder setPrefixRewrite(String value)
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>` [#comment:TODO(silverstar194) add the following once path_template_rewrite is implemented: :ref:`path_template_rewrite <envoy_v3_api_field_config.route.v3.RouteAction.path_template_rewrite>`] or ``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) = { ... }- Parameters:
value- The prefixRewrite to set.- Returns:
- This builder for chaining.
-
clearPrefixRewrite
public RouteAction.Builder clearPrefixRewrite()
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>` [#comment:TODO(silverstar194) add the following once path_template_rewrite is implemented: :ref:`path_template_rewrite <envoy_v3_api_field_config.route.v3.RouteAction.path_template_rewrite>`] or ``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:
- This builder for chaining.
-
setPrefixRewriteBytes
public RouteAction.Builder setPrefixRewriteBytes(com.google.protobuf.ByteString value)
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>` [#comment:TODO(silverstar194) add the following once path_template_rewrite is implemented: :ref:`path_template_rewrite <envoy_v3_api_field_config.route.v3.RouteAction.path_template_rewrite>`] or ``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) = { ... }- Parameters:
value- The bytes for prefixRewrite to set.- Returns:
- This builder for chaining.
-
hasRegexRewrite
public 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_v3_api_field_config.route.v3.RouteAction.prefix_rewrite>` [#comment:TODO(silverstar194) add the following once path_template_rewrite is implemented: :ref:`path_template_rewrite <envoy_v3_api_field_config.route.v3.RouteAction.path_template_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;- Specified by:
hasRegexRewritein interfaceRouteActionOrBuilder- Returns:
- Whether the regexRewrite field is set.
-
getRegexRewrite
public 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_v3_api_field_config.route.v3.RouteAction.prefix_rewrite>` [#comment:TODO(silverstar194) add the following once path_template_rewrite is implemented: :ref:`path_template_rewrite <envoy_v3_api_field_config.route.v3.RouteAction.path_template_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;- Specified by:
getRegexRewritein interfaceRouteActionOrBuilder- Returns:
- The regexRewrite.
-
setRegexRewrite
public RouteAction.Builder setRegexRewrite(RegexMatchAndSubstitute value)
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_v3_api_field_config.route.v3.RouteAction.prefix_rewrite>` [#comment:TODO(silverstar194) add the following once path_template_rewrite is implemented: :ref:`path_template_rewrite <envoy_v3_api_field_config.route.v3.RouteAction.path_template_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;
-
setRegexRewrite
public RouteAction.Builder setRegexRewrite(RegexMatchAndSubstitute.Builder builderForValue)
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_v3_api_field_config.route.v3.RouteAction.prefix_rewrite>` [#comment:TODO(silverstar194) add the following once path_template_rewrite is implemented: :ref:`path_template_rewrite <envoy_v3_api_field_config.route.v3.RouteAction.path_template_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;
-
mergeRegexRewrite
public RouteAction.Builder mergeRegexRewrite(RegexMatchAndSubstitute value)
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_v3_api_field_config.route.v3.RouteAction.prefix_rewrite>` [#comment:TODO(silverstar194) add the following once path_template_rewrite is implemented: :ref:`path_template_rewrite <envoy_v3_api_field_config.route.v3.RouteAction.path_template_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;
-
clearRegexRewrite
public RouteAction.Builder clearRegexRewrite()
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_v3_api_field_config.route.v3.RouteAction.prefix_rewrite>` [#comment:TODO(silverstar194) add the following once path_template_rewrite is implemented: :ref:`path_template_rewrite <envoy_v3_api_field_config.route.v3.RouteAction.path_template_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;
-
getRegexRewriteBuilder
public RegexMatchAndSubstitute.Builder getRegexRewriteBuilder()
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_v3_api_field_config.route.v3.RouteAction.prefix_rewrite>` [#comment:TODO(silverstar194) add the following once path_template_rewrite is implemented: :ref:`path_template_rewrite <envoy_v3_api_field_config.route.v3.RouteAction.path_template_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
public 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_v3_api_field_config.route.v3.RouteAction.prefix_rewrite>` [#comment:TODO(silverstar194) add the following once path_template_rewrite is implemented: :ref:`path_template_rewrite <envoy_v3_api_field_config.route.v3.RouteAction.path_template_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;- Specified by:
getRegexRewriteOrBuilderin interfaceRouteActionOrBuilder
-
getPathTemplateRewrite
public String getPathTemplateRewrite()
Indicates that during forwarding, portions of the path that match the pattern should be rewritten, even allowing the substitution of variables from the match pattern into the new path as specified by the rewrite template. 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_v3_api_field_config.route.v3.RouteAction.prefix_rewrite>`, :ref:`regex_rewrite <envoy_v3_api_field_config.route.v3.RouteAction.regex_rewrite>`, or ``path_template_rewrite`` may be specified. Template pattern matching types: * ``*`` : Matches a single path component, up to the next path separator: / * ``**`` : Matches zero or more path segments. If present, must be the last operator. * ``{name} or {name=*}`` : A named variable matching one path segment up to the next path separator: /. * ``{name=videos/*}`` : A named variable matching more than one path segment. The path component matching videos/* is captured as the named variable. * ``{name=**}`` : A named variable matching zero or more path segments. Only named matches can be used to perform rewrites. Examples using path_template_rewrite: * The pattern ``/{one}/{two}`` paired with a substitution string of ``/{two}/{one}`` would transform ``/cat/dog`` into ``/dog/cat``. * The pattern ``/videos/{language=lang/*}/*`` paired with a substitution string of ``/{language}`` would transform ``/videos/lang/en/video.m4s`` into ``lang/en``. * The path pattern ``/content/{format}/{lang}/{id}/{file}.vtt`` paired with a substitution string of ``/{lang}/{format}/{file}.vtt`` would transform ``/content/hls/en-us/12345/en_193913.vtt`` into ``/en-us/hls/en_193913.vtt``. [#not-implemented-hide:]string path_template_rewrite = 41 [(.validate.rules) = { ... }- Specified by:
getPathTemplateRewritein interfaceRouteActionOrBuilder- Returns:
- The pathTemplateRewrite.
-
getPathTemplateRewriteBytes
public com.google.protobuf.ByteString getPathTemplateRewriteBytes()
Indicates that during forwarding, portions of the path that match the pattern should be rewritten, even allowing the substitution of variables from the match pattern into the new path as specified by the rewrite template. 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_v3_api_field_config.route.v3.RouteAction.prefix_rewrite>`, :ref:`regex_rewrite <envoy_v3_api_field_config.route.v3.RouteAction.regex_rewrite>`, or ``path_template_rewrite`` may be specified. Template pattern matching types: * ``*`` : Matches a single path component, up to the next path separator: / * ``**`` : Matches zero or more path segments. If present, must be the last operator. * ``{name} or {name=*}`` : A named variable matching one path segment up to the next path separator: /. * ``{name=videos/*}`` : A named variable matching more than one path segment. The path component matching videos/* is captured as the named variable. * ``{name=**}`` : A named variable matching zero or more path segments. Only named matches can be used to perform rewrites. Examples using path_template_rewrite: * The pattern ``/{one}/{two}`` paired with a substitution string of ``/{two}/{one}`` would transform ``/cat/dog`` into ``/dog/cat``. * The pattern ``/videos/{language=lang/*}/*`` paired with a substitution string of ``/{language}`` would transform ``/videos/lang/en/video.m4s`` into ``lang/en``. * The path pattern ``/content/{format}/{lang}/{id}/{file}.vtt`` paired with a substitution string of ``/{lang}/{format}/{file}.vtt`` would transform ``/content/hls/en-us/12345/en_193913.vtt`` into ``/en-us/hls/en_193913.vtt``. [#not-implemented-hide:]string path_template_rewrite = 41 [(.validate.rules) = { ... }- Specified by:
getPathTemplateRewriteBytesin interfaceRouteActionOrBuilder- Returns:
- The bytes for pathTemplateRewrite.
-
setPathTemplateRewrite
public RouteAction.Builder setPathTemplateRewrite(String value)
Indicates that during forwarding, portions of the path that match the pattern should be rewritten, even allowing the substitution of variables from the match pattern into the new path as specified by the rewrite template. 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_v3_api_field_config.route.v3.RouteAction.prefix_rewrite>`, :ref:`regex_rewrite <envoy_v3_api_field_config.route.v3.RouteAction.regex_rewrite>`, or ``path_template_rewrite`` may be specified. Template pattern matching types: * ``*`` : Matches a single path component, up to the next path separator: / * ``**`` : Matches zero or more path segments. If present, must be the last operator. * ``{name} or {name=*}`` : A named variable matching one path segment up to the next path separator: /. * ``{name=videos/*}`` : A named variable matching more than one path segment. The path component matching videos/* is captured as the named variable. * ``{name=**}`` : A named variable matching zero or more path segments. Only named matches can be used to perform rewrites. Examples using path_template_rewrite: * The pattern ``/{one}/{two}`` paired with a substitution string of ``/{two}/{one}`` would transform ``/cat/dog`` into ``/dog/cat``. * The pattern ``/videos/{language=lang/*}/*`` paired with a substitution string of ``/{language}`` would transform ``/videos/lang/en/video.m4s`` into ``lang/en``. * The path pattern ``/content/{format}/{lang}/{id}/{file}.vtt`` paired with a substitution string of ``/{lang}/{format}/{file}.vtt`` would transform ``/content/hls/en-us/12345/en_193913.vtt`` into ``/en-us/hls/en_193913.vtt``. [#not-implemented-hide:]string path_template_rewrite = 41 [(.validate.rules) = { ... }- Parameters:
value- The pathTemplateRewrite to set.- Returns:
- This builder for chaining.
-
clearPathTemplateRewrite
public RouteAction.Builder clearPathTemplateRewrite()
Indicates that during forwarding, portions of the path that match the pattern should be rewritten, even allowing the substitution of variables from the match pattern into the new path as specified by the rewrite template. 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_v3_api_field_config.route.v3.RouteAction.prefix_rewrite>`, :ref:`regex_rewrite <envoy_v3_api_field_config.route.v3.RouteAction.regex_rewrite>`, or ``path_template_rewrite`` may be specified. Template pattern matching types: * ``*`` : Matches a single path component, up to the next path separator: / * ``**`` : Matches zero or more path segments. If present, must be the last operator. * ``{name} or {name=*}`` : A named variable matching one path segment up to the next path separator: /. * ``{name=videos/*}`` : A named variable matching more than one path segment. The path component matching videos/* is captured as the named variable. * ``{name=**}`` : A named variable matching zero or more path segments. Only named matches can be used to perform rewrites. Examples using path_template_rewrite: * The pattern ``/{one}/{two}`` paired with a substitution string of ``/{two}/{one}`` would transform ``/cat/dog`` into ``/dog/cat``. * The pattern ``/videos/{language=lang/*}/*`` paired with a substitution string of ``/{language}`` would transform ``/videos/lang/en/video.m4s`` into ``lang/en``. * The path pattern ``/content/{format}/{lang}/{id}/{file}.vtt`` paired with a substitution string of ``/{lang}/{format}/{file}.vtt`` would transform ``/content/hls/en-us/12345/en_193913.vtt`` into ``/en-us/hls/en_193913.vtt``. [#not-implemented-hide:]string path_template_rewrite = 41 [(.validate.rules) = { ... }- Returns:
- This builder for chaining.
-
setPathTemplateRewriteBytes
public RouteAction.Builder setPathTemplateRewriteBytes(com.google.protobuf.ByteString value)
Indicates that during forwarding, portions of the path that match the pattern should be rewritten, even allowing the substitution of variables from the match pattern into the new path as specified by the rewrite template. 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_v3_api_field_config.route.v3.RouteAction.prefix_rewrite>`, :ref:`regex_rewrite <envoy_v3_api_field_config.route.v3.RouteAction.regex_rewrite>`, or ``path_template_rewrite`` may be specified. Template pattern matching types: * ``*`` : Matches a single path component, up to the next path separator: / * ``**`` : Matches zero or more path segments. If present, must be the last operator. * ``{name} or {name=*}`` : A named variable matching one path segment up to the next path separator: /. * ``{name=videos/*}`` : A named variable matching more than one path segment. The path component matching videos/* is captured as the named variable. * ``{name=**}`` : A named variable matching zero or more path segments. Only named matches can be used to perform rewrites. Examples using path_template_rewrite: * The pattern ``/{one}/{two}`` paired with a substitution string of ``/{two}/{one}`` would transform ``/cat/dog`` into ``/dog/cat``. * The pattern ``/videos/{language=lang/*}/*`` paired with a substitution string of ``/{language}`` would transform ``/videos/lang/en/video.m4s`` into ``lang/en``. * The path pattern ``/content/{format}/{lang}/{id}/{file}.vtt`` paired with a substitution string of ``/{lang}/{format}/{file}.vtt`` would transform ``/content/hls/en-us/12345/en_193913.vtt`` into ``/en-us/hls/en_193913.vtt``. [#not-implemented-hide:]string path_template_rewrite = 41 [(.validate.rules) = { ... }- Parameters:
value- The bytes for pathTemplateRewrite to set.- Returns:
- This builder for chaining.
-
hasHostRewriteLiteral
public 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) = { ... }- Specified by:
hasHostRewriteLiteralin interfaceRouteActionOrBuilder- Returns:
- Whether the hostRewriteLiteral field is set.
-
getHostRewriteLiteral
public 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) = { ... }- Specified by:
getHostRewriteLiteralin interfaceRouteActionOrBuilder- Returns:
- The hostRewriteLiteral.
-
getHostRewriteLiteralBytes
public 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) = { ... }- Specified by:
getHostRewriteLiteralBytesin interfaceRouteActionOrBuilder- Returns:
- The bytes for hostRewriteLiteral.
-
setHostRewriteLiteral
public RouteAction.Builder setHostRewriteLiteral(String value)
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) = { ... }- Parameters:
value- The hostRewriteLiteral to set.- Returns:
- This builder for chaining.
-
clearHostRewriteLiteral
public RouteAction.Builder clearHostRewriteLiteral()
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:
- This builder for chaining.
-
setHostRewriteLiteralBytes
public RouteAction.Builder setHostRewriteLiteralBytes(com.google.protobuf.ByteString value)
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) = { ... }- Parameters:
value- The bytes for hostRewriteLiteral to set.- Returns:
- This builder for chaining.
-
hasAutoHostRewrite
public 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. 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;- Specified by:
hasAutoHostRewritein interfaceRouteActionOrBuilder- Returns:
- Whether the autoHostRewrite field is set.
-
getAutoHostRewrite
public 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. 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;- Specified by:
getAutoHostRewritein interfaceRouteActionOrBuilder- Returns:
- The autoHostRewrite.
-
setAutoHostRewrite
public RouteAction.Builder setAutoHostRewrite(com.google.protobuf.BoolValue value)
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. 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;
-
setAutoHostRewrite
public RouteAction.Builder setAutoHostRewrite(com.google.protobuf.BoolValue.Builder builderForValue)
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. 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;
-
mergeAutoHostRewrite
public RouteAction.Builder mergeAutoHostRewrite(com.google.protobuf.BoolValue value)
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. 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;
-
clearAutoHostRewrite
public RouteAction.Builder clearAutoHostRewrite()
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. 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;
-
getAutoHostRewriteBuilder
public com.google.protobuf.BoolValue.Builder getAutoHostRewriteBuilder()
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. 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;
-
getAutoHostRewriteOrBuilder
public 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. 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;- Specified by:
getAutoHostRewriteOrBuilderin interfaceRouteActionOrBuilder
-
hasHostRewriteHeader
public 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) = { ... }- Specified by:
hasHostRewriteHeaderin interfaceRouteActionOrBuilder- Returns:
- Whether the hostRewriteHeader field is set.
-
getHostRewriteHeader
public 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) = { ... }- Specified by:
getHostRewriteHeaderin interfaceRouteActionOrBuilder- Returns:
- The hostRewriteHeader.
-
getHostRewriteHeaderBytes
public 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) = { ... }- Specified by:
getHostRewriteHeaderBytesin interfaceRouteActionOrBuilder- Returns:
- The bytes for hostRewriteHeader.
-
setHostRewriteHeader
public RouteAction.Builder setHostRewriteHeader(String value)
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) = { ... }- Parameters:
value- The hostRewriteHeader to set.- Returns:
- This builder for chaining.
-
clearHostRewriteHeader
public RouteAction.Builder clearHostRewriteHeader()
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:
- This builder for chaining.
-
setHostRewriteHeaderBytes
public RouteAction.Builder setHostRewriteHeaderBytes(com.google.protobuf.ByteString value)
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) = { ... }- Parameters:
value- The bytes for hostRewriteHeader to set.- Returns:
- This builder for chaining.
-
hasHostRewritePathRegex
public 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;- Specified by:
hasHostRewritePathRegexin interfaceRouteActionOrBuilder- Returns:
- Whether the hostRewritePathRegex field is set.
-
getHostRewritePathRegex
public 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;- Specified by:
getHostRewritePathRegexin interfaceRouteActionOrBuilder- Returns:
- The hostRewritePathRegex.
-
setHostRewritePathRegex
public RouteAction.Builder setHostRewritePathRegex(RegexMatchAndSubstitute value)
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;
-
setHostRewritePathRegex
public RouteAction.Builder setHostRewritePathRegex(RegexMatchAndSubstitute.Builder builderForValue)
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;
-
mergeHostRewritePathRegex
public RouteAction.Builder mergeHostRewritePathRegex(RegexMatchAndSubstitute value)
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;
-
clearHostRewritePathRegex
public RouteAction.Builder clearHostRewritePathRegex()
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;
-
getHostRewritePathRegexBuilder
public RegexMatchAndSubstitute.Builder getHostRewritePathRegexBuilder()
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;
-
getHostRewritePathRegexOrBuilder
public 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;- Specified by:
getHostRewritePathRegexOrBuilderin interfaceRouteActionOrBuilder
-
getAppendXForwardedHost
public 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.
bool append_x_forwarded_host = 38;- Specified by:
getAppendXForwardedHostin interfaceRouteActionOrBuilder- Returns:
- The appendXForwardedHost.
-
setAppendXForwardedHost
public RouteAction.Builder setAppendXForwardedHost(boolean value)
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.
bool append_x_forwarded_host = 38;- Parameters:
value- The appendXForwardedHost to set.- Returns:
- This builder for chaining.
-
clearAppendXForwardedHost
public RouteAction.Builder clearAppendXForwardedHost()
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.
bool append_x_forwarded_host = 38;- Returns:
- This builder for chaining.
-
hasTimeout
public 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;- Specified by:
hasTimeoutin interfaceRouteActionOrBuilder- Returns:
- Whether the timeout field is set.
-
getTimeout
public 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;- Specified by:
getTimeoutin interfaceRouteActionOrBuilder- Returns:
- The timeout.
-
setTimeout
public RouteAction.Builder setTimeout(com.google.protobuf.Duration value)
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;
-
setTimeout
public RouteAction.Builder setTimeout(com.google.protobuf.Duration.Builder builderForValue)
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;
-
mergeTimeout
public RouteAction.Builder mergeTimeout(com.google.protobuf.Duration value)
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;
-
clearTimeout
public RouteAction.Builder clearTimeout()
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;
-
getTimeoutBuilder
public com.google.protobuf.Duration.Builder getTimeoutBuilder()
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
public 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;- Specified by:
getTimeoutOrBuilderin interfaceRouteActionOrBuilder
-
hasIdleTimeout
public 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;- Specified by:
hasIdleTimeoutin interfaceRouteActionOrBuilder- Returns:
- Whether the idleTimeout field is set.
-
getIdleTimeout
public 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;- Specified by:
getIdleTimeoutin interfaceRouteActionOrBuilder- Returns:
- The idleTimeout.
-
setIdleTimeout
public RouteAction.Builder setIdleTimeout(com.google.protobuf.Duration value)
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;
-
setIdleTimeout
public RouteAction.Builder setIdleTimeout(com.google.protobuf.Duration.Builder builderForValue)
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;
-
mergeIdleTimeout
public RouteAction.Builder mergeIdleTimeout(com.google.protobuf.Duration value)
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;
-
clearIdleTimeout
public RouteAction.Builder clearIdleTimeout()
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;
-
getIdleTimeoutBuilder
public com.google.protobuf.Duration.Builder getIdleTimeoutBuilder()
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;
-
getIdleTimeoutOrBuilder
public 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;- Specified by:
getIdleTimeoutOrBuilderin interfaceRouteActionOrBuilder
-
hasEarlyDataPolicy
public 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;- Specified by:
hasEarlyDataPolicyin interfaceRouteActionOrBuilder- Returns:
- Whether the earlyDataPolicy field is set.
-
getEarlyDataPolicy
public 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;- Specified by:
getEarlyDataPolicyin interfaceRouteActionOrBuilder- Returns:
- The earlyDataPolicy.
-
setEarlyDataPolicy
public RouteAction.Builder setEarlyDataPolicy(TypedExtensionConfig value)
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;
-
setEarlyDataPolicy
public RouteAction.Builder setEarlyDataPolicy(TypedExtensionConfig.Builder builderForValue)
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;
-
mergeEarlyDataPolicy
public RouteAction.Builder mergeEarlyDataPolicy(TypedExtensionConfig value)
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;
-
clearEarlyDataPolicy
public RouteAction.Builder clearEarlyDataPolicy()
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;
-
getEarlyDataPolicyBuilder
public TypedExtensionConfig.Builder getEarlyDataPolicyBuilder()
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;
-
getEarlyDataPolicyOrBuilder
public 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;- Specified by:
getEarlyDataPolicyOrBuilderin interfaceRouteActionOrBuilder
-
hasRetryPolicy
public 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;- Specified by:
hasRetryPolicyin interfaceRouteActionOrBuilder- Returns:
- Whether the retryPolicy field is set.
-
getRetryPolicy
public 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;- Specified by:
getRetryPolicyin interfaceRouteActionOrBuilder- Returns:
- The retryPolicy.
-
setRetryPolicy
public RouteAction.Builder setRetryPolicy(RetryPolicy value)
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;
-
setRetryPolicy
public RouteAction.Builder setRetryPolicy(RetryPolicy.Builder builderForValue)
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;
-
mergeRetryPolicy
public RouteAction.Builder mergeRetryPolicy(RetryPolicy value)
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;
-
clearRetryPolicy
public RouteAction.Builder clearRetryPolicy()
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;
-
getRetryPolicyBuilder
public RetryPolicy.Builder getRetryPolicyBuilder()
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
public 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;- Specified by:
getRetryPolicyOrBuilderin interfaceRouteActionOrBuilder
-
hasRetryPolicyTypedConfig
public 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;- Specified by:
hasRetryPolicyTypedConfigin interfaceRouteActionOrBuilder- Returns:
- Whether the retryPolicyTypedConfig field is set.
-
getRetryPolicyTypedConfig
public 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;- Specified by:
getRetryPolicyTypedConfigin interfaceRouteActionOrBuilder- Returns:
- The retryPolicyTypedConfig.
-
setRetryPolicyTypedConfig
public RouteAction.Builder setRetryPolicyTypedConfig(com.google.protobuf.Any value)
[#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;
-
setRetryPolicyTypedConfig
public RouteAction.Builder setRetryPolicyTypedConfig(com.google.protobuf.Any.Builder builderForValue)
[#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;
-
mergeRetryPolicyTypedConfig
public RouteAction.Builder mergeRetryPolicyTypedConfig(com.google.protobuf.Any value)
[#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;
-
clearRetryPolicyTypedConfig
public RouteAction.Builder clearRetryPolicyTypedConfig()
[#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;
-
getRetryPolicyTypedConfigBuilder
public com.google.protobuf.Any.Builder getRetryPolicyTypedConfigBuilder()
[#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;
-
getRetryPolicyTypedConfigOrBuilder
public 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;- Specified by:
getRetryPolicyTypedConfigOrBuilderin interfaceRouteActionOrBuilder
-
getRequestMirrorPoliciesList
public 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;- Specified by:
getRequestMirrorPoliciesListin interfaceRouteActionOrBuilder
-
getRequestMirrorPoliciesCount
public 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;- Specified by:
getRequestMirrorPoliciesCountin interfaceRouteActionOrBuilder
-
getRequestMirrorPolicies
public 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;- Specified by:
getRequestMirrorPoliciesin interfaceRouteActionOrBuilder
-
setRequestMirrorPolicies
public RouteAction.Builder setRequestMirrorPolicies(int index, RouteAction.RequestMirrorPolicy value)
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;
-
setRequestMirrorPolicies
public RouteAction.Builder setRequestMirrorPolicies(int index, RouteAction.RequestMirrorPolicy.Builder builderForValue)
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;
-
addRequestMirrorPolicies
public RouteAction.Builder addRequestMirrorPolicies(RouteAction.RequestMirrorPolicy value)
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;
-
addRequestMirrorPolicies
public RouteAction.Builder addRequestMirrorPolicies(int index, RouteAction.RequestMirrorPolicy value)
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;
-
addRequestMirrorPolicies
public RouteAction.Builder addRequestMirrorPolicies(RouteAction.RequestMirrorPolicy.Builder builderForValue)
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;
-
addRequestMirrorPolicies
public RouteAction.Builder addRequestMirrorPolicies(int index, RouteAction.RequestMirrorPolicy.Builder builderForValue)
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;
-
addAllRequestMirrorPolicies
public RouteAction.Builder addAllRequestMirrorPolicies(Iterable<? extends RouteAction.RequestMirrorPolicy> values)
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;
-
clearRequestMirrorPolicies
public RouteAction.Builder clearRequestMirrorPolicies()
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;
-
removeRequestMirrorPolicies
public RouteAction.Builder removeRequestMirrorPolicies(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;
-
getRequestMirrorPoliciesBuilder
public RouteAction.RequestMirrorPolicy.Builder getRequestMirrorPoliciesBuilder(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;
-
getRequestMirrorPoliciesOrBuilder
public 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;- Specified by:
getRequestMirrorPoliciesOrBuilderin interfaceRouteActionOrBuilder
-
getRequestMirrorPoliciesOrBuilderList
public 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;- Specified by:
getRequestMirrorPoliciesOrBuilderListin interfaceRouteActionOrBuilder
-
addRequestMirrorPoliciesBuilder
public RouteAction.RequestMirrorPolicy.Builder addRequestMirrorPoliciesBuilder()
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;
-
addRequestMirrorPoliciesBuilder
public RouteAction.RequestMirrorPolicy.Builder addRequestMirrorPoliciesBuilder(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;
-
getRequestMirrorPoliciesBuilderList
public List<RouteAction.RequestMirrorPolicy.Builder> getRequestMirrorPoliciesBuilderList()
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
public int getPriorityValue()
Optionally specifies the :ref:`routing priority <arch_overview_http_routing_priority>`.
.envoy.config.core.v3.RoutingPriority priority = 11 [(.validate.rules) = { ... }- Specified by:
getPriorityValuein interfaceRouteActionOrBuilder- Returns:
- The enum numeric value on the wire for priority.
-
setPriorityValue
public RouteAction.Builder setPriorityValue(int value)
Optionally specifies the :ref:`routing priority <arch_overview_http_routing_priority>`.
.envoy.config.core.v3.RoutingPriority priority = 11 [(.validate.rules) = { ... }- Parameters:
value- The enum numeric value on the wire for priority to set.- Returns:
- This builder for chaining.
-
getPriority
public RoutingPriority getPriority()
Optionally specifies the :ref:`routing priority <arch_overview_http_routing_priority>`.
.envoy.config.core.v3.RoutingPriority priority = 11 [(.validate.rules) = { ... }- Specified by:
getPriorityin interfaceRouteActionOrBuilder- Returns:
- The priority.
-
setPriority
public RouteAction.Builder setPriority(RoutingPriority value)
Optionally specifies the :ref:`routing priority <arch_overview_http_routing_priority>`.
.envoy.config.core.v3.RoutingPriority priority = 11 [(.validate.rules) = { ... }- Parameters:
value- The priority to set.- Returns:
- This builder for chaining.
-
clearPriority
public RouteAction.Builder clearPriority()
Optionally specifies the :ref:`routing priority <arch_overview_http_routing_priority>`.
.envoy.config.core.v3.RoutingPriority priority = 11 [(.validate.rules) = { ... }- Returns:
- This builder for chaining.
-
getRateLimitsList
public 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;- Specified by:
getRateLimitsListin interfaceRouteActionOrBuilder
-
getRateLimitsCount
public 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;- Specified by:
getRateLimitsCountin interfaceRouteActionOrBuilder
-
getRateLimits
public 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;- Specified by:
getRateLimitsin interfaceRouteActionOrBuilder
-
setRateLimits
public RouteAction.Builder setRateLimits(int index, RateLimit value)
Specifies a set of rate limit configurations that could be applied to the route.
repeated .envoy.config.route.v3.RateLimit rate_limits = 13;
-
setRateLimits
public RouteAction.Builder setRateLimits(int index, RateLimit.Builder builderForValue)
Specifies a set of rate limit configurations that could be applied to the route.
repeated .envoy.config.route.v3.RateLimit rate_limits = 13;
-
addRateLimits
public RouteAction.Builder addRateLimits(RateLimit value)
Specifies a set of rate limit configurations that could be applied to the route.
repeated .envoy.config.route.v3.RateLimit rate_limits = 13;
-
addRateLimits
public RouteAction.Builder addRateLimits(int index, RateLimit value)
Specifies a set of rate limit configurations that could be applied to the route.
repeated .envoy.config.route.v3.RateLimit rate_limits = 13;
-
addRateLimits
public RouteAction.Builder addRateLimits(RateLimit.Builder builderForValue)
Specifies a set of rate limit configurations that could be applied to the route.
repeated .envoy.config.route.v3.RateLimit rate_limits = 13;
-
addRateLimits
public RouteAction.Builder addRateLimits(int index, RateLimit.Builder builderForValue)
Specifies a set of rate limit configurations that could be applied to the route.
repeated .envoy.config.route.v3.RateLimit rate_limits = 13;
-
addAllRateLimits
public RouteAction.Builder addAllRateLimits(Iterable<? extends RateLimit> values)
Specifies a set of rate limit configurations that could be applied to the route.
repeated .envoy.config.route.v3.RateLimit rate_limits = 13;
-
clearRateLimits
public RouteAction.Builder clearRateLimits()
Specifies a set of rate limit configurations that could be applied to the route.
repeated .envoy.config.route.v3.RateLimit rate_limits = 13;
-
removeRateLimits
public RouteAction.Builder removeRateLimits(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;
-
getRateLimitsBuilder
public RateLimit.Builder getRateLimitsBuilder(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;
-
getRateLimitsOrBuilder
public 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;- Specified by:
getRateLimitsOrBuilderin interfaceRouteActionOrBuilder
-
getRateLimitsOrBuilderList
public 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;- Specified by:
getRateLimitsOrBuilderListin interfaceRouteActionOrBuilder
-
addRateLimitsBuilder
public RateLimit.Builder addRateLimitsBuilder()
Specifies a set of rate limit configurations that could be applied to the route.
repeated .envoy.config.route.v3.RateLimit rate_limits = 13;
-
addRateLimitsBuilder
public RateLimit.Builder addRateLimitsBuilder(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;
-
getRateLimitsBuilderList
public List<RateLimit.Builder> getRateLimitsBuilderList()
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 public boolean hasIncludeVhRateLimits()
Deprecated.envoy.config.route.v3.RouteAction.include_vh_rate_limits is deprecated. See envoy/config/route/v3/route_components.proto;l=1289Specifies 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"];- Specified by:
hasIncludeVhRateLimitsin interfaceRouteActionOrBuilder- Returns:
- Whether the includeVhRateLimits field is set.
-
getIncludeVhRateLimits
@Deprecated public 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=1289Specifies 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"];- Specified by:
getIncludeVhRateLimitsin interfaceRouteActionOrBuilder- Returns:
- The includeVhRateLimits.
-
setIncludeVhRateLimits
@Deprecated public RouteAction.Builder setIncludeVhRateLimits(com.google.protobuf.BoolValue value)
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"];
-
setIncludeVhRateLimits
@Deprecated public RouteAction.Builder setIncludeVhRateLimits(com.google.protobuf.BoolValue.Builder builderForValue)
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"];
-
mergeIncludeVhRateLimits
@Deprecated public RouteAction.Builder mergeIncludeVhRateLimits(com.google.protobuf.BoolValue value)
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"];
-
clearIncludeVhRateLimits
@Deprecated public RouteAction.Builder clearIncludeVhRateLimits()
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"];
-
getIncludeVhRateLimitsBuilder
@Deprecated public com.google.protobuf.BoolValue.Builder getIncludeVhRateLimitsBuilder()
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"];
-
getIncludeVhRateLimitsOrBuilder
@Deprecated public 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"];- Specified by:
getIncludeVhRateLimitsOrBuilderin interfaceRouteActionOrBuilder
-
getHashPolicyList
public 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;- Specified by:
getHashPolicyListin interfaceRouteActionOrBuilder
-
getHashPolicyCount
public 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;- Specified by:
getHashPolicyCountin interfaceRouteActionOrBuilder
-
getHashPolicy
public 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;- Specified by:
getHashPolicyin interfaceRouteActionOrBuilder
-
setHashPolicy
public RouteAction.Builder setHashPolicy(int index, RouteAction.HashPolicy value)
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;
-
setHashPolicy
public RouteAction.Builder setHashPolicy(int index, RouteAction.HashPolicy.Builder builderForValue)
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;
-
addHashPolicy
public RouteAction.Builder addHashPolicy(RouteAction.HashPolicy value)
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;
-
addHashPolicy
public RouteAction.Builder addHashPolicy(int index, RouteAction.HashPolicy value)
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;
-
addHashPolicy
public RouteAction.Builder addHashPolicy(RouteAction.HashPolicy.Builder builderForValue)
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;
-
addHashPolicy
public RouteAction.Builder addHashPolicy(int index, RouteAction.HashPolicy.Builder builderForValue)
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;
-
addAllHashPolicy
public RouteAction.Builder addAllHashPolicy(Iterable<? extends RouteAction.HashPolicy> values)
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;
-
clearHashPolicy
public RouteAction.Builder clearHashPolicy()
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;
-
removeHashPolicy
public RouteAction.Builder removeHashPolicy(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;
-
getHashPolicyBuilder
public RouteAction.HashPolicy.Builder getHashPolicyBuilder(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;
-
getHashPolicyOrBuilder
public 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;- Specified by:
getHashPolicyOrBuilderin interfaceRouteActionOrBuilder
-
getHashPolicyOrBuilderList
public 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;- Specified by:
getHashPolicyOrBuilderListin interfaceRouteActionOrBuilder
-
addHashPolicyBuilder
public RouteAction.HashPolicy.Builder addHashPolicyBuilder()
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;
-
addHashPolicyBuilder
public RouteAction.HashPolicy.Builder addHashPolicyBuilder(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;
-
getHashPolicyBuilderList
public List<RouteAction.HashPolicy.Builder> getHashPolicyBuilderList()
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
public boolean hasCors()
Indicates that the route has a CORS policy.
.envoy.config.route.v3.CorsPolicy cors = 17;- Specified by:
hasCorsin interfaceRouteActionOrBuilder- Returns:
- Whether the cors field is set.
-
getCors
public CorsPolicy getCors()
Indicates that the route has a CORS policy.
.envoy.config.route.v3.CorsPolicy cors = 17;- Specified by:
getCorsin interfaceRouteActionOrBuilder- Returns:
- The cors.
-
setCors
public RouteAction.Builder setCors(CorsPolicy value)
Indicates that the route has a CORS policy.
.envoy.config.route.v3.CorsPolicy cors = 17;
-
setCors
public RouteAction.Builder setCors(CorsPolicy.Builder builderForValue)
Indicates that the route has a CORS policy.
.envoy.config.route.v3.CorsPolicy cors = 17;
-
mergeCors
public RouteAction.Builder mergeCors(CorsPolicy value)
Indicates that the route has a CORS policy.
.envoy.config.route.v3.CorsPolicy cors = 17;
-
clearCors
public RouteAction.Builder clearCors()
Indicates that the route has a CORS policy.
.envoy.config.route.v3.CorsPolicy cors = 17;
-
getCorsBuilder
public CorsPolicy.Builder getCorsBuilder()
Indicates that the route has a CORS policy.
.envoy.config.route.v3.CorsPolicy cors = 17;
-
getCorsOrBuilder
public CorsPolicyOrBuilder getCorsOrBuilder()
Indicates that the route has a CORS policy.
.envoy.config.route.v3.CorsPolicy cors = 17;- Specified by:
getCorsOrBuilderin interfaceRouteActionOrBuilder
-
hasMaxGrpcTimeout
@Deprecated public boolean hasMaxGrpcTimeout()
Deprecated.envoy.config.route.v3.RouteAction.max_grpc_timeout is deprecated. See envoy/config/route/v3/route_components.proto;l=1329Deprecated 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"];- Specified by:
hasMaxGrpcTimeoutin interfaceRouteActionOrBuilder- Returns:
- Whether the maxGrpcTimeout field is set.
-
getMaxGrpcTimeout
@Deprecated public 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=1329Deprecated 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"];- Specified by:
getMaxGrpcTimeoutin interfaceRouteActionOrBuilder- Returns:
- The maxGrpcTimeout.
-
setMaxGrpcTimeout
@Deprecated public RouteAction.Builder setMaxGrpcTimeout(com.google.protobuf.Duration value)
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"];
-
setMaxGrpcTimeout
@Deprecated public RouteAction.Builder setMaxGrpcTimeout(com.google.protobuf.Duration.Builder builderForValue)
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"];
-
mergeMaxGrpcTimeout
@Deprecated public RouteAction.Builder mergeMaxGrpcTimeout(com.google.protobuf.Duration value)
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"];
-
clearMaxGrpcTimeout
@Deprecated public RouteAction.Builder clearMaxGrpcTimeout()
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"];
-
getMaxGrpcTimeoutBuilder
@Deprecated public com.google.protobuf.Duration.Builder getMaxGrpcTimeoutBuilder()
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"];
-
getMaxGrpcTimeoutOrBuilder
@Deprecated public 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"];- Specified by:
getMaxGrpcTimeoutOrBuilderin interfaceRouteActionOrBuilder
-
hasGrpcTimeoutOffset
@Deprecated public boolean hasGrpcTimeoutOffset()
Deprecated.envoy.config.route.v3.RouteAction.grpc_timeout_offset is deprecated. See envoy/config/route/v3/route_components.proto;l=1340Deprecated 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"];- Specified by:
hasGrpcTimeoutOffsetin interfaceRouteActionOrBuilder- Returns:
- Whether the grpcTimeoutOffset field is set.
-
getGrpcTimeoutOffset
@Deprecated public 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=1340Deprecated 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"];- Specified by:
getGrpcTimeoutOffsetin interfaceRouteActionOrBuilder- Returns:
- The grpcTimeoutOffset.
-
setGrpcTimeoutOffset
@Deprecated public RouteAction.Builder setGrpcTimeoutOffset(com.google.protobuf.Duration value)
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"];
-
setGrpcTimeoutOffset
@Deprecated public RouteAction.Builder setGrpcTimeoutOffset(com.google.protobuf.Duration.Builder builderForValue)
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"];
-
mergeGrpcTimeoutOffset
@Deprecated public RouteAction.Builder mergeGrpcTimeoutOffset(com.google.protobuf.Duration value)
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"];
-
clearGrpcTimeoutOffset
@Deprecated public RouteAction.Builder clearGrpcTimeoutOffset()
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"];
-
getGrpcTimeoutOffsetBuilder
@Deprecated public com.google.protobuf.Duration.Builder getGrpcTimeoutOffsetBuilder()
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"];
-
getGrpcTimeoutOffsetOrBuilder
@Deprecated public 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"];- Specified by:
getGrpcTimeoutOffsetOrBuilderin interfaceRouteActionOrBuilder
-
getUpgradeConfigsList
public List<RouteAction.UpgradeConfig> getUpgradeConfigsList()
repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;- Specified by:
getUpgradeConfigsListin interfaceRouteActionOrBuilder
-
getUpgradeConfigsCount
public int getUpgradeConfigsCount()
repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;- Specified by:
getUpgradeConfigsCountin interfaceRouteActionOrBuilder
-
getUpgradeConfigs
public RouteAction.UpgradeConfig getUpgradeConfigs(int index)
repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;- Specified by:
getUpgradeConfigsin interfaceRouteActionOrBuilder
-
setUpgradeConfigs
public RouteAction.Builder setUpgradeConfigs(int index, RouteAction.UpgradeConfig value)
repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;
-
setUpgradeConfigs
public RouteAction.Builder setUpgradeConfigs(int index, RouteAction.UpgradeConfig.Builder builderForValue)
repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;
-
addUpgradeConfigs
public RouteAction.Builder addUpgradeConfigs(RouteAction.UpgradeConfig value)
repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;
-
addUpgradeConfigs
public RouteAction.Builder addUpgradeConfigs(int index, RouteAction.UpgradeConfig value)
repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;
-
addUpgradeConfigs
public RouteAction.Builder addUpgradeConfigs(RouteAction.UpgradeConfig.Builder builderForValue)
repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;
-
addUpgradeConfigs
public RouteAction.Builder addUpgradeConfigs(int index, RouteAction.UpgradeConfig.Builder builderForValue)
repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;
-
addAllUpgradeConfigs
public RouteAction.Builder addAllUpgradeConfigs(Iterable<? extends RouteAction.UpgradeConfig> values)
repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;
-
clearUpgradeConfigs
public RouteAction.Builder clearUpgradeConfigs()
repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;
-
removeUpgradeConfigs
public RouteAction.Builder removeUpgradeConfigs(int index)
repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;
-
getUpgradeConfigsBuilder
public RouteAction.UpgradeConfig.Builder getUpgradeConfigsBuilder(int index)
repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;
-
getUpgradeConfigsOrBuilder
public RouteAction.UpgradeConfigOrBuilder getUpgradeConfigsOrBuilder(int index)
repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;- Specified by:
getUpgradeConfigsOrBuilderin interfaceRouteActionOrBuilder
-
getUpgradeConfigsOrBuilderList
public List<? extends RouteAction.UpgradeConfigOrBuilder> getUpgradeConfigsOrBuilderList()
repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;- Specified by:
getUpgradeConfigsOrBuilderListin interfaceRouteActionOrBuilder
-
addUpgradeConfigsBuilder
public RouteAction.UpgradeConfig.Builder addUpgradeConfigsBuilder()
repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;
-
addUpgradeConfigsBuilder
public RouteAction.UpgradeConfig.Builder addUpgradeConfigsBuilder(int index)
repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;
-
getUpgradeConfigsBuilderList
public List<RouteAction.UpgradeConfig.Builder> getUpgradeConfigsBuilderList()
repeated .envoy.config.route.v3.RouteAction.UpgradeConfig upgrade_configs = 25;
-
hasInternalRedirectPolicy
public 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;- Specified by:
hasInternalRedirectPolicyin interfaceRouteActionOrBuilder- Returns:
- Whether the internalRedirectPolicy field is set.
-
getInternalRedirectPolicy
public 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;- Specified by:
getInternalRedirectPolicyin interfaceRouteActionOrBuilder- Returns:
- The internalRedirectPolicy.
-
setInternalRedirectPolicy
public RouteAction.Builder setInternalRedirectPolicy(InternalRedirectPolicy value)
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;
-
setInternalRedirectPolicy
public RouteAction.Builder setInternalRedirectPolicy(InternalRedirectPolicy.Builder builderForValue)
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;
-
mergeInternalRedirectPolicy
public RouteAction.Builder mergeInternalRedirectPolicy(InternalRedirectPolicy value)
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;
-
clearInternalRedirectPolicy
public RouteAction.Builder clearInternalRedirectPolicy()
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;
-
getInternalRedirectPolicyBuilder
public InternalRedirectPolicy.Builder getInternalRedirectPolicyBuilder()
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;
-
getInternalRedirectPolicyOrBuilder
public 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;- Specified by:
getInternalRedirectPolicyOrBuilderin interfaceRouteActionOrBuilder
-
getInternalRedirectActionValue
@Deprecated public int getInternalRedirectActionValue()
Deprecated.envoy.config.route.v3.RouteAction.internal_redirect_action is deprecated. See envoy/config/route/v3/route_components.proto;l=1351.envoy.config.route.v3.RouteAction.InternalRedirectAction internal_redirect_action = 26 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];- Specified by:
getInternalRedirectActionValuein interfaceRouteActionOrBuilder- Returns:
- The enum numeric value on the wire for internalRedirectAction.
-
setInternalRedirectActionValue
@Deprecated public RouteAction.Builder setInternalRedirectActionValue(int value)
Deprecated.envoy.config.route.v3.RouteAction.internal_redirect_action is deprecated. See envoy/config/route/v3/route_components.proto;l=1351.envoy.config.route.v3.RouteAction.InternalRedirectAction internal_redirect_action = 26 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];- Parameters:
value- The enum numeric value on the wire for internalRedirectAction to set.- Returns:
- This builder for chaining.
-
getInternalRedirectAction
@Deprecated public RouteAction.InternalRedirectAction getInternalRedirectAction()
Deprecated.envoy.config.route.v3.RouteAction.internal_redirect_action is deprecated. See envoy/config/route/v3/route_components.proto;l=1351.envoy.config.route.v3.RouteAction.InternalRedirectAction internal_redirect_action = 26 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];- Specified by:
getInternalRedirectActionin interfaceRouteActionOrBuilder- Returns:
- The internalRedirectAction.
-
setInternalRedirectAction
@Deprecated public RouteAction.Builder setInternalRedirectAction(RouteAction.InternalRedirectAction value)
Deprecated.envoy.config.route.v3.RouteAction.internal_redirect_action is deprecated. See envoy/config/route/v3/route_components.proto;l=1351.envoy.config.route.v3.RouteAction.InternalRedirectAction internal_redirect_action = 26 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];- Parameters:
value- The internalRedirectAction to set.- Returns:
- This builder for chaining.
-
clearInternalRedirectAction
@Deprecated public RouteAction.Builder clearInternalRedirectAction()
Deprecated.envoy.config.route.v3.RouteAction.internal_redirect_action is deprecated. See envoy/config/route/v3/route_components.proto;l=1351.envoy.config.route.v3.RouteAction.InternalRedirectAction internal_redirect_action = 26 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];- Returns:
- This builder for chaining.
-
hasMaxInternalRedirects
@Deprecated public boolean hasMaxInternalRedirects()
Deprecated.envoy.config.route.v3.RouteAction.max_internal_redirects is deprecated. See envoy/config/route/v3/route_components.proto;l=1368An 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"];- Specified by:
hasMaxInternalRedirectsin interfaceRouteActionOrBuilder- Returns:
- Whether the maxInternalRedirects field is set.
-
getMaxInternalRedirects
@Deprecated public 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=1368An 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"];- Specified by:
getMaxInternalRedirectsin interfaceRouteActionOrBuilder- Returns:
- The maxInternalRedirects.
-
setMaxInternalRedirects
@Deprecated public RouteAction.Builder setMaxInternalRedirects(com.google.protobuf.UInt32Value value)
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"];
-
setMaxInternalRedirects
@Deprecated public RouteAction.Builder setMaxInternalRedirects(com.google.protobuf.UInt32Value.Builder builderForValue)
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"];
-
mergeMaxInternalRedirects
@Deprecated public RouteAction.Builder mergeMaxInternalRedirects(com.google.protobuf.UInt32Value value)
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"];
-
clearMaxInternalRedirects
@Deprecated public RouteAction.Builder clearMaxInternalRedirects()
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"];
-
getMaxInternalRedirectsBuilder
@Deprecated public com.google.protobuf.UInt32Value.Builder getMaxInternalRedirectsBuilder()
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"];
-
getMaxInternalRedirectsOrBuilder
@Deprecated public 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"];- Specified by:
getMaxInternalRedirectsOrBuilderin interfaceRouteActionOrBuilder
-
hasHedgePolicy
public 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;- Specified by:
hasHedgePolicyin interfaceRouteActionOrBuilder- Returns:
- Whether the hedgePolicy field is set.
-
getHedgePolicy
public 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;- Specified by:
getHedgePolicyin interfaceRouteActionOrBuilder- Returns:
- The hedgePolicy.
-
setHedgePolicy
public RouteAction.Builder setHedgePolicy(HedgePolicy value)
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;
-
setHedgePolicy
public RouteAction.Builder setHedgePolicy(HedgePolicy.Builder builderForValue)
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;
-
mergeHedgePolicy
public RouteAction.Builder mergeHedgePolicy(HedgePolicy value)
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;
-
clearHedgePolicy
public RouteAction.Builder clearHedgePolicy()
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;
-
getHedgePolicyBuilder
public HedgePolicy.Builder getHedgePolicyBuilder()
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;
-
getHedgePolicyOrBuilder
public 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;- Specified by:
getHedgePolicyOrBuilderin interfaceRouteActionOrBuilder
-
hasMaxStreamDuration
public boolean hasMaxStreamDuration()
Specifies the maximum stream duration for this route.
.envoy.config.route.v3.RouteAction.MaxStreamDuration max_stream_duration = 36;- Specified by:
hasMaxStreamDurationin interfaceRouteActionOrBuilder- Returns:
- Whether the maxStreamDuration field is set.
-
getMaxStreamDuration
public RouteAction.MaxStreamDuration getMaxStreamDuration()
Specifies the maximum stream duration for this route.
.envoy.config.route.v3.RouteAction.MaxStreamDuration max_stream_duration = 36;- Specified by:
getMaxStreamDurationin interfaceRouteActionOrBuilder- Returns:
- The maxStreamDuration.
-
setMaxStreamDuration
public RouteAction.Builder setMaxStreamDuration(RouteAction.MaxStreamDuration value)
Specifies the maximum stream duration for this route.
.envoy.config.route.v3.RouteAction.MaxStreamDuration max_stream_duration = 36;
-
setMaxStreamDuration
public RouteAction.Builder setMaxStreamDuration(RouteAction.MaxStreamDuration.Builder builderForValue)
Specifies the maximum stream duration for this route.
.envoy.config.route.v3.RouteAction.MaxStreamDuration max_stream_duration = 36;
-
mergeMaxStreamDuration
public RouteAction.Builder mergeMaxStreamDuration(RouteAction.MaxStreamDuration value)
Specifies the maximum stream duration for this route.
.envoy.config.route.v3.RouteAction.MaxStreamDuration max_stream_duration = 36;
-
clearMaxStreamDuration
public RouteAction.Builder clearMaxStreamDuration()
Specifies the maximum stream duration for this route.
.envoy.config.route.v3.RouteAction.MaxStreamDuration max_stream_duration = 36;
-
getMaxStreamDurationBuilder
public RouteAction.MaxStreamDuration.Builder getMaxStreamDurationBuilder()
Specifies the maximum stream duration for this route.
.envoy.config.route.v3.RouteAction.MaxStreamDuration max_stream_duration = 36;
-
getMaxStreamDurationOrBuilder
public RouteAction.MaxStreamDurationOrBuilder getMaxStreamDurationOrBuilder()
Specifies the maximum stream duration for this route.
.envoy.config.route.v3.RouteAction.MaxStreamDuration max_stream_duration = 36;- Specified by:
getMaxStreamDurationOrBuilderin interfaceRouteActionOrBuilder
-
setUnknownFields
public final RouteAction.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<RouteAction.Builder>
-
mergeUnknownFields
public final RouteAction.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<RouteAction.Builder>
-
-