Class VirtualHost
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.route.v3.VirtualHost
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,VirtualHostOrBuilder
,Serializable
public final class VirtualHost
extends com.google.protobuf.GeneratedMessage
implements VirtualHostOrBuilder
The top level element in the routing configuration is a virtual host. Each virtual host has a logical name as well as a set of domains that get routed to it based on the incoming request's host header. This allows a single listener to service multiple top level domain path trees. Once a virtual host is selected based on the domain, the routes are processed in order to see which upstream cluster to route to or whether to perform a redirect. [#next-free-field: 25]Protobuf type
envoy.config.route.v3.VirtualHost
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
The top level element in the routing configuration is a virtual host.static enum
Protobuf enumenvoy.config.route.v3.VirtualHost.TlsRequirementType
private static final class
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,
BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParent
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
private CorsPolicy
static final int
private static final VirtualHost
private com.google.protobuf.LazyStringArrayList
static final int
static final int
private HedgePolicy
static final int
static final int
static final int
private boolean
private boolean
private boolean
private Matcher
static final int
private byte
private Metadata
static final int
private Object
static final int
private static final com.google.protobuf.Parser
<VirtualHost> static final int
private com.google.protobuf.UInt32Value
static final int
static final int
static final int
static final int
private List
<HeaderValueOption> private com.google.protobuf.LazyStringArrayList
private List
<RouteAction.RequestMirrorPolicy> static final int
private int
static final int
static final int
private List
<HeaderValueOption> private com.google.protobuf.LazyStringArrayList
static final int
static final int
private RetryPolicy
private com.google.protobuf.Any
static final int
private static final long
static final int
private com.google.protobuf.MapField
<String, com.google.protobuf.Any> static final int
private List
<VirtualCluster> Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
private
VirtualHost
(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
This field can be used to provide virtual host level per filter config.boolean
getCors()
Deprecated.envoy.config.route.v3.VirtualHost.cors is deprecated.Deprecated.static VirtualHost
static final com.google.protobuf.Descriptors.Descriptor
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.com.google.protobuf.ProtocolStringList
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.Parser
<VirtualHost> 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.com.google.protobuf.ProtocolStringList
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.com.google.protobuf.ProtocolStringList
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.int
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.int
hashCode()
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.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
protected com.google.protobuf.MapFieldReflectionAccessor
internalGetMapFieldReflection
(int number) private com.google.protobuf.MapField
<String, com.google.protobuf.Any> final boolean
static VirtualHost.Builder
static VirtualHost.Builder
newBuilder
(VirtualHost prototype) protected VirtualHost.Builder
newBuilderForType
(com.google.protobuf.AbstractMessage.BuilderParent parent) static VirtualHost
parseDelimitedFrom
(InputStream input) static VirtualHost
parseDelimitedFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static VirtualHost
parseFrom
(byte[] data) static VirtualHost
parseFrom
(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static VirtualHost
parseFrom
(com.google.protobuf.ByteString data) static VirtualHost
parseFrom
(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static VirtualHost
parseFrom
(com.google.protobuf.CodedInputStream input) static VirtualHost
parseFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static VirtualHost
parseFrom
(InputStream input) static VirtualHost
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static VirtualHost
parseFrom
(ByteBuffer data) static VirtualHost
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser
<VirtualHost> parser()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
bitField0_
private int bitField0_ -
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
name_
-
DOMAINS_FIELD_NUMBER
public static final int DOMAINS_FIELD_NUMBER- See Also:
-
domains_
private com.google.protobuf.LazyStringArrayList domains_ -
ROUTES_FIELD_NUMBER
public static final int ROUTES_FIELD_NUMBER- See Also:
-
routes_
-
MATCHER_FIELD_NUMBER
public static final int MATCHER_FIELD_NUMBER- See Also:
-
matcher_
-
REQUIRE_TLS_FIELD_NUMBER
public static final int REQUIRE_TLS_FIELD_NUMBER- See Also:
-
requireTls_
private int requireTls_ -
VIRTUAL_CLUSTERS_FIELD_NUMBER
public static final int VIRTUAL_CLUSTERS_FIELD_NUMBER- See Also:
-
virtualClusters_
-
RATE_LIMITS_FIELD_NUMBER
public static final int RATE_LIMITS_FIELD_NUMBER- See Also:
-
rateLimits_
-
REQUEST_HEADERS_TO_ADD_FIELD_NUMBER
public static final int REQUEST_HEADERS_TO_ADD_FIELD_NUMBER- See Also:
-
requestHeadersToAdd_
-
REQUEST_HEADERS_TO_REMOVE_FIELD_NUMBER
public static final int REQUEST_HEADERS_TO_REMOVE_FIELD_NUMBER- See Also:
-
requestHeadersToRemove_
private com.google.protobuf.LazyStringArrayList requestHeadersToRemove_ -
RESPONSE_HEADERS_TO_ADD_FIELD_NUMBER
public static final int RESPONSE_HEADERS_TO_ADD_FIELD_NUMBER- See Also:
-
responseHeadersToAdd_
-
RESPONSE_HEADERS_TO_REMOVE_FIELD_NUMBER
public static final int RESPONSE_HEADERS_TO_REMOVE_FIELD_NUMBER- See Also:
-
responseHeadersToRemove_
private com.google.protobuf.LazyStringArrayList responseHeadersToRemove_ -
CORS_FIELD_NUMBER
public static final int CORS_FIELD_NUMBER- See Also:
-
cors_
-
TYPED_PER_FILTER_CONFIG_FIELD_NUMBER
public static final int TYPED_PER_FILTER_CONFIG_FIELD_NUMBER- See Also:
-
typedPerFilterConfig_
-
INCLUDE_REQUEST_ATTEMPT_COUNT_FIELD_NUMBER
public static final int INCLUDE_REQUEST_ATTEMPT_COUNT_FIELD_NUMBER- See Also:
-
includeRequestAttemptCount_
private boolean includeRequestAttemptCount_ -
INCLUDE_ATTEMPT_COUNT_IN_RESPONSE_FIELD_NUMBER
public static final int INCLUDE_ATTEMPT_COUNT_IN_RESPONSE_FIELD_NUMBER- See Also:
-
includeAttemptCountInResponse_
private boolean includeAttemptCountInResponse_ -
RETRY_POLICY_FIELD_NUMBER
public static final int RETRY_POLICY_FIELD_NUMBER- See Also:
-
retryPolicy_
-
RETRY_POLICY_TYPED_CONFIG_FIELD_NUMBER
public static final int RETRY_POLICY_TYPED_CONFIG_FIELD_NUMBER- See Also:
-
retryPolicyTypedConfig_
private com.google.protobuf.Any retryPolicyTypedConfig_ -
HEDGE_POLICY_FIELD_NUMBER
public static final int HEDGE_POLICY_FIELD_NUMBER- See Also:
-
hedgePolicy_
-
INCLUDE_IS_TIMEOUT_RETRY_HEADER_FIELD_NUMBER
public static final int INCLUDE_IS_TIMEOUT_RETRY_HEADER_FIELD_NUMBER- See Also:
-
includeIsTimeoutRetryHeader_
private boolean includeIsTimeoutRetryHeader_ -
PER_REQUEST_BUFFER_LIMIT_BYTES_FIELD_NUMBER
public static final int PER_REQUEST_BUFFER_LIMIT_BYTES_FIELD_NUMBER- See Also:
-
perRequestBufferLimitBytes_
private com.google.protobuf.UInt32Value perRequestBufferLimitBytes_ -
REQUEST_MIRROR_POLICIES_FIELD_NUMBER
public static final int REQUEST_MIRROR_POLICIES_FIELD_NUMBER- See Also:
-
requestMirrorPolicies_
-
METADATA_FIELD_NUMBER
public static final int METADATA_FIELD_NUMBER- See Also:
-
metadata_
-
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
VirtualHost
private VirtualHost(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
VirtualHost
private VirtualHost()
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number) - Overrides:
internalGetMapFieldReflection
in classcom.google.protobuf.GeneratedMessage
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage
-
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) = { ... }
- Specified by:
getName
in interfaceVirtualHostOrBuilder
- Returns:
- The name.
-
getNameBytes
public 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) = { ... }
- Specified by:
getNameBytes
in interfaceVirtualHostOrBuilder
- Returns:
- The bytes for name.
-
getDomainsList
public com.google.protobuf.ProtocolStringList 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) = { ... }
- Specified by:
getDomainsList
in interfaceVirtualHostOrBuilder
- Returns:
- A list containing the domains.
-
getDomainsCount
public 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) = { ... }
- Specified by:
getDomainsCount
in interfaceVirtualHostOrBuilder
- 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) = { ... }
- Specified by:
getDomains
in interfaceVirtualHostOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The domains at the given index.
-
getDomainsBytes
public 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) = { ... }
- Specified by:
getDomainsBytes
in interfaceVirtualHostOrBuilder
- 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;
- Specified by:
getRoutesList
in interfaceVirtualHostOrBuilder
-
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;
- Specified by:
getRoutesOrBuilderList
in interfaceVirtualHostOrBuilder
-
getRoutesCount
public 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;
- Specified by:
getRoutesCount
in interfaceVirtualHostOrBuilder
-
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;
- Specified by:
getRoutes
in interfaceVirtualHostOrBuilder
-
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;
- Specified by:
getRoutesOrBuilder
in interfaceVirtualHostOrBuilder
-
hasMatcher
public 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) = { ... }
- Specified by:
hasMatcher
in interfaceVirtualHostOrBuilder
- Returns:
- Whether the matcher field is set.
-
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) = { ... }
- Specified by:
getMatcher
in interfaceVirtualHostOrBuilder
- Returns:
- The matcher.
-
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) = { ... }
- Specified by:
getMatcherOrBuilder
in interfaceVirtualHostOrBuilder
-
getRequireTlsValue
public 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) = { ... }
- Specified by:
getRequireTlsValue
in interfaceVirtualHostOrBuilder
- Returns:
- The enum numeric value on the wire for requireTls.
-
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) = { ... }
- Specified by:
getRequireTls
in interfaceVirtualHostOrBuilder
- Returns:
- The requireTls.
-
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;
- Specified by:
getVirtualClustersList
in interfaceVirtualHostOrBuilder
-
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;
- Specified by:
getVirtualClustersOrBuilderList
in interfaceVirtualHostOrBuilder
-
getVirtualClustersCount
public 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;
- Specified by:
getVirtualClustersCount
in interfaceVirtualHostOrBuilder
-
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;
- Specified by:
getVirtualClusters
in interfaceVirtualHostOrBuilder
-
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;
- Specified by:
getVirtualClustersOrBuilder
in interfaceVirtualHostOrBuilder
-
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;
- Specified by:
getRateLimitsList
in interfaceVirtualHostOrBuilder
-
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;
- Specified by:
getRateLimitsOrBuilderList
in interfaceVirtualHostOrBuilder
-
getRateLimitsCount
public 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;
- Specified by:
getRateLimitsCount
in interfaceVirtualHostOrBuilder
-
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;
- Specified by:
getRateLimits
in interfaceVirtualHostOrBuilder
-
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;
- Specified by:
getRateLimitsOrBuilder
in interfaceVirtualHostOrBuilder
-
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) = { ... }
- Specified by:
getRequestHeadersToAddList
in interfaceVirtualHostOrBuilder
-
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) = { ... }
- Specified by:
getRequestHeadersToAddOrBuilderList
in interfaceVirtualHostOrBuilder
-
getRequestHeadersToAddCount
public 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) = { ... }
- Specified by:
getRequestHeadersToAddCount
in interfaceVirtualHostOrBuilder
-
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) = { ... }
- Specified by:
getRequestHeadersToAdd
in interfaceVirtualHostOrBuilder
-
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) = { ... }
- Specified by:
getRequestHeadersToAddOrBuilder
in interfaceVirtualHostOrBuilder
-
getRequestHeadersToRemoveList
public com.google.protobuf.ProtocolStringList 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) = { ... }
- Specified by:
getRequestHeadersToRemoveList
in interfaceVirtualHostOrBuilder
- Returns:
- A list containing the requestHeadersToRemove.
-
getRequestHeadersToRemoveCount
public 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) = { ... }
- Specified by:
getRequestHeadersToRemoveCount
in interfaceVirtualHostOrBuilder
- 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) = { ... }
- Specified by:
getRequestHeadersToRemove
in interfaceVirtualHostOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The requestHeadersToRemove at the given index.
-
getRequestHeadersToRemoveBytes
public 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) = { ... }
- Specified by:
getRequestHeadersToRemoveBytes
in interfaceVirtualHostOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the requestHeadersToRemove at the given index.
-
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) = { ... }
- Specified by:
getResponseHeadersToAddList
in interfaceVirtualHostOrBuilder
-
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) = { ... }
- Specified by:
getResponseHeadersToAddOrBuilderList
in interfaceVirtualHostOrBuilder
-
getResponseHeadersToAddCount
public 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) = { ... }
- Specified by:
getResponseHeadersToAddCount
in interfaceVirtualHostOrBuilder
-
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) = { ... }
- Specified by:
getResponseHeadersToAdd
in interfaceVirtualHostOrBuilder
-
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) = { ... }
- Specified by:
getResponseHeadersToAddOrBuilder
in interfaceVirtualHostOrBuilder
-
getResponseHeadersToRemoveList
public com.google.protobuf.ProtocolStringList 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) = { ... }
- Specified by:
getResponseHeadersToRemoveList
in interfaceVirtualHostOrBuilder
- Returns:
- A list containing the responseHeadersToRemove.
-
getResponseHeadersToRemoveCount
public 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) = { ... }
- Specified by:
getResponseHeadersToRemoveCount
in interfaceVirtualHostOrBuilder
- 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) = { ... }
- Specified by:
getResponseHeadersToRemove
in interfaceVirtualHostOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The responseHeadersToRemove at the given index.
-
getResponseHeadersToRemoveBytes
public 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) = { ... }
- Specified by:
getResponseHeadersToRemoveBytes
in interfaceVirtualHostOrBuilder
- 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"];
- Specified by:
hasCors
in interfaceVirtualHostOrBuilder
- 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"];
- Specified by:
getCors
in interfaceVirtualHostOrBuilder
- 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"];
- Specified by:
getCorsOrBuilder
in interfaceVirtualHostOrBuilder
-
internalGetTypedPerFilterConfig
private com.google.protobuf.MapField<String,com.google.protobuf.Any> internalGetTypedPerFilterConfig() -
getTypedPerFilterConfigCount
public int getTypedPerFilterConfigCount()Description copied from interface:VirtualHostOrBuilder
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;
- Specified by:
getTypedPerFilterConfigCount
in interfaceVirtualHostOrBuilder
-
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;
- Specified by:
containsTypedPerFilterConfig
in interfaceVirtualHostOrBuilder
-
getTypedPerFilterConfig
Deprecated.UsegetTypedPerFilterConfigMap()
instead.- Specified by:
getTypedPerFilterConfig
in interfaceVirtualHostOrBuilder
-
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;
- Specified by:
getTypedPerFilterConfigMap
in interfaceVirtualHostOrBuilder
-
getTypedPerFilterConfigOrDefault
public 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;
- Specified by:
getTypedPerFilterConfigOrDefault
in interfaceVirtualHostOrBuilder
-
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;
- Specified by:
getTypedPerFilterConfigOrThrow
in interfaceVirtualHostOrBuilder
-
getIncludeRequestAttemptCount
public 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;
- Specified by:
getIncludeRequestAttemptCount
in interfaceVirtualHostOrBuilder
- Returns:
- The includeRequestAttemptCount.
-
getIncludeAttemptCountInResponse
public 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;
- Specified by:
getIncludeAttemptCountInResponse
in interfaceVirtualHostOrBuilder
- Returns:
- The includeAttemptCountInResponse.
-
hasRetryPolicy
public 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;
- Specified by:
hasRetryPolicy
in interfaceVirtualHostOrBuilder
- Returns:
- Whether the retryPolicy field is set.
-
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;
- Specified by:
getRetryPolicy
in interfaceVirtualHostOrBuilder
- Returns:
- The retryPolicy.
-
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;
- Specified by:
getRetryPolicyOrBuilder
in interfaceVirtualHostOrBuilder
-
hasRetryPolicyTypedConfig
public 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;
- Specified by:
hasRetryPolicyTypedConfig
in interfaceVirtualHostOrBuilder
- Returns:
- Whether the retryPolicyTypedConfig field is set.
-
getRetryPolicyTypedConfig
public 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;
- Specified by:
getRetryPolicyTypedConfig
in interfaceVirtualHostOrBuilder
- Returns:
- The retryPolicyTypedConfig.
-
getRetryPolicyTypedConfigOrBuilder
public 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;
- Specified by:
getRetryPolicyTypedConfigOrBuilder
in interfaceVirtualHostOrBuilder
-
hasHedgePolicy
public 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;
- Specified by:
hasHedgePolicy
in interfaceVirtualHostOrBuilder
- Returns:
- Whether the hedgePolicy field is set.
-
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;
- Specified by:
getHedgePolicy
in interfaceVirtualHostOrBuilder
- Returns:
- The hedgePolicy.
-
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;
- Specified by:
getHedgePolicyOrBuilder
in interfaceVirtualHostOrBuilder
-
getIncludeIsTimeoutRetryHeader
public 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;
- Specified by:
getIncludeIsTimeoutRetryHeader
in interfaceVirtualHostOrBuilder
- Returns:
- The includeIsTimeoutRetryHeader.
-
hasPerRequestBufferLimitBytes
public 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;
- Specified by:
hasPerRequestBufferLimitBytes
in interfaceVirtualHostOrBuilder
- Returns:
- Whether the perRequestBufferLimitBytes field is set.
-
getPerRequestBufferLimitBytes
public 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;
- Specified by:
getPerRequestBufferLimitBytes
in interfaceVirtualHostOrBuilder
- Returns:
- The perRequestBufferLimitBytes.
-
getPerRequestBufferLimitBytesOrBuilder
public 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;
- Specified by:
getPerRequestBufferLimitBytesOrBuilder
in interfaceVirtualHostOrBuilder
-
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;
- Specified by:
getRequestMirrorPoliciesList
in interfaceVirtualHostOrBuilder
-
getRequestMirrorPoliciesOrBuilderList
public 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;
- Specified by:
getRequestMirrorPoliciesOrBuilderList
in interfaceVirtualHostOrBuilder
-
getRequestMirrorPoliciesCount
public 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;
- Specified by:
getRequestMirrorPoliciesCount
in interfaceVirtualHostOrBuilder
-
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;
- Specified by:
getRequestMirrorPolicies
in interfaceVirtualHostOrBuilder
-
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;
- Specified by:
getRequestMirrorPoliciesOrBuilder
in interfaceVirtualHostOrBuilder
-
hasMetadata
public 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;
- Specified by:
hasMetadata
in interfaceVirtualHostOrBuilder
- Returns:
- Whether the metadata field is set.
-
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;
- Specified by:
getMetadata
in interfaceVirtualHostOrBuilder
- Returns:
- The metadata.
-
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;
- Specified by:
getMetadataOrBuilder
in interfaceVirtualHostOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static VirtualHost parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static VirtualHost parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static VirtualHost parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static VirtualHost parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static VirtualHost parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static VirtualHost parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static VirtualHost parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static VirtualHost parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static VirtualHost parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected VirtualHost.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-