Package io.envoyproxy.envoy.api.v2.route
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
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description booleancontainsPerFilterConfig(String key)Deprecated.booleancontainsTypedPerFilterConfig(String key)The per_filter_config field can be used to provide virtual host-specific configurations for filters.CorsPolicygetCors()Indicates that the virtual host has a CORS policy.CorsPolicyOrBuildergetCorsOrBuilder()Indicates that the virtual host has a CORS policy.StringgetDomains(int index)A list of domains (host/authority header) that will be matched to this virtual host.com.google.protobuf.ByteStringgetDomainsBytes(int index)A list of domains (host/authority header) that will be matched to this virtual host.intgetDomainsCount()A list of domains (host/authority header) that will be matched to this virtual host.List<String>getDomainsList()A list of domains (host/authority header) that will be matched to this virtual host.HedgePolicygetHedgePolicy()Indicates the hedge policy for all routes in this virtual host.HedgePolicyOrBuildergetHedgePolicyOrBuilder()Indicates the hedge policy for all routes in this virtual host.booleangetIncludeAttemptCountInResponse()Decides whether the :ref:`x-envoy-attempt-count <config_http_filters_router_x-envoy-attempt-count>` header should be included in the downstream response.booleangetIncludeRequestAttemptCount()Decides whether the :ref:`x-envoy-attempt-count <config_http_filters_router_x-envoy-attempt-count>` header should be included in the upstream request.StringgetName()The logical name of the virtual host.com.google.protobuf.ByteStringgetNameBytes()The logical name of the virtual host.Map<String,com.google.protobuf.Struct>getPerFilterConfig()Deprecated.intgetPerFilterConfigCount()Deprecated.Map<String,com.google.protobuf.Struct>getPerFilterConfigMap()Deprecated.com.google.protobuf.StructgetPerFilterConfigOrDefault(String key, com.google.protobuf.Struct defaultValue)Deprecated.com.google.protobuf.StructgetPerFilterConfigOrThrow(String key)Deprecated.com.google.protobuf.UInt32ValuegetPerRequestBufferLimitBytes()The maximum bytes which will be buffered for retries and shadowing.com.google.protobuf.UInt32ValueOrBuildergetPerRequestBufferLimitBytesOrBuilder()The maximum bytes which will be buffered for retries and shadowing.RateLimitgetRateLimits(int index)Specifies a set of rate limit configurations that will be applied to the virtual host.intgetRateLimitsCount()Specifies a set of rate limit configurations that will be applied to the virtual host.List<RateLimit>getRateLimitsList()Specifies a set of rate limit configurations that will be applied to the virtual host.RateLimitOrBuildergetRateLimitsOrBuilder(int index)Specifies a set of rate limit configurations that will be applied to the virtual host.List<? extends RateLimitOrBuilder>getRateLimitsOrBuilderList()Specifies a set of rate limit configurations that will be applied to the virtual host.HeaderValueOptiongetRequestHeadersToAdd(int index)Specifies a list of HTTP headers that should be added to each request handled by this virtual host.intgetRequestHeadersToAddCount()Specifies a list of HTTP headers that should be added to each request handled by this virtual host.List<HeaderValueOption>getRequestHeadersToAddList()Specifies a list of HTTP headers that should be added to each request handled by this virtual host.HeaderValueOptionOrBuildergetRequestHeadersToAddOrBuilder(int index)Specifies a list of HTTP headers that should be added to each request handled by this virtual host.List<? extends HeaderValueOptionOrBuilder>getRequestHeadersToAddOrBuilderList()Specifies a list of HTTP headers that should be added to each request handled by this virtual host.StringgetRequestHeadersToRemove(int index)Specifies a list of HTTP headers that should be removed from each request handled by this virtual host.com.google.protobuf.ByteStringgetRequestHeadersToRemoveBytes(int index)Specifies a list of HTTP headers that should be removed from each request handled by this virtual host.intgetRequestHeadersToRemoveCount()Specifies a list of HTTP headers that should be removed from each request handled by this virtual host.List<String>getRequestHeadersToRemoveList()Specifies a list of HTTP headers that should be removed from each request handled by this virtual host.VirtualHost.TlsRequirementTypegetRequireTls()Specifies the type of TLS enforcement the virtual host expects.intgetRequireTlsValue()Specifies the type of TLS enforcement the virtual host expects.HeaderValueOptiongetResponseHeadersToAdd(int index)Specifies a list of HTTP headers that should be added to each response handled by this virtual host.intgetResponseHeadersToAddCount()Specifies a list of HTTP headers that should be added to each response handled by this virtual host.List<HeaderValueOption>getResponseHeadersToAddList()Specifies a list of HTTP headers that should be added to each response handled by this virtual host.HeaderValueOptionOrBuildergetResponseHeadersToAddOrBuilder(int index)Specifies a list of HTTP headers that should be added to each response handled by this virtual host.List<? extends HeaderValueOptionOrBuilder>getResponseHeadersToAddOrBuilderList()Specifies a list of HTTP headers that should be added to each response handled by this virtual host.StringgetResponseHeadersToRemove(int index)Specifies a list of HTTP headers that should be removed from each response handled by this virtual host.com.google.protobuf.ByteStringgetResponseHeadersToRemoveBytes(int index)Specifies a list of HTTP headers that should be removed from each response handled by this virtual host.intgetResponseHeadersToRemoveCount()Specifies a list of HTTP headers that should be removed from each response handled by this virtual host.List<String>getResponseHeadersToRemoveList()Specifies a list of HTTP headers that should be removed from each response handled by this virtual host.RetryPolicygetRetryPolicy()Indicates the retry policy for all routes in this virtual host.RetryPolicyOrBuildergetRetryPolicyOrBuilder()Indicates the retry policy for all routes in this virtual host.com.google.protobuf.AnygetRetryPolicyTypedConfig()[#not-implemented-hide:] Specifies the configuration for retry policy extension.com.google.protobuf.AnyOrBuildergetRetryPolicyTypedConfigOrBuilder()[#not-implemented-hide:] Specifies the configuration for retry policy extension.RoutegetRoutes(int index)The list of routes that will be matched, in order, for incoming requests.intgetRoutesCount()The list of routes that will be matched, in order, for incoming requests.List<Route>getRoutesList()The list of routes that will be matched, in order, for incoming requests.RouteOrBuildergetRoutesOrBuilder(int index)The list of routes that will be matched, in order, for incoming requests.List<? extends RouteOrBuilder>getRoutesOrBuilderList()The list of routes that will be matched, in order, for incoming requests.Map<String,com.google.protobuf.Any>getTypedPerFilterConfig()Deprecated.intgetTypedPerFilterConfigCount()The per_filter_config field can be used to provide virtual host-specific configurations for filters.Map<String,com.google.protobuf.Any>getTypedPerFilterConfigMap()The per_filter_config field can be used to provide virtual host-specific configurations for filters.com.google.protobuf.AnygetTypedPerFilterConfigOrDefault(String key, com.google.protobuf.Any defaultValue)The per_filter_config field can be used to provide virtual host-specific configurations for filters.com.google.protobuf.AnygetTypedPerFilterConfigOrThrow(String key)The per_filter_config field can be used to provide virtual host-specific configurations for filters.VirtualClustergetVirtualClusters(int index)A list of virtual clusters defined for this virtual host.intgetVirtualClustersCount()A list of virtual clusters defined for this virtual host.List<VirtualCluster>getVirtualClustersList()A list of virtual clusters defined for this virtual host.VirtualClusterOrBuildergetVirtualClustersOrBuilder(int index)A list of virtual clusters defined for this virtual host.List<? extends VirtualClusterOrBuilder>getVirtualClustersOrBuilderList()A list of virtual clusters defined for this virtual host.booleanhasCors()Indicates that the virtual host has a CORS policy.booleanhasHedgePolicy()Indicates the hedge policy for all routes in this virtual host.booleanhasPerRequestBufferLimitBytes()The maximum bytes which will be buffered for retries and shadowing.booleanhasRetryPolicy()Indicates the retry policy for all routes in this virtual host.booleanhasRetryPolicyTypedConfig()[#not-implemented-hide:] Specifies the configuration for retry policy extension.-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
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
List<String> 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
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) = { ... }- 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
List<Route> getRoutesList()
The list of routes that will be matched, in order, for incoming requests. The first route that matches will be used.
repeated .envoy.api.v2.route.Route routes = 3;
-
getRoutes
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.api.v2.route.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.
repeated .envoy.api.v2.route.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.
repeated .envoy.api.v2.route.Route routes = 3;
-
getRoutesOrBuilder
RouteOrBuilder getRoutesOrBuilder(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.api.v2.route.Route routes = 3;
-
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.api.v2.route.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.api.v2.route.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.api.v2.route.VirtualCluster virtual_clusters = 5;
-
getVirtualClusters
VirtualCluster getVirtualClusters(int index)
A list of virtual clusters defined for this virtual host. Virtual clusters are used for additional statistics gathering.
repeated .envoy.api.v2.route.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.api.v2.route.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.api.v2.route.VirtualCluster virtual_clusters = 5;
-
getVirtualClustersOrBuilder
VirtualClusterOrBuilder getVirtualClustersOrBuilder(int index)
A list of virtual clusters defined for this virtual host. Virtual clusters are used for additional statistics gathering.
repeated .envoy.api.v2.route.VirtualCluster virtual_clusters = 5;
-
getRateLimitsList
List<RateLimit> getRateLimitsList()
Specifies a set of rate limit configurations that will be applied to the virtual host.
repeated .envoy.api.v2.route.RateLimit rate_limits = 6;
-
getRateLimits
RateLimit getRateLimits(int index)
Specifies a set of rate limit configurations that will be applied to the virtual host.
repeated .envoy.api.v2.route.RateLimit rate_limits = 6;
-
getRateLimitsCount
int getRateLimitsCount()
Specifies a set of rate limit configurations that will be applied to the virtual host.
repeated .envoy.api.v2.route.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.api.v2.route.RateLimit rate_limits = 6;
-
getRateLimitsOrBuilder
RateLimitOrBuilder getRateLimitsOrBuilder(int index)
Specifies a set of rate limit configurations that will be applied to the virtual host.
repeated .envoy.api.v2.route.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_api_msg_route.Route` and before headers from the enclosing :ref:`envoy_api_msg_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.api.v2.core.HeaderValueOption request_headers_to_add = 7 [(.validate.rules) = { ... }
-
getRequestHeadersToAdd
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_route.Route` and before headers from the enclosing :ref:`envoy_api_msg_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.api.v2.core.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_api_msg_route.Route` and before headers from the enclosing :ref:`envoy_api_msg_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.api.v2.core.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_api_msg_route.Route` and before headers from the enclosing :ref:`envoy_api_msg_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.api.v2.core.HeaderValueOption request_headers_to_add = 7 [(.validate.rules) = { ... }
-
getRequestHeadersToAddOrBuilder
HeaderValueOptionOrBuilder getRequestHeadersToAddOrBuilder(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_route.Route` and before headers from the enclosing :ref:`envoy_api_msg_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.api.v2.core.HeaderValueOption request_headers_to_add = 7 [(.validate.rules) = { ... }
-
getRequestHeadersToRemoveList
List<String> 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;- 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;- Returns:
- The count of requestHeadersToRemove.
-
getRequestHeadersToRemove
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;- 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;- 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_api_msg_route.Route` and before headers from the enclosing :ref:`envoy_api_msg_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.api.v2.core.HeaderValueOption response_headers_to_add = 10 [(.validate.rules) = { ... }
-
getResponseHeadersToAdd
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_route.Route` and before headers from the enclosing :ref:`envoy_api_msg_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.api.v2.core.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_api_msg_route.Route` and before headers from the enclosing :ref:`envoy_api_msg_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.api.v2.core.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_api_msg_route.Route` and before headers from the enclosing :ref:`envoy_api_msg_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.api.v2.core.HeaderValueOption response_headers_to_add = 10 [(.validate.rules) = { ... }
-
getResponseHeadersToAddOrBuilder
HeaderValueOptionOrBuilder getResponseHeadersToAddOrBuilder(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_route.Route` and before headers from the enclosing :ref:`envoy_api_msg_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.api.v2.core.HeaderValueOption response_headers_to_add = 10 [(.validate.rules) = { ... }
-
getResponseHeadersToRemoveList
List<String> 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;- 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;- Returns:
- The count of responseHeadersToRemove.
-
getResponseHeadersToRemove
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;- 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;- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the responseHeadersToRemove at the given index.
-
hasCors
boolean hasCors()
Indicates that the virtual host has a CORS policy.
.envoy.api.v2.route.CorsPolicy cors = 8;- Returns:
- Whether the cors field is set.
-
getCors
CorsPolicy getCors()
Indicates that the virtual host has a CORS policy.
.envoy.api.v2.route.CorsPolicy cors = 8;- Returns:
- The cors.
-
getCorsOrBuilder
CorsPolicyOrBuilder getCorsOrBuilder()
Indicates that the virtual host has a CORS policy.
.envoy.api.v2.route.CorsPolicy cors = 8;
-
getPerFilterConfigCount
@Deprecated int getPerFilterConfigCount()
Deprecated.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.filters.http.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.Struct> per_filter_config = 12 [deprecated = true];
-
containsPerFilterConfig
@Deprecated boolean containsPerFilterConfig(String key)
Deprecated.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.filters.http.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.Struct> per_filter_config = 12 [deprecated = true];
-
getPerFilterConfig
@Deprecated Map<String,com.google.protobuf.Struct> getPerFilterConfig()
Deprecated.UsegetPerFilterConfigMap()instead.
-
getPerFilterConfigMap
@Deprecated Map<String,com.google.protobuf.Struct> getPerFilterConfigMap()
Deprecated.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.filters.http.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.Struct> per_filter_config = 12 [deprecated = true];
-
getPerFilterConfigOrDefault
@Deprecated com.google.protobuf.Struct getPerFilterConfigOrDefault(String key, com.google.protobuf.Struct defaultValue)
Deprecated.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.filters.http.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.Struct> per_filter_config = 12 [deprecated = true];
-
getPerFilterConfigOrThrow
@Deprecated com.google.protobuf.Struct getPerFilterConfigOrThrow(String key)
Deprecated.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.filters.http.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.Struct> per_filter_config = 12 [deprecated = true];
-
getTypedPerFilterConfigCount
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.filters.http.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;
-
containsTypedPerFilterConfig
boolean containsTypedPerFilterConfig(String key)
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.filters.http.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;
-
getTypedPerFilterConfig
@Deprecated Map<String,com.google.protobuf.Any> getTypedPerFilterConfig()
Deprecated.UsegetTypedPerFilterConfigMap()instead.
-
getTypedPerFilterConfigMap
Map<String,com.google.protobuf.Any> 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.filters.http.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;
-
getTypedPerFilterConfigOrDefault
com.google.protobuf.Any getTypedPerFilterConfigOrDefault(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.filters.http.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;
-
getTypedPerFilterConfigOrThrow
com.google.protobuf.Any getTypedPerFilterConfigOrThrow(String key)
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.filters.http.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;
-
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_api_field_config.filter.http.router.v2.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_api_field_config.filter.http.router.v2.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.api.v2.route.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.api.v2.route.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.api.v2.route.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_api_field_route.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_api_field_route.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_api_field_route.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.api.v2.route.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.api.v2.route.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.api.v2.route.HedgePolicy hedge_policy = 17;
-
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;
-
-