envoy.api.v2.route

Interface RouteOuterClass.RouteActionOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

RouteOuterClass.RouteAction, RouteOuterClass.RouteAction.Builder

Enclosing class:

RouteOuterClass

public static interface RouteOuterClass.RouteActionOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
com.google.protobuf.BoolValue	getAutoHostRewrite() Indicates that during forwarding, the host header will be swapped with the hostname of the upstream host chosen by the cluster manager.
com.google.protobuf.BoolValueOrBuilder	getAutoHostRewriteOrBuilder() Indicates that during forwarding, the host header will be swapped with the hostname of the upstream host chosen by the cluster manager.
String	getCluster() Indicates the upstream cluster to which the request should be routed to.
com.google.protobuf.ByteString	getClusterBytes() Indicates the upstream cluster to which the request should be routed to.
String	getClusterHeader() Envoy will determine the cluster to route to by reading the value of the HTTP header named by cluster_header from the request headers.
com.google.protobuf.ByteString	getClusterHeaderBytes() Envoy will determine the cluster to route to by reading the value of the HTTP header named by cluster_header from the request headers.
RouteOuterClass.RouteAction.ClusterNotFoundResponseCode	getClusterNotFoundResponseCode() The HTTP status code to use when configured cluster is not found.
int	getClusterNotFoundResponseCodeValue() The HTTP status code to use when configured cluster is not found.
RouteOuterClass.RouteAction.ClusterSpecifierCase	getClusterSpecifierCase()
RouteOuterClass.CorsPolicy	getCors() Indicates that the route has a CORS policy.
RouteOuterClass.CorsPolicyOrBuilder	getCorsOrBuilder() Indicates that the route has a CORS policy.
RouteOuterClass.RouteAction.HashPolicy	getHashPolicy(int index) Specifies a list of hash policies to use for ring hash load balancing.
int	getHashPolicyCount() Specifies a list of hash policies to use for ring hash load balancing.
List<RouteOuterClass.RouteAction.HashPolicy>	getHashPolicyList() Specifies a list of hash policies to use for ring hash load balancing.
RouteOuterClass.RouteAction.HashPolicyOrBuilder	getHashPolicyOrBuilder(int index) Specifies a list of hash policies to use for ring hash load balancing.
List<? extends RouteOuterClass.RouteAction.HashPolicyOrBuilder>	getHashPolicyOrBuilderList() Specifies a list of hash policies to use for ring hash load balancing.
String	getHostRewrite() Indicates that during forwarding, the host header will be swapped with this value.
com.google.protobuf.ByteString	getHostRewriteBytes() Indicates that during forwarding, the host header will be swapped with this value.
RouteOuterClass.RouteAction.HostRewriteSpecifierCase	getHostRewriteSpecifierCase()
com.google.protobuf.BoolValue	getIncludeVhRateLimits() Specifies if the rate limit filter should include the virtual host rate limits.
com.google.protobuf.BoolValueOrBuilder	getIncludeVhRateLimitsOrBuilder() Specifies if the rate limit filter should include the virtual host rate limits.
Base.Metadata	getMetadataMatch() Optional endpoint metadata match criteria.
Base.MetadataOrBuilder	getMetadataMatchOrBuilder() Optional endpoint metadata match criteria.
String	getPrefixRewrite() Indicates that during forwarding, the matched prefix (or path) should be swapped with this value.
com.google.protobuf.ByteString	getPrefixRewriteBytes() Indicates that during forwarding, the matched prefix (or path) should be swapped with this value.
Base.RoutingPriority	getPriority() Optionally specifies the :ref:`routing priority <arch_overview_http_routing_priority>`.
int	getPriorityValue() Optionally specifies the :ref:`routing priority <arch_overview_http_routing_priority>`.
RouteOuterClass.RateLimit	getRateLimits(int index) Specifies a set of rate limit configurations that could be applied to the route.
int	getRateLimitsCount() Specifies a set of rate limit configurations that could be applied to the route.
List<RouteOuterClass.RateLimit>	getRateLimitsList() Specifies a set of rate limit configurations that could be applied to the route.
RouteOuterClass.RateLimitOrBuilder	getRateLimitsOrBuilder(int index) Specifies a set of rate limit configurations that could be applied to the route.
List<? extends RouteOuterClass.RateLimitOrBuilder>	getRateLimitsOrBuilderList() Specifies a set of rate limit configurations that could be applied to the route.
Base.HeaderValueOption	getRequestHeadersToAdd(int index) Specifies a set of headers that will be added to requests matching this route.
int	getRequestHeadersToAddCount() Specifies a set of headers that will be added to requests matching this route.
List<Base.HeaderValueOption>	getRequestHeadersToAddList() Specifies a set of headers that will be added to requests matching this route.
Base.HeaderValueOptionOrBuilder	getRequestHeadersToAddOrBuilder(int index) Specifies a set of headers that will be added to requests matching this route.
List<? extends Base.HeaderValueOptionOrBuilder>	getRequestHeadersToAddOrBuilderList() Specifies a set of headers that will be added to requests matching this route.
RouteOuterClass.RouteAction.RequestMirrorPolicy	getRequestMirrorPolicy() Indicates that the route has a request mirroring policy.
RouteOuterClass.RouteAction.RequestMirrorPolicyOrBuilder	getRequestMirrorPolicyOrBuilder() Indicates that the route has a request mirroring policy.
Base.HeaderValueOption	getResponseHeadersToAdd(int index) Specifies a set of headers that will be added to responses to requests matching this route.
int	getResponseHeadersToAddCount() Specifies a set of headers that will be added to responses to requests matching this route.
List<Base.HeaderValueOption>	getResponseHeadersToAddList() Specifies a set of headers that will be added to responses to requests matching this route.
Base.HeaderValueOptionOrBuilder	getResponseHeadersToAddOrBuilder(int index) Specifies a set of headers that will be added to responses to requests matching this route.
List<? extends Base.HeaderValueOptionOrBuilder>	getResponseHeadersToAddOrBuilderList() Specifies a set of headers that will be added to responses to requests matching this route.
String	getResponseHeadersToRemove(int index) Specifies a list of HTTP headers that should be removed from each response to requests matching this route.
com.google.protobuf.ByteString	getResponseHeadersToRemoveBytes(int index) Specifies a list of HTTP headers that should be removed from each response to requests matching this route.
int	getResponseHeadersToRemoveCount() Specifies a list of HTTP headers that should be removed from each response to requests matching this route.
List<String>	getResponseHeadersToRemoveList() Specifies a list of HTTP headers that should be removed from each response to requests matching this route.
RouteOuterClass.RouteAction.RetryPolicy	getRetryPolicy() Indicates that the route has a retry policy.
RouteOuterClass.RouteAction.RetryPolicyOrBuilder	getRetryPolicyOrBuilder() Indicates that the route has a retry policy.
com.google.protobuf.Duration	getTimeout() Specifies the timeout for the route.
com.google.protobuf.DurationOrBuilder	getTimeoutOrBuilder() Specifies the timeout for the route.
com.google.protobuf.BoolValue	getUseWebsocket() Indicates that a HTTP/1.1 client connection to this particular route should be allowed (and expected) to upgrade to a WebSocket connection.
com.google.protobuf.BoolValueOrBuilder	getUseWebsocketOrBuilder() Indicates that a HTTP/1.1 client connection to this particular route should be allowed (and expected) to upgrade to a WebSocket connection.
RouteOuterClass.WeightedCluster	getWeightedClusters() Multiple upstream clusters can be specified for a given route.
RouteOuterClass.WeightedClusterOrBuilder	getWeightedClustersOrBuilder() Multiple upstream clusters can be specified for a given route.
boolean	hasAutoHostRewrite() Indicates that during forwarding, the host header will be swapped with the hostname of the upstream host chosen by the cluster manager.
boolean	hasCors() Indicates that the route has a CORS policy.
boolean	hasIncludeVhRateLimits() Specifies if the rate limit filter should include the virtual host rate limits.
boolean	hasMetadataMatch() Optional endpoint metadata match criteria.
boolean	hasRequestMirrorPolicy() Indicates that the route has a request mirroring policy.
boolean	hasRetryPolicy() Indicates that the route has a retry policy.
boolean	hasTimeout() Specifies the timeout for the route.
boolean	hasUseWebsocket() Indicates that a HTTP/1.1 client connection to this particular route should be allowed (and expected) to upgrade to a WebSocket connection.
boolean	hasWeightedClusters() Multiple upstream clusters can be specified for a given route.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getCluster

String getCluster()

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

string cluster = 1;

getClusterBytes

com.google.protobuf.ByteString getClusterBytes()

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

string cluster = 1;

getClusterHeader

String getClusterHeader()

 Envoy will determine the cluster to route to by reading the value of the
 HTTP header named by cluster_header from the request headers. If the
 header is not found or the referenced cluster does not exist, Envoy will
 return a 404 response.
 .. attention::
   Internally, Envoy always uses the HTTP/2 *:authority* header to represent the HTTP/1
   *Host* header. Thus, if attempting to match on *Host*, match on *:authority* instead.
 

string cluster_header = 2;

getClusterHeaderBytes

com.google.protobuf.ByteString getClusterHeaderBytes()

 Envoy will determine the cluster to route to by reading the value of the
 HTTP header named by cluster_header from the request headers. If the
 header is not found or the referenced cluster does not exist, Envoy will
 return a 404 response.
 .. attention::
   Internally, Envoy always uses the HTTP/2 *:authority* header to represent the HTTP/1
   *Host* header. Thus, if attempting to match on *Host*, match on *:authority* instead.
 

string cluster_header = 2;

hasWeightedClusters

boolean hasWeightedClusters()

 Multiple upstream clusters can be specified for a given route. The
 request is routed to one of the upstream clusters based on weights
 assigned to each cluster. See
 :ref:`traffic splitting <config_http_conn_man_route_table_traffic_splitting_split>`
 for additional documentation.
 

.envoy.api.v2.route.WeightedCluster weighted_clusters = 3;

getWeightedClusters

RouteOuterClass.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.api.v2.route.WeightedCluster weighted_clusters = 3;

getWeightedClustersOrBuilder

RouteOuterClass.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.api.v2.route.WeightedCluster weighted_clusters = 3;

getClusterNotFoundResponseCodeValue

int getClusterNotFoundResponseCodeValue()

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

.envoy.api.v2.route.RouteAction.ClusterNotFoundResponseCode cluster_not_found_response_code = 20 [(.validate.rules) = { ... }

getClusterNotFoundResponseCode

RouteOuterClass.RouteAction.ClusterNotFoundResponseCode getClusterNotFoundResponseCode()

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

.envoy.api.v2.route.RouteAction.ClusterNotFoundResponseCode cluster_not_found_response_code = 20 [(.validate.rules) = { ... }

hasMetadataMatch

boolean hasMetadataMatch()

 Optional endpoint metadata match criteria. Only endpoints in the upstream
 cluster with metadata matching that set in metadata_match will be
 considered. The filter name should be specified as *envoy.lb*.
 

.envoy.api.v2.core.Metadata metadata_match = 4;

getMetadataMatch

Base.Metadata getMetadataMatch()

 Optional endpoint metadata match criteria. Only endpoints in the upstream
 cluster with metadata matching that set in metadata_match will be
 considered. The filter name should be specified as *envoy.lb*.
 

.envoy.api.v2.core.Metadata metadata_match = 4;

getMetadataMatchOrBuilder

Base.MetadataOrBuilder getMetadataMatchOrBuilder()

 Optional endpoint metadata match criteria. Only endpoints in the upstream
 cluster with metadata matching that set in metadata_match will be
 considered. The filter name should be specified as *envoy.lb*.
 

.envoy.api.v2.core.Metadata metadata_match = 4;

getPrefixRewrite

String getPrefixRewrite()

 Indicates that during forwarding, the matched prefix (or path) should be
 swapped with this value. This option allows application URLs to be rooted
 at a different path from those exposed at the reverse proxy layer.
 

string prefix_rewrite = 5;

getPrefixRewriteBytes

com.google.protobuf.ByteString getPrefixRewriteBytes()

 Indicates that during forwarding, the matched prefix (or path) should be
 swapped with this value. This option allows application URLs to be rooted
 at a different path from those exposed at the reverse proxy layer.
 

string prefix_rewrite = 5;

getHostRewrite

String getHostRewrite()

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

string host_rewrite = 6;

getHostRewriteBytes

com.google.protobuf.ByteString getHostRewriteBytes()

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

string host_rewrite = 6;

hasAutoHostRewrite

boolean hasAutoHostRewrite()

 Indicates that during forwarding, the host header will be swapped with
 the hostname of the upstream host chosen by the cluster manager. This
 option is applicable only when the destination cluster for a route is of
 type *strict_dns* or *logical_dns*. Setting this to true with other cluster
 types has no effect.
 

.google.protobuf.BoolValue auto_host_rewrite = 7;

getAutoHostRewrite

com.google.protobuf.BoolValue getAutoHostRewrite()

 Indicates that during forwarding, the host header will be swapped with
 the hostname of the upstream host chosen by the cluster manager. This
 option is applicable only when the destination cluster for a route is of
 type *strict_dns* or *logical_dns*. Setting this to true with other cluster
 types has no effect.
 

.google.protobuf.BoolValue auto_host_rewrite = 7;

getAutoHostRewriteOrBuilder

com.google.protobuf.BoolValueOrBuilder getAutoHostRewriteOrBuilder()

 Indicates that during forwarding, the host header will be swapped with
 the hostname of the upstream host chosen by the cluster manager. This
 option is applicable only when the destination cluster for a route is of
 type *strict_dns* or *logical_dns*. Setting this to true with other cluster
 types has no effect.
 

.google.protobuf.BoolValue auto_host_rewrite = 7;

hasTimeout

boolean hasTimeout()

 Specifies the timeout for the route. If not specified, the default is 15s.
 .. 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 [(.gogoproto.stdduration) = true];

getTimeout

com.google.protobuf.Duration getTimeout()

 Specifies the timeout for the route. If not specified, the default is 15s.
 .. 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 [(.gogoproto.stdduration) = true];

getTimeoutOrBuilder

com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder()

 Specifies the timeout for the route. If not specified, the default is 15s.
 .. 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 [(.gogoproto.stdduration) = true];

hasRetryPolicy

boolean hasRetryPolicy()

 Indicates that the route has a retry policy.
 

.envoy.api.v2.route.RouteAction.RetryPolicy retry_policy = 9;

getRetryPolicy

RouteOuterClass.RouteAction.RetryPolicy getRetryPolicy()

 Indicates that the route has a retry policy.
 

.envoy.api.v2.route.RouteAction.RetryPolicy retry_policy = 9;

getRetryPolicyOrBuilder

RouteOuterClass.RouteAction.RetryPolicyOrBuilder getRetryPolicyOrBuilder()

 Indicates that the route has a retry policy.
 

.envoy.api.v2.route.RouteAction.RetryPolicy retry_policy = 9;

hasRequestMirrorPolicy

boolean hasRequestMirrorPolicy()

 Indicates that the route has a request mirroring policy.
 

.envoy.api.v2.route.RouteAction.RequestMirrorPolicy request_mirror_policy = 10;

getRequestMirrorPolicy

RouteOuterClass.RouteAction.RequestMirrorPolicy getRequestMirrorPolicy()

 Indicates that the route has a request mirroring policy.
 

.envoy.api.v2.route.RouteAction.RequestMirrorPolicy request_mirror_policy = 10;

getRequestMirrorPolicyOrBuilder

RouteOuterClass.RouteAction.RequestMirrorPolicyOrBuilder getRequestMirrorPolicyOrBuilder()

 Indicates that the route has a request mirroring policy.
 

.envoy.api.v2.route.RouteAction.RequestMirrorPolicy request_mirror_policy = 10;

getPriorityValue

int getPriorityValue()

 Optionally specifies the :ref:`routing priority <arch_overview_http_routing_priority>`.
 [#comment:TODO(htuch): add (validate.rules).enum.defined_only = true once
 https://github.com/lyft/protoc-gen-validate/issues/42 is resolved.]
 

.envoy.api.v2.core.RoutingPriority priority = 11;

getPriority

Base.RoutingPriority getPriority()

 Optionally specifies the :ref:`routing priority <arch_overview_http_routing_priority>`.
 [#comment:TODO(htuch): add (validate.rules).enum.defined_only = true once
 https://github.com/lyft/protoc-gen-validate/issues/42 is resolved.]
 

.envoy.api.v2.core.RoutingPriority priority = 11;

getRequestHeadersToAddList

List<Base.HeaderValueOption> getRequestHeadersToAddList()

 Specifies a set of headers that will be added to requests matching this
 route. Headers specified at this level are applied before headers from the
 enclosing :ref:`envoy_api_msg_route.VirtualHost` and
 :ref:`envoy_api_msg_RouteConfiguration`. For more information, including details on
 header value syntax, see the documentation on :ref:`custom request headers
 <config_http_conn_man_headers_custom_request_headers>`.
 

repeated .envoy.api.v2.core.HeaderValueOption request_headers_to_add = 12;

getRequestHeadersToAdd

Base.HeaderValueOption getRequestHeadersToAdd(int index)

 Specifies a set of headers that will be added to requests matching this
 route. Headers specified at this level are applied before headers from the
 enclosing :ref:`envoy_api_msg_route.VirtualHost` and
 :ref:`envoy_api_msg_RouteConfiguration`. For more information, including details on
 header value syntax, see the documentation on :ref:`custom request headers
 <config_http_conn_man_headers_custom_request_headers>`.
 

repeated .envoy.api.v2.core.HeaderValueOption request_headers_to_add = 12;

getRequestHeadersToAddCount

int getRequestHeadersToAddCount()

 Specifies a set of headers that will be added to requests matching this
 route. Headers specified at this level are applied before headers from the
 enclosing :ref:`envoy_api_msg_route.VirtualHost` and
 :ref:`envoy_api_msg_RouteConfiguration`. For more information, including details on
 header value syntax, see the documentation on :ref:`custom request headers
 <config_http_conn_man_headers_custom_request_headers>`.
 

repeated .envoy.api.v2.core.HeaderValueOption request_headers_to_add = 12;

getRequestHeadersToAddOrBuilderList

List<? extends Base.HeaderValueOptionOrBuilder> getRequestHeadersToAddOrBuilderList()

 Specifies a set of headers that will be added to requests matching this
 route. Headers specified at this level are applied before headers from the
 enclosing :ref:`envoy_api_msg_route.VirtualHost` and
 :ref:`envoy_api_msg_RouteConfiguration`. For more information, including details on
 header value syntax, see the documentation on :ref:`custom request headers
 <config_http_conn_man_headers_custom_request_headers>`.
 

repeated .envoy.api.v2.core.HeaderValueOption request_headers_to_add = 12;

getRequestHeadersToAddOrBuilder

Base.HeaderValueOptionOrBuilder getRequestHeadersToAddOrBuilder(int index)

 Specifies a set of headers that will be added to requests matching this
 route. Headers specified at this level are applied before headers from the
 enclosing :ref:`envoy_api_msg_route.VirtualHost` and
 :ref:`envoy_api_msg_RouteConfiguration`. For more information, including details on
 header value syntax, see the documentation on :ref:`custom request headers
 <config_http_conn_man_headers_custom_request_headers>`.
 

repeated .envoy.api.v2.core.HeaderValueOption request_headers_to_add = 12;

getResponseHeadersToAddList

List<Base.HeaderValueOption> getResponseHeadersToAddList()

 Specifies a set of headers that will be added to responses to requests
 matching this route. Headers specified at this level are applied before
 headers from the enclosing :ref:`envoy_api_msg_route.VirtualHost` and
 :ref:`envoy_api_msg_RouteConfiguration`. For more information, including
 details on header value syntax, see the documentation on
 :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
 

repeated .envoy.api.v2.core.HeaderValueOption response_headers_to_add = 18;

getResponseHeadersToAdd

Base.HeaderValueOption getResponseHeadersToAdd(int index)

 Specifies a set of headers that will be added to responses to requests
 matching this route. Headers specified at this level are applied before
 headers from the enclosing :ref:`envoy_api_msg_route.VirtualHost` and
 :ref:`envoy_api_msg_RouteConfiguration`. For more information, including
 details on header value syntax, see the documentation on
 :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
 

repeated .envoy.api.v2.core.HeaderValueOption response_headers_to_add = 18;

getResponseHeadersToAddCount

int getResponseHeadersToAddCount()

 Specifies a set of headers that will be added to responses to requests
 matching this route. Headers specified at this level are applied before
 headers from the enclosing :ref:`envoy_api_msg_route.VirtualHost` and
 :ref:`envoy_api_msg_RouteConfiguration`. For more information, including
 details on header value syntax, see the documentation on
 :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
 

repeated .envoy.api.v2.core.HeaderValueOption response_headers_to_add = 18;

getResponseHeadersToAddOrBuilderList

List<? extends Base.HeaderValueOptionOrBuilder> getResponseHeadersToAddOrBuilderList()

 Specifies a set of headers that will be added to responses to requests
 matching this route. Headers specified at this level are applied before
 headers from the enclosing :ref:`envoy_api_msg_route.VirtualHost` and
 :ref:`envoy_api_msg_RouteConfiguration`. For more information, including
 details on header value syntax, see the documentation on
 :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
 

repeated .envoy.api.v2.core.HeaderValueOption response_headers_to_add = 18;

getResponseHeadersToAddOrBuilder

Base.HeaderValueOptionOrBuilder getResponseHeadersToAddOrBuilder(int index)

 Specifies a set of headers that will be added to responses to requests
 matching this route. Headers specified at this level are applied before
 headers from the enclosing :ref:`envoy_api_msg_route.VirtualHost` and
 :ref:`envoy_api_msg_RouteConfiguration`. For more information, including
 details on header value syntax, see the documentation on
 :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
 

repeated .envoy.api.v2.core.HeaderValueOption response_headers_to_add = 18;

getResponseHeadersToRemoveList

List<String> getResponseHeadersToRemoveList()

 Specifies a list of HTTP headers that should be removed from each response
 to requests matching this route.
 

repeated string response_headers_to_remove = 19;

getResponseHeadersToRemoveCount

int getResponseHeadersToRemoveCount()

 Specifies a list of HTTP headers that should be removed from each response
 to requests matching this route.
 

repeated string response_headers_to_remove = 19;

getResponseHeadersToRemove

String getResponseHeadersToRemove(int index)

 Specifies a list of HTTP headers that should be removed from each response
 to requests matching this route.
 

repeated string response_headers_to_remove = 19;

getResponseHeadersToRemoveBytes

com.google.protobuf.ByteString getResponseHeadersToRemoveBytes(int index)

 Specifies a list of HTTP headers that should be removed from each response
 to requests matching this route.
 

repeated string response_headers_to_remove = 19;

getRateLimitsList

List<RouteOuterClass.RateLimit> getRateLimitsList()

 Specifies a set of rate limit configurations that could be applied to the
 route.
 

repeated .envoy.api.v2.route.RateLimit rate_limits = 13;

getRateLimits

RouteOuterClass.RateLimit getRateLimits(int index)

 Specifies a set of rate limit configurations that could be applied to the
 route.
 

repeated .envoy.api.v2.route.RateLimit rate_limits = 13;

getRateLimitsCount

int getRateLimitsCount()

 Specifies a set of rate limit configurations that could be applied to the
 route.
 

repeated .envoy.api.v2.route.RateLimit rate_limits = 13;

getRateLimitsOrBuilderList

List<? extends RouteOuterClass.RateLimitOrBuilder> getRateLimitsOrBuilderList()

 Specifies a set of rate limit configurations that could be applied to the
 route.
 

repeated .envoy.api.v2.route.RateLimit rate_limits = 13;

getRateLimitsOrBuilder

RouteOuterClass.RateLimitOrBuilder getRateLimitsOrBuilder(int index)

 Specifies a set of rate limit configurations that could be applied to the
 route.
 

repeated .envoy.api.v2.route.RateLimit rate_limits = 13;

hasIncludeVhRateLimits

boolean hasIncludeVhRateLimits()

 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_api_field_route.VirtualHost.rate_limits>` are not applied to the
 request.
 

.google.protobuf.BoolValue include_vh_rate_limits = 14;

getIncludeVhRateLimits

com.google.protobuf.BoolValue getIncludeVhRateLimits()

 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_api_field_route.VirtualHost.rate_limits>` are not applied to the
 request.
 

.google.protobuf.BoolValue include_vh_rate_limits = 14;

getIncludeVhRateLimitsOrBuilder

com.google.protobuf.BoolValueOrBuilder getIncludeVhRateLimitsOrBuilder()

 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_api_field_route.VirtualHost.rate_limits>` are not applied to the
 request.
 

.google.protobuf.BoolValue include_vh_rate_limits = 14;

getHashPolicyList

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

repeated .envoy.api.v2.route.RouteAction.HashPolicy hash_policy = 15;

getHashPolicy

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

repeated .envoy.api.v2.route.RouteAction.HashPolicy hash_policy = 15;

getHashPolicyCount

int getHashPolicyCount()

 Specifies a list of hash policies to use for ring hash load balancing. Each
 hash policy is evaluated individually and the combined result is used to
 route the request. The method of combination is deterministic such that
 identical lists of hash policies will produce the same hash. Since a hash
 policy examines specific parts of a request, it can fail to produce a hash
 (i.e. if the hashed header is not present). If (and only if) all configured
 hash policies fail to generate a hash, no hash will be produced for
 the route. In this case, the behavior is the same as if no hash policies
 were specified (i.e. the ring hash load balancer will choose a random
 backend).
 

repeated .envoy.api.v2.route.RouteAction.HashPolicy hash_policy = 15;

getHashPolicyOrBuilderList

List<? extends RouteOuterClass.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).
 

repeated .envoy.api.v2.route.RouteAction.HashPolicy hash_policy = 15;

getHashPolicyOrBuilder

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

repeated .envoy.api.v2.route.RouteAction.HashPolicy hash_policy = 15;

hasUseWebsocket

boolean hasUseWebsocket()

 Indicates that a HTTP/1.1 client connection to this particular route
 should be allowed (and expected) to upgrade to a WebSocket connection. The
 default is false.
 .. attention::
   If set to true, Envoy will expect the first request matching this route to
   contain WebSocket upgrade headers. If the headers are not present, the
   connection will be rejected. If set to true, Envoy will setup plain TCP
   proxying between the client and the upstream server. Hence, an upstream
   server that rejects the WebSocket upgrade request is also responsible for
   closing the associated connection. Until then, Envoy will continue to
   proxy data from the client to the upstream server.
   Redirects, timeouts and retries are not supported on routes where websocket upgrades are
   allowed.
 

.google.protobuf.BoolValue use_websocket = 16;

getUseWebsocket

com.google.protobuf.BoolValue getUseWebsocket()

 Indicates that a HTTP/1.1 client connection to this particular route
 should be allowed (and expected) to upgrade to a WebSocket connection. The
 default is false.
 .. attention::
   If set to true, Envoy will expect the first request matching this route to
   contain WebSocket upgrade headers. If the headers are not present, the
   connection will be rejected. If set to true, Envoy will setup plain TCP
   proxying between the client and the upstream server. Hence, an upstream
   server that rejects the WebSocket upgrade request is also responsible for
   closing the associated connection. Until then, Envoy will continue to
   proxy data from the client to the upstream server.
   Redirects, timeouts and retries are not supported on routes where websocket upgrades are
   allowed.
 

.google.protobuf.BoolValue use_websocket = 16;

getUseWebsocketOrBuilder

com.google.protobuf.BoolValueOrBuilder getUseWebsocketOrBuilder()

 Indicates that a HTTP/1.1 client connection to this particular route
 should be allowed (and expected) to upgrade to a WebSocket connection. The
 default is false.
 .. attention::
   If set to true, Envoy will expect the first request matching this route to
   contain WebSocket upgrade headers. If the headers are not present, the
   connection will be rejected. If set to true, Envoy will setup plain TCP
   proxying between the client and the upstream server. Hence, an upstream
   server that rejects the WebSocket upgrade request is also responsible for
   closing the associated connection. Until then, Envoy will continue to
   proxy data from the client to the upstream server.
   Redirects, timeouts and retries are not supported on routes where websocket upgrades are
   allowed.
 

.google.protobuf.BoolValue use_websocket = 16;

hasCors

boolean hasCors()

 Indicates that the route has a CORS policy.
 

.envoy.api.v2.route.CorsPolicy cors = 17;

getCors

RouteOuterClass.CorsPolicy getCors()

 Indicates that the route has a CORS policy.
 

.envoy.api.v2.route.CorsPolicy cors = 17;

getCorsOrBuilder

RouteOuterClass.CorsPolicyOrBuilder getCorsOrBuilder()

 Indicates that the route has a CORS policy.
 

.envoy.api.v2.route.CorsPolicy cors = 17;

getClusterSpecifierCase

RouteOuterClass.RouteAction.ClusterSpecifierCase getClusterSpecifierCase()

getHostRewriteSpecifierCase

RouteOuterClass.RouteAction.HostRewriteSpecifierCase getHostRewriteSpecifierCase()