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.Duration	getIdleTimeout() Specifies the idle timeout for the route.
com.google.protobuf.DurationOrBuilder	getIdleTimeoutOrBuilder() Specifies the idle timeout for the route.
com.google.protobuf.BoolValue	getIncludeVhRateLimits() 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.
com.google.protobuf.Duration	getMaxGrpcTimeout() 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_api_field_route.RouteAction.timeout>`, but limit the applied timeout to the maximum value specified here.
com.google.protobuf.DurationOrBuilder	getMaxGrpcTimeoutOrBuilder() 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_api_field_route.RouteAction.timeout>`, but limit the applied timeout to the maximum value specified here.
Base.Metadata	getMetadataMatch() Optional endpoint metadata match criteria used by the subset load balancer.
Base.MetadataOrBuilder	getMetadataMatchOrBuilder() Optional endpoint metadata match criteria used by the subset load balancer.
String	getPrefixRewrite() Indicates that during forwarding, the matched prefix (or path) should be swapped with this value.
com.google.protobuf.ByteString	getPrefixRewriteBytes() Indicates that during forwarding, the matched prefix (or path) should be swapped with this value.
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) Deprecated.
int	getRequestHeadersToAddCount() Deprecated.
List<Base.HeaderValueOption>	getRequestHeadersToAddList() Deprecated.
Base.HeaderValueOptionOrBuilder	getRequestHeadersToAddOrBuilder(int index) Deprecated.
List<? extends Base.HeaderValueOptionOrBuilder>	getRequestHeadersToAddOrBuilderList() Deprecated.
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) Deprecated.
int	getResponseHeadersToAddCount() Deprecated.
List<Base.HeaderValueOption>	getResponseHeadersToAddList() Deprecated.
Base.HeaderValueOptionOrBuilder	getResponseHeadersToAddOrBuilder(int index) Deprecated.
List<? extends Base.HeaderValueOptionOrBuilder>	getResponseHeadersToAddOrBuilderList() Deprecated.
String	getResponseHeadersToRemove(int index) Deprecated.
com.google.protobuf.ByteString	getResponseHeadersToRemoveBytes(int index) Deprecated.
int	getResponseHeadersToRemoveCount() Deprecated.
List<String>	getResponseHeadersToRemoveList() Deprecated.
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 upstream timeout for the route.
com.google.protobuf.DurationOrBuilder	getTimeoutOrBuilder() Specifies the upstream timeout for the route.
com.google.protobuf.BoolValue	getUseWebsocket() Deprecated.
com.google.protobuf.BoolValueOrBuilder	getUseWebsocketOrBuilder() Deprecated.
RouteOuterClass.RouteAction.WebSocketProxyConfig	getWebsocketConfig() Deprecated.
RouteOuterClass.RouteAction.WebSocketProxyConfigOrBuilder	getWebsocketConfigOrBuilder() Deprecated.
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	hasIdleTimeout() Specifies the idle timeout for the route.
boolean	hasIncludeVhRateLimits() Specifies if the rate limit filter should include the virtual host rate limits.
boolean	hasMaxGrpcTimeout() 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_api_field_route.RouteAction.timeout>`, but limit the applied timeout to the maximum value specified here.
boolean	hasMetadataMatch() Optional endpoint metadata match criteria used by the subset load balancer.
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 upstream timeout for the route.
boolean	hasUseWebsocket() Deprecated.
boolean	hasWebsocketConfig() Deprecated.
boolean	hasWeightedClusters() Multiple upstream clusters can be specified for a given route.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getCluster

String getCluster()

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

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

getClusterBytes

com.google.protobuf.ByteString getClusterBytes()

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

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

getClusterHeader

String getClusterHeader()

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

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

getClusterHeaderBytes

com.google.protobuf.ByteString getClusterHeaderBytes()

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

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

hasWeightedClusters

boolean hasWeightedClusters()

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

.envoy.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 used by the subset load balancer. Only endpoints
 in the upstream cluster with metadata matching what's set in this field will be considered
 for load balancing. If using :ref:`weighted_clusters
 <envoy_api_field_route.RouteAction.weighted_clusters>`, metadata will be merged, with values
 provided there taking precedence. 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 used by the subset load balancer. Only endpoints
 in the upstream cluster with metadata matching what's set in this field will be considered
 for load balancing. If using :ref:`weighted_clusters
 <envoy_api_field_route.RouteAction.weighted_clusters>`, metadata will be merged, with values
 provided there taking precedence. 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 used by the subset load balancer. Only endpoints
 in the upstream cluster with metadata matching what's set in this field will be considered
 for load balancing. If using :ref:`weighted_clusters
 <envoy_api_field_route.RouteAction.weighted_clusters>`, metadata will be merged, with values
 provided there taking precedence. 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. 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.
 .. attention::
   Pay careful attention to the use of trailing slashes in the
   :ref:`route's match <envoy_api_field_route.Route.match>` prefix value.
   Stripping a prefix from a path requires multiple Routes to handle all cases. For example,
   rewriting */prefix* to */* and */prefix/etc* to */etc* cannot be done in a single
   :ref:`Route <envoy_api_msg_route.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;

getPrefixRewriteBytes

com.google.protobuf.ByteString getPrefixRewriteBytes()

 Indicates that during forwarding, the matched prefix (or path) should be
 swapped with this value. This option allows application URLs to be rooted
 at a different path from those exposed at the reverse proxy layer. The router filter will
 place the original path before rewrite into the :ref:`x-envoy-original-path
 <config_http_filters_router_x-envoy-original-path>` header.
 .. attention::
   Pay careful attention to the use of trailing slashes in the
   :ref:`route's match <envoy_api_field_route.Route.match>` prefix value.
   Stripping a prefix from a path requires multiple Routes to handle all cases. For example,
   rewriting */prefix* to */* and */prefix/etc* to */etc* cannot be done in a single
   :ref:`Route <envoy_api_msg_route.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;

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 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.
 .. 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 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.
 .. 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 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.
 .. 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];

hasIdleTimeout

boolean hasIdleTimeout()

 Specifies the idle timeout for the route. If not specified, there is no per-route idle timeout,
 although the connection manager wide :ref:`stream_idle_timeout
 <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.stream_idle_timeout>`
 will still apply. A value of 0 will completely disable the route's idle timeout, even if a
 connection manager stream idle timeout is configured.
 The idle timeout is distinct to :ref:`timeout
 <envoy_api_field_route.RouteAction.timeout>`, which provides an upper bound
 on the upstream response time; :ref:`idle_timeout
 <envoy_api_field_route.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.
 

.google.protobuf.Duration idle_timeout = 24 [(.gogoproto.stdduration) = true, (.validate.rules) = { ... }

getIdleTimeout

com.google.protobuf.Duration getIdleTimeout()

 Specifies the idle timeout for the route. If not specified, there is no per-route idle timeout,
 although the connection manager wide :ref:`stream_idle_timeout
 <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.stream_idle_timeout>`
 will still apply. A value of 0 will completely disable the route's idle timeout, even if a
 connection manager stream idle timeout is configured.
 The idle timeout is distinct to :ref:`timeout
 <envoy_api_field_route.RouteAction.timeout>`, which provides an upper bound
 on the upstream response time; :ref:`idle_timeout
 <envoy_api_field_route.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.
 

.google.protobuf.Duration idle_timeout = 24 [(.gogoproto.stdduration) = true, (.validate.rules) = { ... }

getIdleTimeoutOrBuilder

com.google.protobuf.DurationOrBuilder getIdleTimeoutOrBuilder()

 Specifies the idle timeout for the route. If not specified, there is no per-route idle timeout,
 although the connection manager wide :ref:`stream_idle_timeout
 <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.stream_idle_timeout>`
 will still apply. A value of 0 will completely disable the route's idle timeout, even if a
 connection manager stream idle timeout is configured.
 The idle timeout is distinct to :ref:`timeout
 <envoy_api_field_route.RouteAction.timeout>`, which provides an upper bound
 on the upstream response time; :ref:`idle_timeout
 <envoy_api_field_route.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.
 

.google.protobuf.Duration idle_timeout = 24 [(.gogoproto.stdduration) = true, (.validate.rules) = { ... }

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

@Deprecated
List<Base.HeaderValueOption> getRequestHeadersToAddList()

Deprecated.

 [#not-implemented-hide:]
 

repeated .envoy.api.v2.core.HeaderValueOption request_headers_to_add = 12 [deprecated = true];

getRequestHeadersToAdd

@Deprecated
Base.HeaderValueOption getRequestHeadersToAdd(int index)

Deprecated.

 [#not-implemented-hide:]
 

repeated .envoy.api.v2.core.HeaderValueOption request_headers_to_add = 12 [deprecated = true];

getRequestHeadersToAddCount

@Deprecated
int getRequestHeadersToAddCount()

Deprecated.

 [#not-implemented-hide:]
 

repeated .envoy.api.v2.core.HeaderValueOption request_headers_to_add = 12 [deprecated = true];

getRequestHeadersToAddOrBuilderList

@Deprecated
List<? extends Base.HeaderValueOptionOrBuilder> getRequestHeadersToAddOrBuilderList()

Deprecated.

 [#not-implemented-hide:]
 

repeated .envoy.api.v2.core.HeaderValueOption request_headers_to_add = 12 [deprecated = true];

getRequestHeadersToAddOrBuilder

@Deprecated
Base.HeaderValueOptionOrBuilder getRequestHeadersToAddOrBuilder(int index)

Deprecated.

 [#not-implemented-hide:]
 

repeated .envoy.api.v2.core.HeaderValueOption request_headers_to_add = 12 [deprecated = true];

getResponseHeadersToAddList

@Deprecated
List<Base.HeaderValueOption> getResponseHeadersToAddList()

Deprecated.

 [#not-implemented-hide:]
 

repeated .envoy.api.v2.core.HeaderValueOption response_headers_to_add = 18 [deprecated = true];

getResponseHeadersToAdd

@Deprecated
Base.HeaderValueOption getResponseHeadersToAdd(int index)

Deprecated.

 [#not-implemented-hide:]
 

repeated .envoy.api.v2.core.HeaderValueOption response_headers_to_add = 18 [deprecated = true];

getResponseHeadersToAddCount

@Deprecated
int getResponseHeadersToAddCount()

Deprecated.

 [#not-implemented-hide:]
 

repeated .envoy.api.v2.core.HeaderValueOption response_headers_to_add = 18 [deprecated = true];

getResponseHeadersToAddOrBuilderList

@Deprecated
List<? extends Base.HeaderValueOptionOrBuilder> getResponseHeadersToAddOrBuilderList()

Deprecated.

 [#not-implemented-hide:]
 

repeated .envoy.api.v2.core.HeaderValueOption response_headers_to_add = 18 [deprecated = true];

getResponseHeadersToAddOrBuilder

@Deprecated
Base.HeaderValueOptionOrBuilder getResponseHeadersToAddOrBuilder(int index)

Deprecated.

 [#not-implemented-hide:]
 

repeated .envoy.api.v2.core.HeaderValueOption response_headers_to_add = 18 [deprecated = true];

getResponseHeadersToRemoveList

@Deprecated
List<String> getResponseHeadersToRemoveList()

Deprecated.

 [#not-implemented-hide:]
 

repeated string response_headers_to_remove = 19 [deprecated = true];

getResponseHeadersToRemoveCount

@Deprecated
int getResponseHeadersToRemoveCount()

Deprecated.

 [#not-implemented-hide:]
 

repeated string response_headers_to_remove = 19 [deprecated = true];

getResponseHeadersToRemove

@Deprecated
String getResponseHeadersToRemove(int index)

Deprecated.

 [#not-implemented-hide:]
 

repeated string response_headers_to_remove = 19 [deprecated = true];

getResponseHeadersToRemoveBytes

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

Deprecated.

 [#not-implemented-hide:]
 

repeated string response_headers_to_remove = 19 [deprecated = true];

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). 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.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). 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.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). 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.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). 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.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). 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.api.v2.route.RouteAction.HashPolicy hash_policy = 15;

hasUseWebsocket

@Deprecated
boolean hasUseWebsocket()

Deprecated.

 Indicates that a HTTP/1.1 client connection to this particular route is allowed to
 upgrade to a WebSocket connection. The default is false.
 .. attention::
   If a connection is upgraded to a WebSocket connection, Envoy will set up 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 are not supported on routes where WebSocket upgrades are allowed.
 

.google.protobuf.BoolValue use_websocket = 16 [deprecated = true];

getUseWebsocket

@Deprecated
com.google.protobuf.BoolValue getUseWebsocket()

Deprecated.

 Indicates that a HTTP/1.1 client connection to this particular route is allowed to
 upgrade to a WebSocket connection. The default is false.
 .. attention::
   If a connection is upgraded to a WebSocket connection, Envoy will set up 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 are not supported on routes where WebSocket upgrades are allowed.
 

.google.protobuf.BoolValue use_websocket = 16 [deprecated = true];

getUseWebsocketOrBuilder

@Deprecated
com.google.protobuf.BoolValueOrBuilder getUseWebsocketOrBuilder()

Deprecated.

 Indicates that a HTTP/1.1 client connection to this particular route is allowed to
 upgrade to a WebSocket connection. The default is false.
 .. attention::
   If a connection is upgraded to a WebSocket connection, Envoy will set up 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 are not supported on routes where WebSocket upgrades are allowed.
 

.google.protobuf.BoolValue use_websocket = 16 [deprecated = true];

hasWebsocketConfig

@Deprecated
boolean hasWebsocketConfig()

Deprecated.

 Proxy configuration used for WebSocket connections. If unset, the default values as specified
 in :ref:`TcpProxy <envoy_api_msg_config.filter.network.tcp_proxy.v2.TcpProxy>` are used.
 

.envoy.api.v2.route.RouteAction.WebSocketProxyConfig websocket_config = 22 [deprecated = true];

getWebsocketConfig

@Deprecated
RouteOuterClass.RouteAction.WebSocketProxyConfig getWebsocketConfig()

Deprecated.

 Proxy configuration used for WebSocket connections. If unset, the default values as specified
 in :ref:`TcpProxy <envoy_api_msg_config.filter.network.tcp_proxy.v2.TcpProxy>` are used.
 

.envoy.api.v2.route.RouteAction.WebSocketProxyConfig websocket_config = 22 [deprecated = true];

getWebsocketConfigOrBuilder

@Deprecated
RouteOuterClass.RouteAction.WebSocketProxyConfigOrBuilder getWebsocketConfigOrBuilder()

Deprecated.

 Proxy configuration used for WebSocket connections. If unset, the default values as specified
 in :ref:`TcpProxy <envoy_api_msg_config.filter.network.tcp_proxy.v2.TcpProxy>` are used.
 

.envoy.api.v2.route.RouteAction.WebSocketProxyConfig websocket_config = 22 [deprecated = true];

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;

hasMaxGrpcTimeout

boolean hasMaxGrpcTimeout()

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

.google.protobuf.Duration max_grpc_timeout = 23 [(.gogoproto.stdduration) = true];

getMaxGrpcTimeout

com.google.protobuf.Duration getMaxGrpcTimeout()

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

.google.protobuf.Duration max_grpc_timeout = 23 [(.gogoproto.stdduration) = true];

getMaxGrpcTimeoutOrBuilder

com.google.protobuf.DurationOrBuilder getMaxGrpcTimeoutOrBuilder()

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

.google.protobuf.Duration max_grpc_timeout = 23 [(.gogoproto.stdduration) = true];

getClusterSpecifierCase

RouteOuterClass.RouteAction.ClusterSpecifierCase getClusterSpecifierCase()

getHostRewriteSpecifierCase

RouteOuterClass.RouteAction.HostRewriteSpecifierCase getHostRewriteSpecifierCase()