Interface VirtualHostOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
VirtualHost
,VirtualHost.Builder
public interface VirtualHostOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionboolean
This field can be used to provide virtual host level per filter config.getCors()
Deprecated.envoy.config.route.v3.VirtualHost.cors is deprecated.Deprecated.getDomains
(int index) A list of domains (host/authority header) that will be matched to this virtual host.com.google.protobuf.ByteString
getDomainsBytes
(int index) A list of domains (host/authority header) that will be matched to this virtual host.int
A list of domains (host/authority header) that will be matched to this virtual host.A list of domains (host/authority header) that will be matched to this virtual host.Indicates the hedge policy for all routes in this virtual host.Indicates the hedge policy for all routes in this virtual host.boolean
Decides whether the :ref:`x-envoy-attempt-count <config_http_filters_router_x-envoy-attempt-count>` header should be included in the downstream response.boolean
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.boolean
Decides whether the :ref:`x-envoy-attempt-count <config_http_filters_router_x-envoy-attempt-count>` header should be included in the upstream request.[#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.[#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.The metadata field can be used to provide additional information about the virtual host.The metadata field can be used to provide additional information about the virtual host.getName()
The logical name of the virtual host.com.google.protobuf.ByteString
The logical name of the virtual host.com.google.protobuf.UInt32Value
The maximum bytes which will be buffered for retries and shadowing.com.google.protobuf.UInt32ValueOrBuilder
The maximum bytes which will be buffered for retries and shadowing.getRateLimits
(int index) Specifies a set of rate limit configurations that will be applied to the virtual host.int
Specifies a set of rate limit configurations that will be applied to the virtual host.Specifies a set of rate limit configurations that will be applied to the virtual host.getRateLimitsOrBuilder
(int index) Specifies a set of rate limit configurations that will be applied to the virtual host.List
<? extends RateLimitOrBuilder> Specifies a set of rate limit configurations that will be applied to the virtual host.getRequestHeadersToAdd
(int index) Specifies a list of HTTP headers that should be added to each request handled by this virtual host.int
Specifies a list of HTTP headers that should be added to each request handled by this virtual host.Specifies a list of HTTP headers that should be added to each request handled by this virtual host.getRequestHeadersToAddOrBuilder
(int index) Specifies a list of HTTP headers that should be added to each request handled by this virtual host.List
<? extends HeaderValueOptionOrBuilder> Specifies a list of HTTP headers that should be added to each request handled by this virtual host.getRequestHeadersToRemove
(int index) Specifies a list of HTTP headers that should be removed from each request handled by this virtual host.com.google.protobuf.ByteString
getRequestHeadersToRemoveBytes
(int index) Specifies a list of HTTP headers that should be removed from each request handled by this virtual host.int
Specifies a list of HTTP headers that should be removed from each request handled by this virtual host.Specifies a list of HTTP headers that should be removed from each request handled by this virtual host.getRequestMirrorPolicies
(int index) Specify a set of default request mirroring policies for every route under this virtual host.int
Specify a set of default request mirroring policies for every route under this virtual host.Specify a set of default request mirroring policies for every route under this virtual host.getRequestMirrorPoliciesOrBuilder
(int index) Specify a set of default request mirroring policies for every route under this virtual host.List
<? extends RouteAction.RequestMirrorPolicyOrBuilder> Specify a set of default request mirroring policies for every route under this virtual host.Specifies the type of TLS enforcement the virtual host expects.int
Specifies the type of TLS enforcement the virtual host expects.getResponseHeadersToAdd
(int index) Specifies a list of HTTP headers that should be added to each response handled by this virtual host.int
Specifies a list of HTTP headers that should be added to each response handled by this virtual host.Specifies a list of HTTP headers that should be added to each response handled by this virtual host.getResponseHeadersToAddOrBuilder
(int index) Specifies a list of HTTP headers that should be added to each response handled by this virtual host.List
<? extends HeaderValueOptionOrBuilder> Specifies a list of HTTP headers that should be added to each response handled by this virtual host.getResponseHeadersToRemove
(int index) Specifies a list of HTTP headers that should be removed from each response handled by this virtual host.com.google.protobuf.ByteString
getResponseHeadersToRemoveBytes
(int index) Specifies a list of HTTP headers that should be removed from each response handled by this virtual host.int
Specifies a list of HTTP headers that should be removed from each response handled by this virtual host.Specifies a list of HTTP headers that should be removed from each response handled by this virtual host.Indicates the retry policy for all routes in this virtual host.Indicates the retry policy for all routes in this virtual host.com.google.protobuf.Any
[#not-implemented-hide:] Specifies the configuration for retry policy extension.com.google.protobuf.AnyOrBuilder
[#not-implemented-hide:] Specifies the configuration for retry policy extension.getRoutes
(int index) The list of routes that will be matched, in order, for incoming requests.int
The list of routes that will be matched, in order, for incoming requests.The list of routes that will be matched, in order, for incoming requests.getRoutesOrBuilder
(int index) The list of routes that will be matched, in order, for incoming requests.List
<? extends RouteOrBuilder> The list of routes that will be matched, in order, for incoming requests.Deprecated.int
This field can be used to provide virtual host level per filter config.This field can be used to provide virtual host level per filter config.com.google.protobuf.Any
getTypedPerFilterConfigOrDefault
(String key, com.google.protobuf.Any defaultValue) This field can be used to provide virtual host level per filter config.com.google.protobuf.Any
This field can be used to provide virtual host level per filter config.getVirtualClusters
(int index) A list of virtual clusters defined for this virtual host.int
A list of virtual clusters defined for this virtual host.A list of virtual clusters defined for this virtual host.getVirtualClustersOrBuilder
(int index) A list of virtual clusters defined for this virtual host.List
<? extends VirtualClusterOrBuilder> A list of virtual clusters defined for this virtual host.boolean
hasCors()
Deprecated.envoy.config.route.v3.VirtualHost.cors is deprecated.boolean
Indicates the hedge policy for all routes in this virtual host.boolean
[#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.boolean
The metadata field can be used to provide additional information about the virtual host.boolean
The maximum bytes which will be buffered for retries and shadowing.boolean
Indicates the retry policy for all routes in this virtual host.boolean
[#not-implemented-hide:] Specifies the configuration for retry policy extension.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getName
String getName()The logical name of the virtual host. This is used when emitting certain statistics but is not relevant for routing.
string name = 1 [(.validate.rules) = { ... }
- Returns:
- The name.
-
getNameBytes
com.google.protobuf.ByteString getNameBytes()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) = { ... }
- Returns:
- The bytes for name.
-
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) = { ... }
- Returns:
- A list containing the domains.
-
getDomainsCount
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) = { ... }
- Returns:
- The count of domains.
-
getDomains
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) = { ... }
- Parameters:
index
- The index of the element to return.- Returns:
- The domains at the given index.
-
getDomainsBytes
com.google.protobuf.ByteString getDomainsBytes(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) = { ... }
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the domains at the given index.
-
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;
-
getRoutes
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;
-
getRoutesCount
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;
-
getRoutesOrBuilderList
List<? extends RouteOrBuilder> 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;
-
getRoutesOrBuilder
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;
-
hasMatcher
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) = { ... }
- Returns:
- Whether the matcher field is set.
-
getMatcher
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) = { ... }
- Returns:
- The matcher.
-
getMatcherOrBuilder
MatcherOrBuilder getMatcherOrBuilder()[#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) = { ... }
-
getRequireTlsValue
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) = { ... }
- Returns:
- The enum numeric value on the wire for requireTls.
-
getRequireTls
VirtualHost.TlsRequirementType getRequireTls()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) = { ... }
- Returns:
- The requireTls.
-
getVirtualClustersList
List<VirtualCluster> 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;
-
getVirtualClusters
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;
-
getVirtualClustersCount
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;
-
getVirtualClustersOrBuilderList
List<? extends VirtualClusterOrBuilder> 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;
-
getVirtualClustersOrBuilder
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;
-
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;
-
getRateLimits
Specifies a set of rate limit configurations that will be applied to the virtual host.
repeated .envoy.config.route.v3.RateLimit rate_limits = 6;
-
getRateLimitsCount
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;
-
getRateLimitsOrBuilderList
List<? extends RateLimitOrBuilder> 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;
-
getRateLimitsOrBuilder
Specifies a set of rate limit configurations that will be applied to the virtual host.
repeated .envoy.config.route.v3.RateLimit rate_limits = 6;
-
getRequestHeadersToAddList
List<HeaderValueOption> 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) = { ... }
-
getRequestHeadersToAdd
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) = { ... }
-
getRequestHeadersToAddCount
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) = { ... }
-
getRequestHeadersToAddOrBuilderList
List<? extends HeaderValueOptionOrBuilder> 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) = { ... }
-
getRequestHeadersToAddOrBuilder
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) = { ... }
-
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) = { ... }
- Returns:
- A list containing the requestHeadersToRemove.
-
getRequestHeadersToRemoveCount
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) = { ... }
- Returns:
- The count of requestHeadersToRemove.
-
getRequestHeadersToRemove
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) = { ... }
- Parameters:
index
- The index of the element to return.- Returns:
- The requestHeadersToRemove at the given index.
-
getRequestHeadersToRemoveBytes
com.google.protobuf.ByteString getRequestHeadersToRemoveBytes(int index) Specifies a list of HTTP headers that should be removed from each request handled by this virtual host.
repeated string request_headers_to_remove = 13 [(.validate.rules) = { ... }
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the requestHeadersToRemove at the given index.
-
getResponseHeadersToAddList
List<HeaderValueOption> 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) = { ... }
-
getResponseHeadersToAdd
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) = { ... }
-
getResponseHeadersToAddCount
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) = { ... }
-
getResponseHeadersToAddOrBuilderList
List<? extends HeaderValueOptionOrBuilder> 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) = { ... }
-
getResponseHeadersToAddOrBuilder
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) = { ... }
-
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) = { ... }
- Returns:
- A list containing the responseHeadersToRemove.
-
getResponseHeadersToRemoveCount
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) = { ... }
- Returns:
- The count of responseHeadersToRemove.
-
getResponseHeadersToRemove
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) = { ... }
- Parameters:
index
- The index of the element to return.- Returns:
- The responseHeadersToRemove at the given index.
-
getResponseHeadersToRemoveBytes
com.google.protobuf.ByteString getResponseHeadersToRemoveBytes(int index) Specifies a list of HTTP headers that should be removed from each response handled by this virtual host.
repeated string response_headers_to_remove = 11 [(.validate.rules) = { ... }
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the responseHeadersToRemove at the given index.
-
hasCors
Deprecated.envoy.config.route.v3.VirtualHost.cors is deprecated. See envoy/config/route/v3/route_components.proto;l=153Indicates 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"];
- Returns:
- Whether the cors field is set.
-
getCors
Deprecated.envoy.config.route.v3.VirtualHost.cors is deprecated. See envoy/config/route/v3/route_components.proto;l=153Indicates 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"];
- Returns:
- The cors.
-
getCorsOrBuilder
Deprecated.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"];
-
getTypedPerFilterConfigCount
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;
-
containsTypedPerFilterConfig
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;
-
getTypedPerFilterConfig
Deprecated.UsegetTypedPerFilterConfigMap()
instead. -
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;
-
getTypedPerFilterConfigOrDefault
com.google.protobuf.Any getTypedPerFilterConfigOrDefault(String key, 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;
-
getTypedPerFilterConfigOrThrow
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;
-
getIncludeRequestAttemptCount
boolean getIncludeRequestAttemptCount()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;
- Returns:
- The includeRequestAttemptCount.
-
getIncludeAttemptCountInResponse
boolean getIncludeAttemptCountInResponse()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;
- Returns:
- The includeAttemptCountInResponse.
-
hasRetryPolicy
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;
- Returns:
- Whether the retryPolicy field is set.
-
getRetryPolicy
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;
- Returns:
- The retryPolicy.
-
getRetryPolicyOrBuilder
RetryPolicyOrBuilder getRetryPolicyOrBuilder()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;
-
hasRetryPolicyTypedConfig
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;
- Returns:
- Whether the retryPolicyTypedConfig field is set.
-
getRetryPolicyTypedConfig
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;
- Returns:
- The retryPolicyTypedConfig.
-
getRetryPolicyTypedConfigOrBuilder
com.google.protobuf.AnyOrBuilder getRetryPolicyTypedConfigOrBuilder()[#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;
-
hasHedgePolicy
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;
- Returns:
- Whether the hedgePolicy field is set.
-
getHedgePolicy
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;
- Returns:
- The hedgePolicy.
-
getHedgePolicyOrBuilder
HedgePolicyOrBuilder getHedgePolicyOrBuilder()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;
-
getIncludeIsTimeoutRetryHeader
boolean getIncludeIsTimeoutRetryHeader()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;
- Returns:
- The includeIsTimeoutRetryHeader.
-
hasPerRequestBufferLimitBytes
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;
- Returns:
- Whether the perRequestBufferLimitBytes field is set.
-
getPerRequestBufferLimitBytes
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;
- Returns:
- The perRequestBufferLimitBytes.
-
getPerRequestBufferLimitBytesOrBuilder
com.google.protobuf.UInt32ValueOrBuilder getPerRequestBufferLimitBytesOrBuilder()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;
-
getRequestMirrorPoliciesList
List<RouteAction.RequestMirrorPolicy> 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;
-
getRequestMirrorPolicies
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;
-
getRequestMirrorPoliciesCount
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;
-
getRequestMirrorPoliciesOrBuilderList
List<? extends RouteAction.RequestMirrorPolicyOrBuilder> 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;
-
getRequestMirrorPoliciesOrBuilder
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;
-
hasMetadata
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;
- Returns:
- Whether the metadata field is set.
-
getMetadata
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;
- Returns:
- The metadata.
-
getMetadataOrBuilder
MetadataOrBuilder getMetadataOrBuilder()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;
-