io.envoyproxy.envoy.config.route.v3.VirtualHostOrBuilder Maven / Gradle / Ivy
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: envoy/config/route/v3/route_components.proto
package io.envoyproxy.envoy.config.route.v3;
public interface VirtualHostOrBuilder extends
// @@protoc_insertion_point(interface_extends:envoy.config.route.v3.VirtualHost)
com.google.protobuf.MessageOrBuilder {
/**
*
* The logical name of the virtual host. This is used when emitting certain
* statistics but is not relevant for routing.
*
*
* string name = 1 [(.validate.rules) = { ... }
* @return The name.
*/
java.lang.String getName();
/**
*
* The logical name of the virtual host. This is used when emitting certain
* statistics but is not relevant for routing.
*
*
* string name = 1 [(.validate.rules) = { ... }
* @return The bytes for name.
*/
com.google.protobuf.ByteString
getNameBytes();
/**
*
* A list of domains (host/authority header) that will be matched to this
* virtual host. Wildcard hosts are supported in the suffix or prefix form.
* Domain search order:
* 1. Exact domain names: ``www.foo.com``.
* 2. Suffix domain wildcards: ``*.foo.com`` or ``*-bar.foo.com``.
* 3. Prefix domain wildcards: ``foo.*`` or ``foo-*``.
* 4. Special wildcard ``*`` matching any domain.
* .. note::
* The wildcard will not match the empty string.
* e.g. ``*-bar.foo.com`` will match ``baz-bar.foo.com`` but not ``-bar.foo.com``.
* The longest wildcards match first.
* Only a single virtual host in the entire route configuration can match on ``*``. A domain
* must be unique across all virtual hosts or the config will fail to load.
* Domains cannot contain control characters. This is validated by the well_known_regex HTTP_HEADER_VALUE.
*
*
* repeated string domains = 2 [(.validate.rules) = { ... }
* @return A list containing the domains.
*/
java.util.List
getDomainsList();
/**
*
* A list of domains (host/authority header) that will be matched to this
* virtual host. Wildcard hosts are supported in the suffix or prefix form.
* Domain search order:
* 1. Exact domain names: ``www.foo.com``.
* 2. Suffix domain wildcards: ``*.foo.com`` or ``*-bar.foo.com``.
* 3. Prefix domain wildcards: ``foo.*`` or ``foo-*``.
* 4. Special wildcard ``*`` matching any domain.
* .. note::
* The wildcard will not match the empty string.
* e.g. ``*-bar.foo.com`` will match ``baz-bar.foo.com`` but not ``-bar.foo.com``.
* The longest wildcards match first.
* Only a single virtual host in the entire route configuration can match on ``*``. A domain
* must be unique across all virtual hosts or the config will fail to load.
* Domains cannot contain control characters. This is validated by the well_known_regex HTTP_HEADER_VALUE.
*
*
* repeated string domains = 2 [(.validate.rules) = { ... }
* @return The count of domains.
*/
int getDomainsCount();
/**
*
* A list of domains (host/authority header) that will be matched to this
* virtual host. Wildcard hosts are supported in the suffix or prefix form.
* Domain search order:
* 1. Exact domain names: ``www.foo.com``.
* 2. Suffix domain wildcards: ``*.foo.com`` or ``*-bar.foo.com``.
* 3. Prefix domain wildcards: ``foo.*`` or ``foo-*``.
* 4. Special wildcard ``*`` matching any domain.
* .. note::
* The wildcard will not match the empty string.
* e.g. ``*-bar.foo.com`` will match ``baz-bar.foo.com`` but not ``-bar.foo.com``.
* The longest wildcards match first.
* Only a single virtual host in the entire route configuration can match on ``*``. A domain
* must be unique across all virtual hosts or the config will fail to load.
* Domains cannot contain control characters. This is validated by the well_known_regex HTTP_HEADER_VALUE.
*
*
* repeated string domains = 2 [(.validate.rules) = { ... }
* @param index The index of the element to return.
* @return The domains at the given index.
*/
java.lang.String getDomains(int index);
/**
*
* A list of domains (host/authority header) that will be matched to this
* virtual host. Wildcard hosts are supported in the suffix or prefix form.
* Domain search order:
* 1. Exact domain names: ``www.foo.com``.
* 2. Suffix domain wildcards: ``*.foo.com`` or ``*-bar.foo.com``.
* 3. Prefix domain wildcards: ``foo.*`` or ``foo-*``.
* 4. Special wildcard ``*`` matching any domain.
* .. note::
* The wildcard will not match the empty string.
* e.g. ``*-bar.foo.com`` will match ``baz-bar.foo.com`` but not ``-bar.foo.com``.
* The longest wildcards match first.
* Only a single virtual host in the entire route configuration can match on ``*``. A domain
* must be unique across all virtual hosts or the config will fail to load.
* Domains cannot contain control characters. This is validated by the well_known_regex HTTP_HEADER_VALUE.
*
*
* repeated string domains = 2 [(.validate.rules) = { ... }
* @param index The index of the value to return.
* @return The bytes of the domains at the given index.
*/
com.google.protobuf.ByteString
getDomainsBytes(int index);
/**
*
* The list of routes that will be matched, in order, for incoming requests.
* The first route that matches will be used.
* Only one of this and ``matcher`` can be specified.
*
*
* repeated .envoy.config.route.v3.Route routes = 3;
*/
java.util.List
getRoutesList();
/**
*
* The list of routes that will be matched, in order, for incoming requests.
* The first route that matches will be used.
* Only one of this and ``matcher`` can be specified.
*
*
* repeated .envoy.config.route.v3.Route routes = 3;
*/
io.envoyproxy.envoy.config.route.v3.Route getRoutes(int index);
/**
*
* The list of routes that will be matched, in order, for incoming requests.
* The first route that matches will be used.
* Only one of this and ``matcher`` can be specified.
*
*
* repeated .envoy.config.route.v3.Route routes = 3;
*/
int getRoutesCount();
/**
*
* The list of routes that will be matched, in order, for incoming requests.
* The first route that matches will be used.
* Only one of this and ``matcher`` can be specified.
*
*
* repeated .envoy.config.route.v3.Route routes = 3;
*/
java.util.List
getRoutesOrBuilderList();
/**
*
* The list of routes that will be matched, in order, for incoming requests.
* The first route that matches will be used.
* Only one of this and ``matcher`` can be specified.
*
*
* repeated .envoy.config.route.v3.Route routes = 3;
*/
io.envoyproxy.envoy.config.route.v3.RouteOrBuilder getRoutesOrBuilder(
int index);
/**
*
* [#next-major-version: This should be included in a oneof with routes wrapped in a message.]
* The match tree to use when resolving route actions for incoming requests. Only one of this and ``routes``
* can be specified.
*
*
* .xds.type.matcher.v3.Matcher matcher = 21 [(.xds.annotations.v3.field_status) = { ... }
* @return Whether the matcher field is set.
*/
boolean hasMatcher();
/**
*
* [#next-major-version: This should be included in a oneof with routes wrapped in a message.]
* The match tree to use when resolving route actions for incoming requests. Only one of this and ``routes``
* can be specified.
*
*
* .xds.type.matcher.v3.Matcher matcher = 21 [(.xds.annotations.v3.field_status) = { ... }
* @return The matcher.
*/
com.github.xds.type.matcher.v3.Matcher getMatcher();
/**
*
* [#next-major-version: This should be included in a oneof with routes wrapped in a message.]
* The match tree to use when resolving route actions for incoming requests. Only one of this and ``routes``
* can be specified.
*
*
* .xds.type.matcher.v3.Matcher matcher = 21 [(.xds.annotations.v3.field_status) = { ... }
*/
com.github.xds.type.matcher.v3.MatcherOrBuilder getMatcherOrBuilder();
/**
*
* Specifies the type of TLS enforcement the virtual host expects. If this option is not
* specified, there is no TLS requirement for the virtual host.
*
*
* .envoy.config.route.v3.VirtualHost.TlsRequirementType require_tls = 4 [(.validate.rules) = { ... }
* @return The enum numeric value on the wire for requireTls.
*/
int getRequireTlsValue();
/**
*
* Specifies the type of TLS enforcement the virtual host expects. If this option is not
* specified, there is no TLS requirement for the virtual host.
*
*
* .envoy.config.route.v3.VirtualHost.TlsRequirementType require_tls = 4 [(.validate.rules) = { ... }
* @return The requireTls.
*/
io.envoyproxy.envoy.config.route.v3.VirtualHost.TlsRequirementType getRequireTls();
/**
*
* A list of virtual clusters defined for this virtual host. Virtual clusters
* are used for additional statistics gathering.
*
*
* repeated .envoy.config.route.v3.VirtualCluster virtual_clusters = 5;
*/
java.util.List
getVirtualClustersList();
/**
*
* A list of virtual clusters defined for this virtual host. Virtual clusters
* are used for additional statistics gathering.
*
*
* repeated .envoy.config.route.v3.VirtualCluster virtual_clusters = 5;
*/
io.envoyproxy.envoy.config.route.v3.VirtualCluster getVirtualClusters(int index);
/**
*
* A list of virtual clusters defined for this virtual host. Virtual clusters
* are used for additional statistics gathering.
*
*
* repeated .envoy.config.route.v3.VirtualCluster virtual_clusters = 5;
*/
int getVirtualClustersCount();
/**
*
* A list of virtual clusters defined for this virtual host. Virtual clusters
* are used for additional statistics gathering.
*
*
* repeated .envoy.config.route.v3.VirtualCluster virtual_clusters = 5;
*/
java.util.List
getVirtualClustersOrBuilderList();
/**
*
* A list of virtual clusters defined for this virtual host. Virtual clusters
* are used for additional statistics gathering.
*
*
* repeated .envoy.config.route.v3.VirtualCluster virtual_clusters = 5;
*/
io.envoyproxy.envoy.config.route.v3.VirtualClusterOrBuilder getVirtualClustersOrBuilder(
int index);
/**
*
* Specifies a set of rate limit configurations that will be applied to the
* virtual host.
*
*
* repeated .envoy.config.route.v3.RateLimit rate_limits = 6;
*/
java.util.List
getRateLimitsList();
/**
*
* Specifies a set of rate limit configurations that will be applied to the
* virtual host.
*
*
* repeated .envoy.config.route.v3.RateLimit rate_limits = 6;
*/
io.envoyproxy.envoy.config.route.v3.RateLimit getRateLimits(int index);
/**
*
* Specifies a set of rate limit configurations that will be applied to the
* virtual host.
*
*
* repeated .envoy.config.route.v3.RateLimit rate_limits = 6;
*/
int getRateLimitsCount();
/**
*
* Specifies a set of rate limit configurations that will be applied to the
* virtual host.
*
*
* repeated .envoy.config.route.v3.RateLimit rate_limits = 6;
*/
java.util.List
getRateLimitsOrBuilderList();
/**
*
* Specifies a set of rate limit configurations that will be applied to the
* virtual host.
*
*
* repeated .envoy.config.route.v3.RateLimit rate_limits = 6;
*/
io.envoyproxy.envoy.config.route.v3.RateLimitOrBuilder getRateLimitsOrBuilder(
int index);
/**
*
* Specifies a list of HTTP headers that should be added to each request
* handled by this virtual host. Headers specified at this level are applied
* after headers from enclosed :ref:`envoy_v3_api_msg_config.route.v3.Route` and before headers from the
* enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. For more information, including
* details on header value syntax, see the documentation on :ref:`custom request headers
* <config_http_conn_man_headers_custom_request_headers>`.
*
*
* repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add = 7 [(.validate.rules) = { ... }
*/
java.util.List
getRequestHeadersToAddList();
/**
*
* Specifies a list of HTTP headers that should be added to each request
* handled by this virtual host. Headers specified at this level are applied
* after headers from enclosed :ref:`envoy_v3_api_msg_config.route.v3.Route` and before headers from the
* enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. For more information, including
* details on header value syntax, see the documentation on :ref:`custom request headers
* <config_http_conn_man_headers_custom_request_headers>`.
*
*
* repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add = 7 [(.validate.rules) = { ... }
*/
io.envoyproxy.envoy.config.core.v3.HeaderValueOption getRequestHeadersToAdd(int index);
/**
*
* Specifies a list of HTTP headers that should be added to each request
* handled by this virtual host. Headers specified at this level are applied
* after headers from enclosed :ref:`envoy_v3_api_msg_config.route.v3.Route` and before headers from the
* enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. For more information, including
* details on header value syntax, see the documentation on :ref:`custom request headers
* <config_http_conn_man_headers_custom_request_headers>`.
*
*
* repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add = 7 [(.validate.rules) = { ... }
*/
int getRequestHeadersToAddCount();
/**
*
* Specifies a list of HTTP headers that should be added to each request
* handled by this virtual host. Headers specified at this level are applied
* after headers from enclosed :ref:`envoy_v3_api_msg_config.route.v3.Route` and before headers from the
* enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. For more information, including
* details on header value syntax, see the documentation on :ref:`custom request headers
* <config_http_conn_man_headers_custom_request_headers>`.
*
*
* repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add = 7 [(.validate.rules) = { ... }
*/
java.util.List
getRequestHeadersToAddOrBuilderList();
/**
*
* Specifies a list of HTTP headers that should be added to each request
* handled by this virtual host. Headers specified at this level are applied
* after headers from enclosed :ref:`envoy_v3_api_msg_config.route.v3.Route` and before headers from the
* enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. For more information, including
* details on header value syntax, see the documentation on :ref:`custom request headers
* <config_http_conn_man_headers_custom_request_headers>`.
*
*
* repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add = 7 [(.validate.rules) = { ... }
*/
io.envoyproxy.envoy.config.core.v3.HeaderValueOptionOrBuilder getRequestHeadersToAddOrBuilder(
int index);
/**
*
* Specifies a list of HTTP headers that should be removed from each request
* handled by this virtual host.
*
*
* repeated string request_headers_to_remove = 13 [(.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
* handled by this virtual host.
*
*
* repeated string request_headers_to_remove = 13 [(.validate.rules) = { ... }
* @return The count of requestHeadersToRemove.
*/
int getRequestHeadersToRemoveCount();
/**
*
* Specifies a list of HTTP headers that should be removed from each request
* handled by this virtual host.
*
*
* repeated string request_headers_to_remove = 13 [(.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
* handled by this virtual host.
*
*
* repeated string request_headers_to_remove = 13 [(.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);
/**
*
* Specifies a list of HTTP headers that should be added to each response
* handled by this virtual host. Headers specified at this level are applied
* after headers from enclosed :ref:`envoy_v3_api_msg_config.route.v3.Route` and before headers from the
* enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. For more information, including
* details on header value syntax, see the documentation on :ref:`custom request headers
* <config_http_conn_man_headers_custom_request_headers>`.
*
*
* repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 10 [(.validate.rules) = { ... }
*/
java.util.List
getResponseHeadersToAddList();
/**
*
* Specifies a list of HTTP headers that should be added to each response
* handled by this virtual host. Headers specified at this level are applied
* after headers from enclosed :ref:`envoy_v3_api_msg_config.route.v3.Route` and before headers from the
* enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. For more information, including
* details on header value syntax, see the documentation on :ref:`custom request headers
* <config_http_conn_man_headers_custom_request_headers>`.
*
*
* repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 10 [(.validate.rules) = { ... }
*/
io.envoyproxy.envoy.config.core.v3.HeaderValueOption getResponseHeadersToAdd(int index);
/**
*
* Specifies a list of HTTP headers that should be added to each response
* handled by this virtual host. Headers specified at this level are applied
* after headers from enclosed :ref:`envoy_v3_api_msg_config.route.v3.Route` and before headers from the
* enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. For more information, including
* details on header value syntax, see the documentation on :ref:`custom request headers
* <config_http_conn_man_headers_custom_request_headers>`.
*
*
* repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 10 [(.validate.rules) = { ... }
*/
int getResponseHeadersToAddCount();
/**
*
* Specifies a list of HTTP headers that should be added to each response
* handled by this virtual host. Headers specified at this level are applied
* after headers from enclosed :ref:`envoy_v3_api_msg_config.route.v3.Route` and before headers from the
* enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. For more information, including
* details on header value syntax, see the documentation on :ref:`custom request headers
* <config_http_conn_man_headers_custom_request_headers>`.
*
*
* repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 10 [(.validate.rules) = { ... }
*/
java.util.List
getResponseHeadersToAddOrBuilderList();
/**
*
* Specifies a list of HTTP headers that should be added to each response
* handled by this virtual host. Headers specified at this level are applied
* after headers from enclosed :ref:`envoy_v3_api_msg_config.route.v3.Route` and before headers from the
* enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. For more information, including
* details on header value syntax, see the documentation on :ref:`custom request headers
* <config_http_conn_man_headers_custom_request_headers>`.
*
*
* repeated .envoy.config.core.v3.HeaderValueOption response_headers_to_add = 10 [(.validate.rules) = { ... }
*/
io.envoyproxy.envoy.config.core.v3.HeaderValueOptionOrBuilder getResponseHeadersToAddOrBuilder(
int index);
/**
*
* Specifies a list of HTTP headers that should be removed from each response
* handled by this virtual host.
*
*
* repeated string response_headers_to_remove = 11 [(.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
* handled by this virtual host.
*
*
* repeated string response_headers_to_remove = 11 [(.validate.rules) = { ... }
* @return The count of responseHeadersToRemove.
*/
int getResponseHeadersToRemoveCount();
/**
*
* Specifies a list of HTTP headers that should be removed from each response
* handled by this virtual host.
*
*
* repeated string response_headers_to_remove = 11 [(.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
* handled by this virtual host.
*
*
* repeated string response_headers_to_remove = 11 [(.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);
/**
*
* Indicates that the virtual host has a CORS policy. This field is ignored if related cors policy is
* found in the
* :ref:`VirtualHost.typed_per_filter_config<envoy_v3_api_field_config.route.v3.VirtualHost.typed_per_filter_config>`.
* .. attention::
* This option has been deprecated. Please use
* :ref:`VirtualHost.typed_per_filter_config<envoy_v3_api_field_config.route.v3.VirtualHost.typed_per_filter_config>`
* to configure the CORS HTTP filter.
*
*
* .envoy.config.route.v3.CorsPolicy cors = 8 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
* @deprecated envoy.config.route.v3.VirtualHost.cors is deprecated.
* See envoy/config/route/v3/route_components.proto;l=153
* @return Whether the cors field is set.
*/
@java.lang.Deprecated boolean hasCors();
/**
*
* Indicates that the virtual host has a CORS policy. This field is ignored if related cors policy is
* found in the
* :ref:`VirtualHost.typed_per_filter_config<envoy_v3_api_field_config.route.v3.VirtualHost.typed_per_filter_config>`.
* .. attention::
* This option has been deprecated. Please use
* :ref:`VirtualHost.typed_per_filter_config<envoy_v3_api_field_config.route.v3.VirtualHost.typed_per_filter_config>`
* to configure the CORS HTTP filter.
*
*
* .envoy.config.route.v3.CorsPolicy cors = 8 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
* @deprecated envoy.config.route.v3.VirtualHost.cors is deprecated.
* See envoy/config/route/v3/route_components.proto;l=153
* @return The cors.
*/
@java.lang.Deprecated io.envoyproxy.envoy.config.route.v3.CorsPolicy getCors();
/**
*
* Indicates that the virtual host has a CORS policy. This field is ignored if related cors policy is
* found in the
* :ref:`VirtualHost.typed_per_filter_config<envoy_v3_api_field_config.route.v3.VirtualHost.typed_per_filter_config>`.
* .. attention::
* This option has been deprecated. Please use
* :ref:`VirtualHost.typed_per_filter_config<envoy_v3_api_field_config.route.v3.VirtualHost.typed_per_filter_config>`
* to configure the CORS HTTP filter.
*
*
* .envoy.config.route.v3.CorsPolicy cors = 8 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
*/
@java.lang.Deprecated io.envoyproxy.envoy.config.route.v3.CorsPolicyOrBuilder getCorsOrBuilder();
/**
*
* This field can be used to provide virtual host 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 = 15;
*/
int getTypedPerFilterConfigCount();
/**
*
* This field can be used to provide virtual host 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 = 15;
*/
boolean containsTypedPerFilterConfig(
java.lang.String key);
/**
* Use {@link #getTypedPerFilterConfigMap()} instead.
*/
@java.lang.Deprecated
java.util.Map
getTypedPerFilterConfig();
/**
*
* This field can be used to provide virtual host 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 = 15;
*/
java.util.Map
getTypedPerFilterConfigMap();
/**
*
* This field can be used to provide virtual host 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 = 15;
*/
/* nullable */
com.google.protobuf.Any getTypedPerFilterConfigOrDefault(
java.lang.String key,
/* nullable */
com.google.protobuf.Any defaultValue);
/**
*
* This field can be used to provide virtual host 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 = 15;
*/
com.google.protobuf.Any getTypedPerFilterConfigOrThrow(
java.lang.String key);
/**
*
* Decides whether the :ref:`x-envoy-attempt-count
* <config_http_filters_router_x-envoy-attempt-count>` header should be included
* in the upstream request. Setting this option will cause it to override any existing header
* value, so in the case of two Envoys on the request path with this option enabled, the upstream
* will see the attempt count as perceived by the second Envoy. Defaults to false.
* This header is unaffected by the
* :ref:`suppress_envoy_headers
* <envoy_v3_api_field_extensions.filters.http.router.v3.Router.suppress_envoy_headers>` flag.
* [#next-major-version: rename to include_attempt_count_in_request.]
*
*
* bool include_request_attempt_count = 14;
* @return The includeRequestAttemptCount.
*/
boolean getIncludeRequestAttemptCount();
/**
*
* Decides whether the :ref:`x-envoy-attempt-count
* <config_http_filters_router_x-envoy-attempt-count>` header should be included
* in the downstream response. Setting this option will cause the router to override any existing header
* value, so in the case of two Envoys on the request path with this option enabled, the downstream
* will see the attempt count as perceived by the Envoy closest upstream from itself. Defaults to false.
* This header is unaffected by the
* :ref:`suppress_envoy_headers
* <envoy_v3_api_field_extensions.filters.http.router.v3.Router.suppress_envoy_headers>` flag.
*
*
* bool include_attempt_count_in_response = 19;
* @return The includeAttemptCountInResponse.
*/
boolean getIncludeAttemptCountInResponse();
/**
*
* Indicates the retry policy for all routes in this virtual host. Note that setting a
* route level entry will take precedence over this config and it'll be treated
* independently (e.g.: values are not inherited).
*
*
* .envoy.config.route.v3.RetryPolicy retry_policy = 16;
* @return Whether the retryPolicy field is set.
*/
boolean hasRetryPolicy();
/**
*
* Indicates the retry policy for all routes in this virtual host. Note that setting a
* route level entry will take precedence over this config and it'll be treated
* independently (e.g.: values are not inherited).
*
*
* .envoy.config.route.v3.RetryPolicy retry_policy = 16;
* @return The retryPolicy.
*/
io.envoyproxy.envoy.config.route.v3.RetryPolicy getRetryPolicy();
/**
*
* Indicates the retry policy for all routes in this virtual host. Note that setting a
* route level entry will take precedence over this config and it'll be treated
* independently (e.g.: values are not inherited).
*
*
* .envoy.config.route.v3.RetryPolicy retry_policy = 16;
*/
io.envoyproxy.envoy.config.route.v3.RetryPolicyOrBuilder getRetryPolicyOrBuilder();
/**
*
* [#not-implemented-hide:]
* Specifies the configuration for retry policy extension. Note that setting a route level entry
* will take precedence over this config and it'll be treated independently (e.g.: values are not
* inherited). :ref:`Retry policy <envoy_v3_api_field_config.route.v3.VirtualHost.retry_policy>` should not be
* set if this field is used.
*
*
* .google.protobuf.Any retry_policy_typed_config = 20;
* @return Whether the retryPolicyTypedConfig field is set.
*/
boolean hasRetryPolicyTypedConfig();
/**
*
* [#not-implemented-hide:]
* Specifies the configuration for retry policy extension. Note that setting a route level entry
* will take precedence over this config and it'll be treated independently (e.g.: values are not
* inherited). :ref:`Retry policy <envoy_v3_api_field_config.route.v3.VirtualHost.retry_policy>` should not be
* set if this field is used.
*
*
* .google.protobuf.Any retry_policy_typed_config = 20;
* @return The retryPolicyTypedConfig.
*/
com.google.protobuf.Any getRetryPolicyTypedConfig();
/**
*
* [#not-implemented-hide:]
* Specifies the configuration for retry policy extension. Note that setting a route level entry
* will take precedence over this config and it'll be treated independently (e.g.: values are not
* inherited). :ref:`Retry policy <envoy_v3_api_field_config.route.v3.VirtualHost.retry_policy>` should not be
* set if this field is used.
*
*
* .google.protobuf.Any retry_policy_typed_config = 20;
*/
com.google.protobuf.AnyOrBuilder getRetryPolicyTypedConfigOrBuilder();
/**
*
* Indicates the hedge policy for all routes in this virtual host. Note that setting a
* route level entry will take precedence over this config and it'll be treated
* independently (e.g.: values are not inherited).
*
*
* .envoy.config.route.v3.HedgePolicy hedge_policy = 17;
* @return Whether the hedgePolicy field is set.
*/
boolean hasHedgePolicy();
/**
*
* Indicates the hedge policy for all routes in this virtual host. Note that setting a
* route level entry will take precedence over this config and it'll be treated
* independently (e.g.: values are not inherited).
*
*
* .envoy.config.route.v3.HedgePolicy hedge_policy = 17;
* @return The hedgePolicy.
*/
io.envoyproxy.envoy.config.route.v3.HedgePolicy getHedgePolicy();
/**
*
* Indicates the hedge policy for all routes in this virtual host. Note that setting a
* route level entry will take precedence over this config and it'll be treated
* independently (e.g.: values are not inherited).
*
*
* .envoy.config.route.v3.HedgePolicy hedge_policy = 17;
*/
io.envoyproxy.envoy.config.route.v3.HedgePolicyOrBuilder getHedgePolicyOrBuilder();
/**
*
* Decides whether to include the :ref:`x-envoy-is-timeout-retry <config_http_filters_router_x-envoy-is-timeout-retry>`
* request header in retries initiated by per try timeouts.
*
*
* bool include_is_timeout_retry_header = 23;
* @return The includeIsTimeoutRetryHeader.
*/
boolean getIncludeIsTimeoutRetryHeader();
/**
*
* The maximum bytes which will be buffered for retries and shadowing.
* If set and a route-specific limit is not set, the bytes actually buffered will be the minimum
* value of this and the listener per_connection_buffer_limit_bytes.
*
*
* .google.protobuf.UInt32Value per_request_buffer_limit_bytes = 18;
* @return Whether the perRequestBufferLimitBytes field is set.
*/
boolean hasPerRequestBufferLimitBytes();
/**
*
* The maximum bytes which will be buffered for retries and shadowing.
* If set and a route-specific limit is not set, the bytes actually buffered will be the minimum
* value of this and the listener per_connection_buffer_limit_bytes.
*
*
* .google.protobuf.UInt32Value per_request_buffer_limit_bytes = 18;
* @return The perRequestBufferLimitBytes.
*/
com.google.protobuf.UInt32Value getPerRequestBufferLimitBytes();
/**
*
* The maximum bytes which will be buffered for retries and shadowing.
* If set and a route-specific limit is not set, the bytes actually buffered will be the minimum
* value of this and the listener per_connection_buffer_limit_bytes.
*
*
* .google.protobuf.UInt32Value per_request_buffer_limit_bytes = 18;
*/
com.google.protobuf.UInt32ValueOrBuilder getPerRequestBufferLimitBytesOrBuilder();
/**
*
* Specify a set of default request mirroring policies for every route under this virtual host.
* It takes precedence over the route config mirror policy entirely.
* That is, policies are not merged, the most specific non-empty one becomes the mirror policies.
*
*
* repeated .envoy.config.route.v3.RouteAction.RequestMirrorPolicy request_mirror_policies = 22;
*/
java.util.List
getRequestMirrorPoliciesList();
/**
*
* Specify a set of default request mirroring policies for every route under this virtual host.
* It takes precedence over the route config mirror policy entirely.
* That is, policies are not merged, the most specific non-empty one becomes the mirror policies.
*
*
* repeated .envoy.config.route.v3.RouteAction.RequestMirrorPolicy request_mirror_policies = 22;
*/
io.envoyproxy.envoy.config.route.v3.RouteAction.RequestMirrorPolicy getRequestMirrorPolicies(int index);
/**
*
* Specify a set of default request mirroring policies for every route under this virtual host.
* It takes precedence over the route config mirror policy entirely.
* That is, policies are not merged, the most specific non-empty one becomes the mirror policies.
*
*
* repeated .envoy.config.route.v3.RouteAction.RequestMirrorPolicy request_mirror_policies = 22;
*/
int getRequestMirrorPoliciesCount();
/**
*
* Specify a set of default request mirroring policies for every route under this virtual host.
* It takes precedence over the route config mirror policy entirely.
* That is, policies are not merged, the most specific non-empty one becomes the mirror policies.
*
*
* repeated .envoy.config.route.v3.RouteAction.RequestMirrorPolicy request_mirror_policies = 22;
*/
java.util.List
getRequestMirrorPoliciesOrBuilderList();
/**
*
* Specify a set of default request mirroring policies for every route under this virtual host.
* It takes precedence over the route config mirror policy entirely.
* That is, policies are not merged, the most specific non-empty one becomes the mirror policies.
*
*
* repeated .envoy.config.route.v3.RouteAction.RequestMirrorPolicy request_mirror_policies = 22;
*/
io.envoyproxy.envoy.config.route.v3.RouteAction.RequestMirrorPolicyOrBuilder getRequestMirrorPoliciesOrBuilder(
int index);
/**
*
* The metadata field can be used to provide additional information
* about the virtual host. 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 = 24;
* @return Whether the metadata field is set.
*/
boolean hasMetadata();
/**
*
* The metadata field can be used to provide additional information
* about the virtual host. 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 = 24;
* @return The metadata.
*/
io.envoyproxy.envoy.config.core.v3.Metadata getMetadata();
/**
*
* The metadata field can be used to provide additional information
* about the virtual host. 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 = 24;
*/
io.envoyproxy.envoy.config.core.v3.MetadataOrBuilder getMetadataOrBuilder();
}