io.envoyproxy.envoy.api.v2.RouteConfigurationOrBuilder Maven / Gradle / Ivy
The newest version!
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: envoy/api/v2/route.proto
package io.envoyproxy.envoy.api.v2;
public interface RouteConfigurationOrBuilder extends
// @@protoc_insertion_point(interface_extends:envoy.api.v2.RouteConfiguration)
com.google.protobuf.MessageOrBuilder {
/**
*
* 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;
* @return The name.
*/
java.lang.String 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;
* @return The bytes for name.
*/
com.google.protobuf.ByteString
getNameBytes();
/**
*
* An array of virtual hosts that make up the route table.
*
*
* repeated .envoy.api.v2.route.VirtualHost virtual_hosts = 2;
*/
java.util.List
getVirtualHostsList();
/**
*
* An array of virtual hosts that make up the route table.
*
*
* repeated .envoy.api.v2.route.VirtualHost virtual_hosts = 2;
*/
io.envoyproxy.envoy.api.v2.route.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;
*/
java.util.List
getVirtualHostsOrBuilderList();
/**
*
* An array of virtual hosts that make up the route table.
*
*
* repeated .envoy.api.v2.route.VirtualHost virtual_hosts = 2;
*/
io.envoyproxy.envoy.api.v2.route.VirtualHostOrBuilder getVirtualHostsOrBuilder(
int index);
/**
*
* 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;
* @return Whether the vhds field is set.
*/
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;
* @return The vhds.
*/
io.envoyproxy.envoy.api.v2.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;
*/
io.envoyproxy.envoy.api.v2.VhdsOrBuilder getVhdsOrBuilder();
/**
*
* 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) = { ... }
* @return A list containing the internalOnlyHeaders.
*/
java.util.List
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) = { ... }
* @return The count of internalOnlyHeaders.
*/
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) = { ... }
* @param index The index of the element to return.
* @return The internalOnlyHeaders at the given index.
*/
java.lang.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) = { ... }
* @param index The index of the value to return.
* @return The bytes of the internalOnlyHeaders at the given index.
*/
com.google.protobuf.ByteString
getInternalOnlyHeadersBytes(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) = { ... }
*/
java.util.List
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) = { ... }
*/
io.envoyproxy.envoy.api.v2.core.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) = { ... }
*/
java.util.List
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) = { ... }
*/
io.envoyproxy.envoy.api.v2.core.HeaderValueOptionOrBuilder getResponseHeadersToAddOrBuilder(
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) = { ... }
* @return A list containing the responseHeadersToRemove.
*/
java.util.List
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) = { ... }
* @return The count of responseHeadersToRemove.
*/
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) = { ... }
* @param index The index of the element to return.
* @return The responseHeadersToRemove at the given index.
*/
java.lang.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) = { ... }
* @param index The index of the value to return.
* @return The bytes of the responseHeadersToRemove at the given index.
*/
com.google.protobuf.ByteString
getResponseHeadersToRemoveBytes(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) = { ... }
*/
java.util.List
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) = { ... }
*/
io.envoyproxy.envoy.api.v2.core.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) = { ... }
*/
java.util.List
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) = { ... }
*/
io.envoyproxy.envoy.api.v2.core.HeaderValueOptionOrBuilder getRequestHeadersToAddOrBuilder(
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) = { ... }
* @return A list containing the requestHeadersToRemove.
*/
java.util.List
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) = { ... }
* @return The count of requestHeadersToRemove.
*/
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) = { ... }
* @param index The index of the element to return.
* @return The requestHeadersToRemove at the given index.
*/
java.lang.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) = { ... }
* @param index The index of the value to return.
* @return The bytes of the requestHeadersToRemove at the given index.
*/
com.google.protobuf.ByteString
getRequestHeadersToRemoveBytes(int index);
/**
*
* 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;
* @return The mostSpecificHeaderMutationsWins.
*/
boolean getMostSpecificHeaderMutationsWins();
/**
*
* 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;
* @return Whether the validateClusters field is set.
*/
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;
* @return The validateClusters.
*/
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();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy