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 classThe top level element in the routing configuration is a virtual host.static enumProtobuf enumenvoy.config.route.v3.VirtualHost.TlsRequirementTypeprivate static final classNested 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.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate intprivate CorsPolicystatic final intprivate static final VirtualHostprivate com.google.protobuf.LazyStringArrayListstatic final intstatic final intprivate HedgePolicystatic final intstatic final intstatic final intprivate booleanprivate booleanprivate booleanprivate Matcherstatic final intprivate byteprivate Metadatastatic final intprivate Objectstatic final intprivate static final com.google.protobuf.Parser<VirtualHost> static final intprivate com.google.protobuf.UInt32Valuestatic final intstatic final intstatic final intstatic final intprivate List<HeaderValueOption> private com.google.protobuf.LazyStringArrayListprivate List<RouteAction.RequestMirrorPolicy> static final intprivate intstatic final intstatic final intprivate List<HeaderValueOption> private com.google.protobuf.LazyStringArrayListstatic final intstatic final intprivate RetryPolicyprivate com.google.protobuf.Anystatic final intprivate static final longstatic final intprivate com.google.protobuf.MapField<String, com.google.protobuf.Any> static final intprivate List<VirtualCluster> Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivateprivateVirtualHost(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionbooleanThis field can be used to provide virtual host level per filter config.booleangetCors()Deprecated.envoy.config.route.v3.VirtualHost.cors is deprecated.Deprecated.static VirtualHoststatic final com.google.protobuf.Descriptors.DescriptorgetDomains(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.intA list of domains (host/authority header) that will be matched to this virtual host.com.google.protobuf.ProtocolStringListA 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.booleanDecides whether the :ref:`x-envoy-attempt-count <config_http_filters_router_x-envoy-attempt-count>` header should be included in the downstream response.booleanDecides 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.booleanDecides 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.ByteStringThe logical name of the virtual host.com.google.protobuf.Parser<VirtualHost> com.google.protobuf.UInt32ValueThe maximum bytes which will be buffered for retries and shadowing.com.google.protobuf.UInt32ValueOrBuilderThe 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.intSpecifies 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.intSpecifies 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.ByteStringgetRequestHeadersToRemoveBytes(int index) Specifies a list of HTTP headers that should be removed from each request handled by this virtual host.intSpecifies a list of HTTP headers that should be removed from each request handled by this virtual host.com.google.protobuf.ProtocolStringListSpecifies 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.intSpecify 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.intSpecifies 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.intSpecifies 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.ByteStringgetResponseHeadersToRemoveBytes(int index) Specifies a list of HTTP headers that should be removed from each response handled by this virtual host.intSpecifies a list of HTTP headers that should be removed from each response handled by this virtual host.com.google.protobuf.ProtocolStringListSpecifies 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.intThe 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.intDeprecated.intThis 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.AnygetTypedPerFilterConfigOrDefault(String key, com.google.protobuf.Any defaultValue) This field can be used to provide virtual host level per filter config.com.google.protobuf.AnyThis 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.intA 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.booleanhasCors()Deprecated.envoy.config.route.v3.VirtualHost.cors is deprecated.inthashCode()booleanIndicates 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.booleanThe metadata field can be used to provide additional information about the virtual host.booleanThe maximum bytes which will be buffered for retries and shadowing.booleanIndicates 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.FieldAccessorTableprotected com.google.protobuf.MapFieldReflectionAccessorinternalGetMapFieldReflection(int number) private com.google.protobuf.MapField<String, com.google.protobuf.Any> final booleanstatic VirtualHost.Builderstatic VirtualHost.BuildernewBuilder(VirtualHost prototype) protected VirtualHost.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static VirtualHostparseDelimitedFrom(InputStream input) static VirtualHostparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static VirtualHostparseFrom(byte[] data) static VirtualHostparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static VirtualHostparseFrom(com.google.protobuf.ByteString data) static VirtualHostparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static VirtualHostparseFrom(com.google.protobuf.CodedInputStream input) static VirtualHostparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static VirtualHostparseFrom(InputStream input) static VirtualHostparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static VirtualHostparseFrom(ByteBuffer data) static VirtualHostparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<VirtualHost> parser()voidwriteTo(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, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods 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:
internalGetMapFieldReflectionin classcom.google.protobuf.GeneratedMessage
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein 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:
getNamein 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:
getNameBytesin 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:
getDomainsListin 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:
getDomainsCountin 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:
getDomainsin 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:
getDomainsBytesin 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:
getRoutesListin 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:
getRoutesOrBuilderListin 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:
getRoutesCountin 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:
getRoutesin 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:
getRoutesOrBuilderin 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:
hasMatcherin 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:
getMatcherin 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:
getMatcherOrBuilderin 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:
getRequireTlsValuein 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:
getRequireTlsin 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:
getVirtualClustersListin 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:
getVirtualClustersOrBuilderListin 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:
getVirtualClustersCountin 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:
getVirtualClustersin 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:
getVirtualClustersOrBuilderin 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:
getRateLimitsListin 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:
getRateLimitsOrBuilderListin 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:
getRateLimitsCountin 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:
getRateLimitsin 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:
getRateLimitsOrBuilderin 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:
getRequestHeadersToAddListin 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:
getRequestHeadersToAddOrBuilderListin 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:
getRequestHeadersToAddCountin 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:
getRequestHeadersToAddin 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:
getRequestHeadersToAddOrBuilderin 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:
getRequestHeadersToRemoveListin 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:
getRequestHeadersToRemoveCountin 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:
getRequestHeadersToRemovein 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:
getRequestHeadersToRemoveBytesin 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:
getResponseHeadersToAddListin 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:
getResponseHeadersToAddOrBuilderListin 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:
getResponseHeadersToAddCountin 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:
getResponseHeadersToAddin 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:
getResponseHeadersToAddOrBuilderin 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:
getResponseHeadersToRemoveListin 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:
getResponseHeadersToRemoveCountin 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:
getResponseHeadersToRemovein 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:
getResponseHeadersToRemoveBytesin 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:
hasCorsin 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:
getCorsin 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:
getCorsOrBuilderin interfaceVirtualHostOrBuilder
-
internalGetTypedPerFilterConfig
private com.google.protobuf.MapField<String,com.google.protobuf.Any> internalGetTypedPerFilterConfig() -
getTypedPerFilterConfigCount
public int getTypedPerFilterConfigCount()Description copied from interface:VirtualHostOrBuilderThis 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:
getTypedPerFilterConfigCountin 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:
containsTypedPerFilterConfigin interfaceVirtualHostOrBuilder
-
getTypedPerFilterConfig
Deprecated.UsegetTypedPerFilterConfigMap()instead.- Specified by:
getTypedPerFilterConfigin 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:
getTypedPerFilterConfigMapin 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:
getTypedPerFilterConfigOrDefaultin 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:
getTypedPerFilterConfigOrThrowin 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:
getIncludeRequestAttemptCountin 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:
getIncludeAttemptCountInResponsein 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:
hasRetryPolicyin 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:
getRetryPolicyin 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:
getRetryPolicyOrBuilderin 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:
hasRetryPolicyTypedConfigin 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:
getRetryPolicyTypedConfigin 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:
getRetryPolicyTypedConfigOrBuilderin 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:
hasHedgePolicyin 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:
getHedgePolicyin 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:
getHedgePolicyOrBuilderin 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:
getIncludeIsTimeoutRetryHeaderin 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:
hasPerRequestBufferLimitBytesin 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:
getPerRequestBufferLimitBytesin 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:
getPerRequestBufferLimitBytesOrBuilderin 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:
getRequestMirrorPoliciesListin 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:
getRequestMirrorPoliciesOrBuilderListin 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:
getRequestMirrorPoliciesCountin 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:
getRequestMirrorPoliciesin 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:
getRequestMirrorPoliciesOrBuilderin 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:
hasMetadatain 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:
getMetadatain 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:
getMetadataOrBuilderin interfaceVirtualHostOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein 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:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected VirtualHost.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-