Interface RouteConfigurationOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
RouteConfiguration
,RouteConfiguration.Builder
public interface RouteConfigurationOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionboolean
This field can be used to provide RouteConfiguration level per filter config.getClusterSpecifierPlugins
(int index) A list of plugins and their configurations which may be used by a :ref:`cluster specifier plugin name <envoy_v3_api_field_config.route.v3.RouteAction.cluster_specifier_plugin>` within the route.int
A list of plugins and their configurations which may be used by a :ref:`cluster specifier plugin name <envoy_v3_api_field_config.route.v3.RouteAction.cluster_specifier_plugin>` within the route.A list of plugins and their configurations which may be used by a :ref:`cluster specifier plugin name <envoy_v3_api_field_config.route.v3.RouteAction.cluster_specifier_plugin>` within the route.getClusterSpecifierPluginsOrBuilder
(int index) A list of plugins and their configurations which may be used by a :ref:`cluster specifier plugin name <envoy_v3_api_field_config.route.v3.RouteAction.cluster_specifier_plugin>` within the route.List
<? extends ClusterSpecifierPluginOrBuilder> A list of plugins and their configurations which may be used by a :ref:`cluster specifier plugin name <envoy_v3_api_field_config.route.v3.RouteAction.cluster_specifier_plugin>` within the route.boolean
Ignore path-parameters in path-matching.boolean
By default, port in :authority header (if any) is used in host matching.getInternalOnlyHeaders
(int index) Optionally specifies a list of HTTP headers that the connection manager will consider to be internal only.com.google.protobuf.ByteString
getInternalOnlyHeadersBytes
(int index) Optionally specifies a list of HTTP headers that the connection manager will consider to be internal only.int
Optionally specifies a list of HTTP headers that the connection manager will consider to be internal only.Optionally specifies a list of HTTP headers that the connection manager will consider to be internal only.com.google.protobuf.UInt32Value
The maximum bytes of the response :ref:`direct response body <envoy_v3_api_field_config.route.v3.DirectResponseAction.body>` size.com.google.protobuf.UInt32ValueOrBuilder
The maximum bytes of the response :ref:`direct response body <envoy_v3_api_field_config.route.v3.DirectResponseAction.body>` size.The metadata field can be used to provide additional information about the route configuration.The metadata field can be used to provide additional information about the route configuration.boolean
Headers mutations at all levels are evaluated, if specified.getName()
The name of the route configuration.com.google.protobuf.ByteString
The name of the route configuration.getRequestHeadersToAdd
(int index) Specifies a list of HTTP headers that should be added to each request routed by the HTTP connection manager.int
Specifies a list of HTTP headers that should be added to each request routed by the HTTP connection manager.Specifies a list of HTTP headers that should be added to each request routed by the HTTP connection manager.getRequestHeadersToAddOrBuilder
(int index) Specifies a list of HTTP headers that should be added to each request routed by the HTTP connection manager.List
<? extends HeaderValueOptionOrBuilder> Specifies a list of HTTP headers that should be added to each request routed by the HTTP connection manager.getRequestHeadersToRemove
(int index) Specifies a list of HTTP headers that should be removed from each request routed by the HTTP connection manager.com.google.protobuf.ByteString
getRequestHeadersToRemoveBytes
(int index) Specifies a list of HTTP headers that should be removed from each request routed by the HTTP connection manager.int
Specifies a list of HTTP headers that should be removed from each request routed by the HTTP connection manager.Specifies a list of HTTP headers that should be removed from each request routed by the HTTP connection manager.getRequestMirrorPolicies
(int index) Specify a set of default request mirroring policies which apply to all routes under its virtual hosts.int
Specify a set of default request mirroring policies which apply to all routes under its virtual hosts.Specify a set of default request mirroring policies which apply to all routes under its virtual hosts.getRequestMirrorPoliciesOrBuilder
(int index) Specify a set of default request mirroring policies which apply to all routes under its virtual hosts.List
<? extends RouteAction.RequestMirrorPolicyOrBuilder> Specify a set of default request mirroring policies which apply to all routes under its virtual hosts.getResponseHeadersToAdd
(int index) Specifies a list of HTTP headers that should be added to each response that the connection manager encodes.int
Specifies a list of HTTP headers that should be added to each response that the connection manager encodes.Specifies a list of HTTP headers that should be added to each response that the connection manager encodes.getResponseHeadersToAddOrBuilder
(int index) Specifies a list of HTTP headers that should be added to each response that the connection manager encodes.List
<? extends HeaderValueOptionOrBuilder> Specifies a list of HTTP headers that should be added to each response that the connection manager encodes.getResponseHeadersToRemove
(int index) Specifies a list of HTTP headers that should be removed from each response that the connection manager encodes.com.google.protobuf.ByteString
getResponseHeadersToRemoveBytes
(int index) Specifies a list of HTTP headers that should be removed from each response that the connection manager encodes.int
Specifies a list of HTTP headers that should be removed from each response that the connection manager encodes.Specifies a list of HTTP headers that should be removed from each response that the connection manager encodes.Deprecated.int
This field can be used to provide RouteConfiguration level per filter config.This field can be used to provide RouteConfiguration level per filter config.com.google.protobuf.Any
getTypedPerFilterConfigOrDefault
(String key, com.google.protobuf.Any defaultValue) This field can be used to provide RouteConfiguration level per filter config.com.google.protobuf.Any
This field can be used to provide RouteConfiguration level per filter config.com.google.protobuf.BoolValue
An optional boolean that specifies whether the clusters that the route table refers to will be validated by the cluster manager.com.google.protobuf.BoolValueOrBuilder
An optional boolean that specifies whether the clusters that the route table refers to will be validated by the cluster manager.getVhds()
An array of virtual hosts will be dynamically loaded via the VHDS API.An array of virtual hosts will be dynamically loaded via the VHDS API.getVirtualHosts
(int index) An array of virtual hosts that make up the route table.int
An array of virtual hosts that make up the route table.An array of virtual hosts that make up the route table.getVirtualHostsOrBuilder
(int index) An array of virtual hosts that make up the route table.List
<? extends VirtualHostOrBuilder> An array of virtual hosts that make up the route table.boolean
The maximum bytes of the response :ref:`direct response body <envoy_v3_api_field_config.route.v3.DirectResponseAction.body>` size.boolean
The metadata field can be used to provide additional information about the route configuration.boolean
An optional boolean that specifies whether the clusters that the route table refers to will be validated by the cluster manager.boolean
hasVhds()
An array of virtual hosts will be dynamically loaded via the VHDS API.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getName
String getName()The name of the route configuration. For example, it might match :ref:`route_config_name <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.Rds.route_config_name>` in :ref:`envoy_v3_api_msg_extensions.filters.network.http_connection_manager.v3.Rds`.
string name = 1;
- Returns:
- The name.
-
getNameBytes
com.google.protobuf.ByteString getNameBytes()The name of the route configuration. For example, it might match :ref:`route_config_name <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.Rds.route_config_name>` in :ref:`envoy_v3_api_msg_extensions.filters.network.http_connection_manager.v3.Rds`.
string name = 1;
- Returns:
- The bytes for name.
-
getVirtualHostsList
List<VirtualHost> getVirtualHostsList()An array of virtual hosts that make up the route table.
repeated .envoy.config.route.v3.VirtualHost virtual_hosts = 2;
-
getVirtualHosts
An array of virtual hosts that make up the route table.
repeated .envoy.config.route.v3.VirtualHost virtual_hosts = 2;
-
getVirtualHostsCount
int getVirtualHostsCount()An array of virtual hosts that make up the route table.
repeated .envoy.config.route.v3.VirtualHost virtual_hosts = 2;
-
getVirtualHostsOrBuilderList
List<? extends VirtualHostOrBuilder> getVirtualHostsOrBuilderList()An array of virtual hosts that make up the route table.
repeated .envoy.config.route.v3.VirtualHost virtual_hosts = 2;
-
getVirtualHostsOrBuilder
An array of virtual hosts that make up the route table.
repeated .envoy.config.route.v3.VirtualHost virtual_hosts = 2;
-
hasVhds
boolean hasVhds()An array of virtual hosts will be dynamically loaded via the VHDS API. Both ``virtual_hosts`` and ``vhds`` fields will be used when present. ``virtual_hosts`` can be used for a base routing table or for infrequently changing virtual hosts. ``vhds`` is used for on-demand discovery of virtual hosts. The contents of these two fields will be merged to generate a routing table for a given RouteConfiguration, with ``vhds`` derived configuration taking precedence.
.envoy.config.route.v3.Vhds vhds = 9;
- Returns:
- Whether the vhds field is set.
-
getVhds
Vhds getVhds()An array of virtual hosts will be dynamically loaded via the VHDS API. Both ``virtual_hosts`` and ``vhds`` fields will be used when present. ``virtual_hosts`` can be used for a base routing table or for infrequently changing virtual hosts. ``vhds`` is used for on-demand discovery of virtual hosts. The contents of these two fields will be merged to generate a routing table for a given RouteConfiguration, with ``vhds`` derived configuration taking precedence.
.envoy.config.route.v3.Vhds vhds = 9;
- Returns:
- The vhds.
-
getVhdsOrBuilder
VhdsOrBuilder getVhdsOrBuilder()An array of virtual hosts will be dynamically loaded via the VHDS API. Both ``virtual_hosts`` and ``vhds`` fields will be used when present. ``virtual_hosts`` can be used for a base routing table or for infrequently changing virtual hosts. ``vhds`` is used for on-demand discovery of virtual hosts. The contents of these two fields will be merged to generate a routing table for a given RouteConfiguration, with ``vhds`` derived configuration taking precedence.
.envoy.config.route.v3.Vhds vhds = 9;
-
getInternalOnlyHeadersList
Optionally specifies a list of HTTP headers that the connection manager will consider to be internal only. If they are found on external requests they will be cleaned prior to filter invocation. See :ref:`config_http_conn_man_headers_x-envoy-internal` for more information.
repeated string internal_only_headers = 3 [(.validate.rules) = { ... }
- Returns:
- A list containing the internalOnlyHeaders.
-
getInternalOnlyHeadersCount
int getInternalOnlyHeadersCount()Optionally specifies a list of HTTP headers that the connection manager will consider to be internal only. If they are found on external requests they will be cleaned prior to filter invocation. See :ref:`config_http_conn_man_headers_x-envoy-internal` for more information.
repeated string internal_only_headers = 3 [(.validate.rules) = { ... }
- Returns:
- The count of internalOnlyHeaders.
-
getInternalOnlyHeaders
Optionally specifies a list of HTTP headers that the connection manager will consider to be internal only. If they are found on external requests they will be cleaned prior to filter invocation. See :ref:`config_http_conn_man_headers_x-envoy-internal` for more information.
repeated string internal_only_headers = 3 [(.validate.rules) = { ... }
- Parameters:
index
- The index of the element to return.- Returns:
- The internalOnlyHeaders at the given index.
-
getInternalOnlyHeadersBytes
com.google.protobuf.ByteString getInternalOnlyHeadersBytes(int index) Optionally specifies a list of HTTP headers that the connection manager will consider to be internal only. If they are found on external requests they will be cleaned prior to filter invocation. See :ref:`config_http_conn_man_headers_x-envoy-internal` for more information.
repeated string internal_only_headers = 3 [(.validate.rules) = { ... }
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the internalOnlyHeaders at the given index.
-
getResponseHeadersToAddList
List<HeaderValueOption> getResponseHeadersToAddList()Specifies a list of HTTP headers that should be added to each response that the connection manager encodes. Headers specified at this level are applied after headers from any enclosed :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost` or :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`. 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.config.core.v3.HeaderValueOption response_headers_to_add = 4 [(.validate.rules) = { ... }
-
getResponseHeadersToAdd
Specifies a list of HTTP headers that should be added to each response that the connection manager encodes. Headers specified at this level are applied after headers from any enclosed :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost` or :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`. 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.config.core.v3.HeaderValueOption response_headers_to_add = 4 [(.validate.rules) = { ... }
-
getResponseHeadersToAddCount
int getResponseHeadersToAddCount()Specifies a list of HTTP headers that should be added to each response that the connection manager encodes. Headers specified at this level are applied after headers from any enclosed :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost` or :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`. 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.config.core.v3.HeaderValueOption response_headers_to_add = 4 [(.validate.rules) = { ... }
-
getResponseHeadersToAddOrBuilderList
List<? extends HeaderValueOptionOrBuilder> getResponseHeadersToAddOrBuilderList()Specifies a list of HTTP headers that should be added to each response that the connection manager encodes. Headers specified at this level are applied after headers from any enclosed :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost` or :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`. 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.config.core.v3.HeaderValueOption response_headers_to_add = 4 [(.validate.rules) = { ... }
-
getResponseHeadersToAddOrBuilder
Specifies a list of HTTP headers that should be added to each response that the connection manager encodes. Headers specified at this level are applied after headers from any enclosed :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost` or :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`. 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.config.core.v3.HeaderValueOption response_headers_to_add = 4 [(.validate.rules) = { ... }
-
getResponseHeadersToRemoveList
Specifies a list of HTTP headers that should be removed from each response that the connection manager encodes.
repeated string response_headers_to_remove = 5 [(.validate.rules) = { ... }
- Returns:
- A list containing the responseHeadersToRemove.
-
getResponseHeadersToRemoveCount
int getResponseHeadersToRemoveCount()Specifies a list of HTTP headers that should be removed from each response that the connection manager encodes.
repeated string response_headers_to_remove = 5 [(.validate.rules) = { ... }
- Returns:
- The count of responseHeadersToRemove.
-
getResponseHeadersToRemove
Specifies a list of HTTP headers that should be removed from each response that the connection manager encodes.
repeated string response_headers_to_remove = 5 [(.validate.rules) = { ... }
- Parameters:
index
- The index of the element to return.- Returns:
- The responseHeadersToRemove at the given index.
-
getResponseHeadersToRemoveBytes
com.google.protobuf.ByteString getResponseHeadersToRemoveBytes(int index) Specifies a list of HTTP headers that should be removed from each response that the connection manager encodes.
repeated string response_headers_to_remove = 5 [(.validate.rules) = { ... }
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the responseHeadersToRemove at the given index.
-
getRequestHeadersToAddList
List<HeaderValueOption> getRequestHeadersToAddList()Specifies a list of HTTP headers that should be added to each request routed by the HTTP connection manager. Headers specified at this level are applied after headers from any enclosed :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost` or :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`. 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.config.core.v3.HeaderValueOption request_headers_to_add = 6 [(.validate.rules) = { ... }
-
getRequestHeadersToAdd
Specifies a list of HTTP headers that should be added to each request routed by the HTTP connection manager. Headers specified at this level are applied after headers from any enclosed :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost` or :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`. 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.config.core.v3.HeaderValueOption request_headers_to_add = 6 [(.validate.rules) = { ... }
-
getRequestHeadersToAddCount
int getRequestHeadersToAddCount()Specifies a list of HTTP headers that should be added to each request routed by the HTTP connection manager. Headers specified at this level are applied after headers from any enclosed :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost` or :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`. 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.config.core.v3.HeaderValueOption request_headers_to_add = 6 [(.validate.rules) = { ... }
-
getRequestHeadersToAddOrBuilderList
List<? extends HeaderValueOptionOrBuilder> getRequestHeadersToAddOrBuilderList()Specifies a list of HTTP headers that should be added to each request routed by the HTTP connection manager. Headers specified at this level are applied after headers from any enclosed :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost` or :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`. 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.config.core.v3.HeaderValueOption request_headers_to_add = 6 [(.validate.rules) = { ... }
-
getRequestHeadersToAddOrBuilder
Specifies a list of HTTP headers that should be added to each request routed by the HTTP connection manager. Headers specified at this level are applied after headers from any enclosed :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost` or :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`. 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.config.core.v3.HeaderValueOption request_headers_to_add = 6 [(.validate.rules) = { ... }
-
getRequestHeadersToRemoveList
Specifies a list of HTTP headers that should be removed from each request routed by the HTTP connection manager.
repeated string request_headers_to_remove = 8 [(.validate.rules) = { ... }
- Returns:
- A list containing the requestHeadersToRemove.
-
getRequestHeadersToRemoveCount
int getRequestHeadersToRemoveCount()Specifies a list of HTTP headers that should be removed from each request routed by the HTTP connection manager.
repeated string request_headers_to_remove = 8 [(.validate.rules) = { ... }
- Returns:
- The count of requestHeadersToRemove.
-
getRequestHeadersToRemove
Specifies a list of HTTP headers that should be removed from each request routed by the HTTP connection manager.
repeated string request_headers_to_remove = 8 [(.validate.rules) = { ... }
- Parameters:
index
- The index of the element to return.- Returns:
- The requestHeadersToRemove at the given index.
-
getRequestHeadersToRemoveBytes
com.google.protobuf.ByteString getRequestHeadersToRemoveBytes(int index) Specifies a list of HTTP headers that should be removed from each request routed by the HTTP connection manager.
repeated string request_headers_to_remove = 8 [(.validate.rules) = { ... }
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the requestHeadersToRemove at the given index.
-
getMostSpecificHeaderMutationsWins
boolean getMostSpecificHeaderMutationsWins()Headers mutations at all levels are evaluated, if specified. By default, the order is from most specific (i.e. route entry level) to least specific (i.e. route configuration level). Later header mutations may override earlier mutations. This order can be reversed by setting this field to true. In other words, most specific level mutation is evaluated last.
bool most_specific_header_mutations_wins = 10;
- Returns:
- The mostSpecificHeaderMutationsWins.
-
hasValidateClusters
boolean hasValidateClusters()An optional boolean that specifies whether the clusters that the route table refers to will be validated by the cluster manager. If set to true and a route refers to a non-existent cluster, the route table will not load. If set to false and a route refers to a non-existent cluster, the route table will load and the router filter will return a 404 if the route is selected at runtime. This setting defaults to true if the route table is statically defined via the :ref:`route_config <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.route_config>` option. This setting default to false if the route table is loaded dynamically via the :ref:`rds <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.rds>` option. Users may wish to override the default behavior in certain cases (for example when using CDS with a static route table).
.google.protobuf.BoolValue validate_clusters = 7;
- Returns:
- Whether the validateClusters field is set.
-
getValidateClusters
com.google.protobuf.BoolValue getValidateClusters()An optional boolean that specifies whether the clusters that the route table refers to will be validated by the cluster manager. If set to true and a route refers to a non-existent cluster, the route table will not load. If set to false and a route refers to a non-existent cluster, the route table will load and the router filter will return a 404 if the route is selected at runtime. This setting defaults to true if the route table is statically defined via the :ref:`route_config <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.route_config>` option. This setting default to false if the route table is loaded dynamically via the :ref:`rds <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.rds>` option. Users may wish to override the default behavior in certain cases (for example when using CDS with a static route table).
.google.protobuf.BoolValue validate_clusters = 7;
- Returns:
- The validateClusters.
-
getValidateClustersOrBuilder
com.google.protobuf.BoolValueOrBuilder getValidateClustersOrBuilder()An optional boolean that specifies whether the clusters that the route table refers to will be validated by the cluster manager. If set to true and a route refers to a non-existent cluster, the route table will not load. If set to false and a route refers to a non-existent cluster, the route table will load and the router filter will return a 404 if the route is selected at runtime. This setting defaults to true if the route table is statically defined via the :ref:`route_config <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.route_config>` option. This setting default to false if the route table is loaded dynamically via the :ref:`rds <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.rds>` option. Users may wish to override the default behavior in certain cases (for example when using CDS with a static route table).
.google.protobuf.BoolValue validate_clusters = 7;
-
hasMaxDirectResponseBodySizeBytes
boolean hasMaxDirectResponseBodySizeBytes()The maximum bytes of the response :ref:`direct response body <envoy_v3_api_field_config.route.v3.DirectResponseAction.body>` size. If not specified the default is 4096. .. warning:: Envoy currently holds the content of :ref:`direct response body <envoy_v3_api_field_config.route.v3.DirectResponseAction.body>` in memory. Be careful setting this to be larger than the default 4KB, since the allocated memory for direct response body is not subject to data plane buffering controls.
.google.protobuf.UInt32Value max_direct_response_body_size_bytes = 11;
- Returns:
- Whether the maxDirectResponseBodySizeBytes field is set.
-
getMaxDirectResponseBodySizeBytes
com.google.protobuf.UInt32Value getMaxDirectResponseBodySizeBytes()The maximum bytes of the response :ref:`direct response body <envoy_v3_api_field_config.route.v3.DirectResponseAction.body>` size. If not specified the default is 4096. .. warning:: Envoy currently holds the content of :ref:`direct response body <envoy_v3_api_field_config.route.v3.DirectResponseAction.body>` in memory. Be careful setting this to be larger than the default 4KB, since the allocated memory for direct response body is not subject to data plane buffering controls.
.google.protobuf.UInt32Value max_direct_response_body_size_bytes = 11;
- Returns:
- The maxDirectResponseBodySizeBytes.
-
getMaxDirectResponseBodySizeBytesOrBuilder
com.google.protobuf.UInt32ValueOrBuilder getMaxDirectResponseBodySizeBytesOrBuilder()The maximum bytes of the response :ref:`direct response body <envoy_v3_api_field_config.route.v3.DirectResponseAction.body>` size. If not specified the default is 4096. .. warning:: Envoy currently holds the content of :ref:`direct response body <envoy_v3_api_field_config.route.v3.DirectResponseAction.body>` in memory. Be careful setting this to be larger than the default 4KB, since the allocated memory for direct response body is not subject to data plane buffering controls.
.google.protobuf.UInt32Value max_direct_response_body_size_bytes = 11;
-
getClusterSpecifierPluginsList
List<ClusterSpecifierPlugin> getClusterSpecifierPluginsList()A list of plugins and their configurations which may be used by a :ref:`cluster specifier plugin name <envoy_v3_api_field_config.route.v3.RouteAction.cluster_specifier_plugin>` within the route. All ``extension.name`` fields in this list must be unique.
repeated .envoy.config.route.v3.ClusterSpecifierPlugin cluster_specifier_plugins = 12;
-
getClusterSpecifierPlugins
A list of plugins and their configurations which may be used by a :ref:`cluster specifier plugin name <envoy_v3_api_field_config.route.v3.RouteAction.cluster_specifier_plugin>` within the route. All ``extension.name`` fields in this list must be unique.
repeated .envoy.config.route.v3.ClusterSpecifierPlugin cluster_specifier_plugins = 12;
-
getClusterSpecifierPluginsCount
int getClusterSpecifierPluginsCount()A list of plugins and their configurations which may be used by a :ref:`cluster specifier plugin name <envoy_v3_api_field_config.route.v3.RouteAction.cluster_specifier_plugin>` within the route. All ``extension.name`` fields in this list must be unique.
repeated .envoy.config.route.v3.ClusterSpecifierPlugin cluster_specifier_plugins = 12;
-
getClusterSpecifierPluginsOrBuilderList
List<? extends ClusterSpecifierPluginOrBuilder> getClusterSpecifierPluginsOrBuilderList()A list of plugins and their configurations which may be used by a :ref:`cluster specifier plugin name <envoy_v3_api_field_config.route.v3.RouteAction.cluster_specifier_plugin>` within the route. All ``extension.name`` fields in this list must be unique.
repeated .envoy.config.route.v3.ClusterSpecifierPlugin cluster_specifier_plugins = 12;
-
getClusterSpecifierPluginsOrBuilder
A list of plugins and their configurations which may be used by a :ref:`cluster specifier plugin name <envoy_v3_api_field_config.route.v3.RouteAction.cluster_specifier_plugin>` within the route. All ``extension.name`` fields in this list must be unique.
repeated .envoy.config.route.v3.ClusterSpecifierPlugin cluster_specifier_plugins = 12;
-
getRequestMirrorPoliciesList
List<RouteAction.RequestMirrorPolicy> getRequestMirrorPoliciesList()Specify a set of default request mirroring policies which apply to all routes under its virtual hosts. Note that policies are not merged, the most specific non-empty one becomes the mirror policies.
repeated .envoy.config.route.v3.RouteAction.RequestMirrorPolicy request_mirror_policies = 13;
-
getRequestMirrorPolicies
Specify a set of default request mirroring policies which apply to all routes under its virtual hosts. Note that policies are not merged, the most specific non-empty one becomes the mirror policies.
repeated .envoy.config.route.v3.RouteAction.RequestMirrorPolicy request_mirror_policies = 13;
-
getRequestMirrorPoliciesCount
int getRequestMirrorPoliciesCount()Specify a set of default request mirroring policies which apply to all routes under its virtual hosts. Note that policies are not merged, the most specific non-empty one becomes the mirror policies.
repeated .envoy.config.route.v3.RouteAction.RequestMirrorPolicy request_mirror_policies = 13;
-
getRequestMirrorPoliciesOrBuilderList
List<? extends RouteAction.RequestMirrorPolicyOrBuilder> getRequestMirrorPoliciesOrBuilderList()Specify a set of default request mirroring policies which apply to all routes under its virtual hosts. Note that policies are not merged, the most specific non-empty one becomes the mirror policies.
repeated .envoy.config.route.v3.RouteAction.RequestMirrorPolicy request_mirror_policies = 13;
-
getRequestMirrorPoliciesOrBuilder
Specify a set of default request mirroring policies which apply to all routes under its virtual hosts. Note that policies are not merged, the most specific non-empty one becomes the mirror policies.
repeated .envoy.config.route.v3.RouteAction.RequestMirrorPolicy request_mirror_policies = 13;
-
getIgnorePortInHostMatching
boolean getIgnorePortInHostMatching()By default, port in :authority header (if any) is used in host matching. With this option enabled, Envoy will ignore the port number in the :authority header (if any) when picking VirtualHost. NOTE: this option will not strip the port number (if any) contained in route config :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost`.domains field.
bool ignore_port_in_host_matching = 14;
- Returns:
- The ignorePortInHostMatching.
-
getIgnorePathParametersInPathMatching
boolean getIgnorePathParametersInPathMatching()Ignore path-parameters in path-matching. Before RFC3986, URI were like(RFC1808): <scheme>://<net_loc>/<path>;<params>?<query>#<fragment> Envoy by default takes ":path" as "<path>;<params>". For users who want to only match path on the "<path>" portion, this option should be true.
bool ignore_path_parameters_in_path_matching = 15;
- Returns:
- The ignorePathParametersInPathMatching.
-
getTypedPerFilterConfigCount
int getTypedPerFilterConfigCount()This field can be used to provide RouteConfiguration level per filter config. The key should match the :ref:`filter config name <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpFilter.name>`. See :ref:`Http filter route specific config <arch_overview_http_filters_per_filter_config>` for details. [#comment: An entry's value may be wrapped in a :ref:`FilterConfig<envoy_v3_api_msg_config.route.v3.FilterConfig>` message to specify additional options.]
map<string, .google.protobuf.Any> typed_per_filter_config = 16;
-
containsTypedPerFilterConfig
This field can be used to provide RouteConfiguration level per filter config. The key should match the :ref:`filter config name <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpFilter.name>`. See :ref:`Http filter route specific config <arch_overview_http_filters_per_filter_config>` for details. [#comment: An entry's value may be wrapped in a :ref:`FilterConfig<envoy_v3_api_msg_config.route.v3.FilterConfig>` message to specify additional options.]
map<string, .google.protobuf.Any> typed_per_filter_config = 16;
-
getTypedPerFilterConfig
Deprecated.UsegetTypedPerFilterConfigMap()
instead. -
getTypedPerFilterConfigMap
This field can be used to provide RouteConfiguration level per filter config. The key should match the :ref:`filter config name <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpFilter.name>`. See :ref:`Http filter route specific config <arch_overview_http_filters_per_filter_config>` for details. [#comment: An entry's value may be wrapped in a :ref:`FilterConfig<envoy_v3_api_msg_config.route.v3.FilterConfig>` message to specify additional options.]
map<string, .google.protobuf.Any> typed_per_filter_config = 16;
-
getTypedPerFilterConfigOrDefault
com.google.protobuf.Any getTypedPerFilterConfigOrDefault(String key, com.google.protobuf.Any defaultValue) This field can be used to provide RouteConfiguration level per filter config. The key should match the :ref:`filter config name <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpFilter.name>`. See :ref:`Http filter route specific config <arch_overview_http_filters_per_filter_config>` for details. [#comment: An entry's value may be wrapped in a :ref:`FilterConfig<envoy_v3_api_msg_config.route.v3.FilterConfig>` message to specify additional options.]
map<string, .google.protobuf.Any> typed_per_filter_config = 16;
-
getTypedPerFilterConfigOrThrow
This field can be used to provide RouteConfiguration level per filter config. The key should match the :ref:`filter config name <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpFilter.name>`. See :ref:`Http filter route specific config <arch_overview_http_filters_per_filter_config>` for details. [#comment: An entry's value may be wrapped in a :ref:`FilterConfig<envoy_v3_api_msg_config.route.v3.FilterConfig>` message to specify additional options.]
map<string, .google.protobuf.Any> typed_per_filter_config = 16;
-
hasMetadata
boolean hasMetadata()The metadata field can be used to provide additional information about the route configuration. It can be used for configuration, stats, and logging. The metadata should go under the filter namespace that will need it. For instance, if the metadata is intended for the Router filter, the filter name should be specified as ``envoy.filters.http.router``.
.envoy.config.core.v3.Metadata metadata = 17;
- Returns:
- Whether the metadata field is set.
-
getMetadata
Metadata getMetadata()The metadata field can be used to provide additional information about the route configuration. It can be used for configuration, stats, and logging. The metadata should go under the filter namespace that will need it. For instance, if the metadata is intended for the Router filter, the filter name should be specified as ``envoy.filters.http.router``.
.envoy.config.core.v3.Metadata metadata = 17;
- Returns:
- The metadata.
-
getMetadataOrBuilder
MetadataOrBuilder getMetadataOrBuilder()The metadata field can be used to provide additional information about the route configuration. It can be used for configuration, stats, and logging. The metadata should go under the filter namespace that will need it. For instance, if the metadata is intended for the Router filter, the filter name should be specified as ``envoy.filters.http.router``.
.envoy.config.core.v3.Metadata metadata = 17;
-