public interface RouteConfigurationOrBuilder
extends com.google.protobuf.MessageOrBuilder
| Modifier and Type | Method and Description |
|---|---|
String |
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 |
getInternalOnlyHeadersCount()
Optionally specifies a list of HTTP headers that the connection manager
will consider to be internal only.
|
List<String> |
getInternalOnlyHeadersList()
Optionally specifies a list of HTTP headers that the connection manager
will consider to be internal only.
|
boolean |
getMostSpecificHeaderMutationsWins()
By default, headers that should be added/removed are evaluated from most to least specific:
* route level
* virtual host level
* connection manager level
To allow setting overrides at the route or virtual host level, this order can be reversed
by setting this option to true.
|
String |
getName()
The name of the route configuration.
|
com.google.protobuf.ByteString |
getNameBytes()
The name of the route configuration.
|
HeaderValueOption |
getRequestHeadersToAdd(int index)
Specifies a list of HTTP headers that should be added to each request
routed by the HTTP connection manager.
|
int |
getRequestHeadersToAddCount()
Specifies a list of HTTP headers that should be added to each request
routed by the HTTP connection manager.
|
List<HeaderValueOption> |
getRequestHeadersToAddList()
Specifies a list of HTTP headers that should be added to each request
routed by the HTTP connection manager.
|
HeaderValueOptionOrBuilder |
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> |
getRequestHeadersToAddOrBuilderList()
Specifies a list of HTTP headers that should be added to each request
routed by the HTTP connection manager.
|
String |
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 |
getRequestHeadersToRemoveCount()
Specifies a list of HTTP headers that should be removed from each request
routed by the HTTP connection manager.
|
List<String> |
getRequestHeadersToRemoveList()
Specifies a list of HTTP headers that should be removed from each request
routed by the HTTP connection manager.
|
HeaderValueOption |
getResponseHeadersToAdd(int index)
Specifies a list of HTTP headers that should be added to each response that
the connection manager encodes.
|
int |
getResponseHeadersToAddCount()
Specifies a list of HTTP headers that should be added to each response that
the connection manager encodes.
|
List<HeaderValueOption> |
getResponseHeadersToAddList()
Specifies a list of HTTP headers that should be added to each response that
the connection manager encodes.
|
HeaderValueOptionOrBuilder |
getResponseHeadersToAddOrBuilder(int index)
Specifies a list of HTTP headers that should be added to each response that
the connection manager encodes.
|
List<? extends HeaderValueOptionOrBuilder> |
getResponseHeadersToAddOrBuilderList()
Specifies a list of HTTP headers that should be added to each response that
the connection manager encodes.
|
String |
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 |
getResponseHeadersToRemoveCount()
Specifies a list of HTTP headers that should be removed from each response
that the connection manager encodes.
|
List<String> |
getResponseHeadersToRemoveList()
Specifies a list of HTTP headers that should be removed from each response
that the connection manager encodes.
|
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.
|
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.
|
Vhds |
getVhds()
An array of virtual hosts will be dynamically loaded via the VHDS API.
|
VhdsOrBuilder |
getVhdsOrBuilder()
An array of virtual hosts will be dynamically loaded via the VHDS API.
|
VirtualHost |
getVirtualHosts(int index)
An array of virtual hosts that make up the route table.
|
int |
getVirtualHostsCount()
An array of virtual hosts that make up the route table.
|
List<VirtualHost> |
getVirtualHostsList()
An array of virtual hosts that make up the route table.
|
VirtualHostOrBuilder |
getVirtualHostsOrBuilder(int index)
An array of virtual hosts that make up the route table.
|
List<? extends VirtualHostOrBuilder> |
getVirtualHostsOrBuilderList()
An array of virtual hosts that make up the route table.
|
boolean |
hasValidateClusters()
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.
|
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofString getName()
The name of the route configuration. For example, it might match :ref:`route_config_name <envoy_api_field_config.filter.network.http_connection_manager.v2.Rds.route_config_name>` in :ref:`envoy_api_msg_config.filter.network.http_connection_manager.v2.Rds`.
string name = 1;com.google.protobuf.ByteString getNameBytes()
The name of the route configuration. For example, it might match :ref:`route_config_name <envoy_api_field_config.filter.network.http_connection_manager.v2.Rds.route_config_name>` in :ref:`envoy_api_msg_config.filter.network.http_connection_manager.v2.Rds`.
string name = 1;List<VirtualHost> getVirtualHostsList()
An array of virtual hosts that make up the route table.
repeated .envoy.api.v2.route.VirtualHost virtual_hosts = 2;VirtualHost getVirtualHosts(int index)
An array of virtual hosts that make up the route table.
repeated .envoy.api.v2.route.VirtualHost virtual_hosts = 2;int getVirtualHostsCount()
An array of virtual hosts that make up the route table.
repeated .envoy.api.v2.route.VirtualHost virtual_hosts = 2;List<? extends VirtualHostOrBuilder> getVirtualHostsOrBuilderList()
An array of virtual hosts that make up the route table.
repeated .envoy.api.v2.route.VirtualHost virtual_hosts = 2;VirtualHostOrBuilder getVirtualHostsOrBuilder(int index)
An array of virtual hosts that make up the route table.
repeated .envoy.api.v2.route.VirtualHost virtual_hosts = 2;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.api.v2.Vhds vhds = 9;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.api.v2.Vhds vhds = 9;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.api.v2.Vhds vhds = 9;List<String> 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) = { ... }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) = { ... }String getInternalOnlyHeaders(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) = { ... }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) = { ... }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_api_msg_route.VirtualHost` or :ref:`envoy_api_msg_route.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.api.v2.core.HeaderValueOption response_headers_to_add = 4 [(.validate.rules) = { ... }HeaderValueOption getResponseHeadersToAdd(int index)
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_api_msg_route.VirtualHost` or :ref:`envoy_api_msg_route.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.api.v2.core.HeaderValueOption response_headers_to_add = 4 [(.validate.rules) = { ... }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_api_msg_route.VirtualHost` or :ref:`envoy_api_msg_route.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.api.v2.core.HeaderValueOption response_headers_to_add = 4 [(.validate.rules) = { ... }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_api_msg_route.VirtualHost` or :ref:`envoy_api_msg_route.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.api.v2.core.HeaderValueOption response_headers_to_add = 4 [(.validate.rules) = { ... }HeaderValueOptionOrBuilder getResponseHeadersToAddOrBuilder(int index)
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_api_msg_route.VirtualHost` or :ref:`envoy_api_msg_route.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.api.v2.core.HeaderValueOption response_headers_to_add = 4 [(.validate.rules) = { ... }List<String> 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) = { ... }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) = { ... }String getResponseHeadersToRemove(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) = { ... }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) = { ... }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_api_msg_route.VirtualHost` or :ref:`envoy_api_msg_route.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.api.v2.core.HeaderValueOption request_headers_to_add = 6 [(.validate.rules) = { ... }HeaderValueOption getRequestHeadersToAdd(int index)
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_api_msg_route.VirtualHost` or :ref:`envoy_api_msg_route.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.api.v2.core.HeaderValueOption request_headers_to_add = 6 [(.validate.rules) = { ... }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_api_msg_route.VirtualHost` or :ref:`envoy_api_msg_route.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.api.v2.core.HeaderValueOption request_headers_to_add = 6 [(.validate.rules) = { ... }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_api_msg_route.VirtualHost` or :ref:`envoy_api_msg_route.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.api.v2.core.HeaderValueOption request_headers_to_add = 6 [(.validate.rules) = { ... }HeaderValueOptionOrBuilder getRequestHeadersToAddOrBuilder(int index)
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_api_msg_route.VirtualHost` or :ref:`envoy_api_msg_route.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.api.v2.core.HeaderValueOption request_headers_to_add = 6 [(.validate.rules) = { ... }List<String> 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) = { ... }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) = { ... }String getRequestHeadersToRemove(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) = { ... }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) = { ... }boolean getMostSpecificHeaderMutationsWins()
By default, headers that should be added/removed are evaluated from most to least specific: * route level * virtual host level * connection manager level To allow setting overrides at the route or virtual host level, this order can be reversed by setting this option to true. Defaults to false. [#next-major-version: In the v3 API, this will default to true.]
bool most_specific_header_mutations_wins = 10;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_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.route_config>` option. This setting default to false if the route table is loaded dynamically via the :ref:`rds <envoy_api_field_config.filter.network.http_connection_manager.v2.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;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_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.route_config>` option. This setting default to false if the route table is loaded dynamically via the :ref:`rds <envoy_api_field_config.filter.network.http_connection_manager.v2.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;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_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.route_config>` option. This setting default to false if the route table is loaded dynamically via the :ref:`rds <envoy_api_field_config.filter.network.http_connection_manager.v2.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;Copyright © 2018–2021 The Envoy Project. All rights reserved.