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) = { ... }
*/
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) = { ... }
*/
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.
*
*
* repeated string domains = 2 [(.validate.rules) = { ... }
*/
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.
*
*
* repeated string domains = 2 [(.validate.rules) = { ... }
*/
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.
*
*
* repeated string domains = 2 [(.validate.rules) = { ... }
*/
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.
*
*
* repeated string domains = 2 [(.validate.rules) = { ... }
*/
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.
*
*
* 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.
*
*
* 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.
*
*
* 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.
*
*
* 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.
*
*
* repeated .envoy.config.route.v3.Route routes = 3;
*/
io.envoyproxy.envoy.config.route.v3.RouteOrBuilder getRoutesOrBuilder(
int index);
/**
*
* 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) = { ... }
*/
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) = { ... }
*/
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_api_msg_config.route.v3.Route` and before headers from the
* enclosing :ref:`envoy_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_api_msg_config.route.v3.Route` and before headers from the
* enclosing :ref:`envoy_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_api_msg_config.route.v3.Route` and before headers from the
* enclosing :ref:`envoy_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_api_msg_config.route.v3.Route` and before headers from the
* enclosing :ref:`envoy_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_api_msg_config.route.v3.Route` and before headers from the
* enclosing :ref:`envoy_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;
*/
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;
*/
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;
*/
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;
*/
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_api_msg_config.route.v3.Route` and before headers from the
* enclosing :ref:`envoy_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_api_msg_config.route.v3.Route` and before headers from the
* enclosing :ref:`envoy_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_api_msg_config.route.v3.Route` and before headers from the
* enclosing :ref:`envoy_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_api_msg_config.route.v3.Route` and before headers from the
* enclosing :ref:`envoy_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_api_msg_config.route.v3.Route` and before headers from the
* enclosing :ref:`envoy_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;
*/
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;
*/
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;
*/
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;
*/
com.google.protobuf.ByteString
getResponseHeadersToRemoveBytes(int index);
/**
*
* Indicates that the virtual host has a CORS policy.
*
*
* .envoy.config.route.v3.CorsPolicy cors = 8;
*/
boolean hasCors();
/**
*
* Indicates that the virtual host has a CORS policy.
*
*
* .envoy.config.route.v3.CorsPolicy cors = 8;
*/
io.envoyproxy.envoy.config.route.v3.CorsPolicy getCors();
/**
*
* Indicates that the virtual host has a CORS policy.
*
*
* .envoy.config.route.v3.CorsPolicy cors = 8;
*/
io.envoyproxy.envoy.config.route.v3.CorsPolicyOrBuilder getCorsOrBuilder();
/**
*
* The per_filter_config field can be used to provide virtual host-specific
* configurations for filters. The key should match the filter name, such as
* *envoy.buffer* for the HTTP buffer filter. Use of this field is filter
* specific; see the :ref:`HTTP filter documentation <config_http_filters>`
* for if and how it is utilized.
*
*
* map<string, .google.protobuf.Any> typed_per_filter_config = 15;
*/
int getTypedPerFilterConfigCount();
/**
*
* The per_filter_config field can be used to provide virtual host-specific
* configurations for filters. The key should match the filter name, such as
* *envoy.buffer* for the HTTP buffer filter. Use of this field is filter
* specific; see the :ref:`HTTP filter documentation <config_http_filters>`
* for if and how it is utilized.
*
*
* 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();
/**
*
* The per_filter_config field can be used to provide virtual host-specific
* configurations for filters. The key should match the filter name, such as
* *envoy.buffer* for the HTTP buffer filter. Use of this field is filter
* specific; see the :ref:`HTTP filter documentation <config_http_filters>`
* for if and how it is utilized.
*
*
* map<string, .google.protobuf.Any> typed_per_filter_config = 15;
*/
java.util.Map
getTypedPerFilterConfigMap();
/**
*
* The per_filter_config field can be used to provide virtual host-specific
* configurations for filters. The key should match the filter name, such as
* *envoy.buffer* for the HTTP buffer filter. Use of this field is filter
* specific; see the :ref:`HTTP filter documentation <config_http_filters>`
* for if and how it is utilized.
*
*
* map<string, .google.protobuf.Any> typed_per_filter_config = 15;
*/
com.google.protobuf.Any getTypedPerFilterConfigOrDefault(
java.lang.String key,
com.google.protobuf.Any defaultValue);
/**
*
* The per_filter_config field can be used to provide virtual host-specific
* configurations for filters. The key should match the filter name, such as
* *envoy.buffer* for the HTTP buffer filter. Use of this field is filter
* specific; see the :ref:`HTTP filter documentation <config_http_filters>`
* for if and how it is utilized.
*
*
* 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_api_field_extensions.filters.http.router.v3.Router.suppress_envoy_headers>` flag.
*
*
* bool include_request_attempt_count = 14;
*/
boolean getIncludeRequestAttemptCount();
/**
*
* 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;
*/
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;
*/
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();
/**
*
* 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;
*/
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;
*/
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();
/**
*
* 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;
*/
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;
*/
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();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy