VirtualHostOrBuilder (api 0.1.28 API)

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

VirtualHost, VirtualHost.Builder
```
public interface VirtualHostOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsPerFilterConfig(String key)` Deprecated.
`boolean`	`containsTypedPerFilterConfig(String key)` The per_filter_config field can be used to provide virtual host-specific configurations for filters.
`CorsPolicy`	`getCors()` Indicates that the virtual host has a CORS policy.
`CorsPolicyOrBuilder`	`getCorsOrBuilder()` Indicates that the virtual host has a CORS policy.
`String`	`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`	`getDomainsCount()` A list of domains (host/authority header) that will be matched to this virtual host.
`List<String>`	`getDomainsList()` A list of domains (host/authority header) that will be matched to this virtual host.
`HedgePolicy`	`getHedgePolicy()` Indicates the hedge policy for all routes in this virtual host.
`HedgePolicyOrBuilder`	`getHedgePolicyOrBuilder()` Indicates the hedge policy for all routes in this virtual host.
`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.
`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.
`String`	`getName()` The logical name of the virtual host.
`com.google.protobuf.ByteString`	`getNameBytes()` The logical name of the virtual host.
`Map<String,com.google.protobuf.Struct>`	`getPerFilterConfig()` Deprecated.
`int`	`getPerFilterConfigCount()` Deprecated.
`Map<String,com.google.protobuf.Struct>`	`getPerFilterConfigMap()` Deprecated.
`com.google.protobuf.Struct`	`getPerFilterConfigOrDefault(String key, com.google.protobuf.Struct defaultValue)` Deprecated.
`com.google.protobuf.Struct`	`getPerFilterConfigOrThrow(String key)` Deprecated.
`com.google.protobuf.UInt32Value`	`getPerRequestBufferLimitBytes()` The maximum bytes which will be buffered for retries and shadowing.
`com.google.protobuf.UInt32ValueOrBuilder`	`getPerRequestBufferLimitBytesOrBuilder()` The maximum bytes which will be buffered for retries and shadowing.
`RateLimit`	`getRateLimits(int index)` Specifies a set of rate limit configurations that will be applied to the virtual host.
`int`	`getRateLimitsCount()` Specifies a set of rate limit configurations that will be applied to the virtual host.
`List<RateLimit>`	`getRateLimitsList()` Specifies a set of rate limit configurations that will be applied to the virtual host.
`RateLimitOrBuilder`	`getRateLimitsOrBuilder(int index)` Specifies a set of rate limit configurations that will be applied to the virtual host.
`List<? extends RateLimitOrBuilder>`	`getRateLimitsOrBuilderList()` Specifies a set of rate limit configurations that will be applied to the virtual host.
`HeaderValueOption`	`getRequestHeadersToAdd(int index)` Specifies a list of HTTP headers that should be added to each request handled by this virtual host.
`int`	`getRequestHeadersToAddCount()` Specifies a list of HTTP headers that should be added to each request handled by this virtual host.
`List<HeaderValueOption>`	`getRequestHeadersToAddList()` Specifies a list of HTTP headers that should be added to each request handled by this virtual host.
`HeaderValueOptionOrBuilder`	`getRequestHeadersToAddOrBuilder(int index)` Specifies a list of HTTP headers that should be added to each request handled by this virtual host.
`List<? extends HeaderValueOptionOrBuilder>`	`getRequestHeadersToAddOrBuilderList()` Specifies a list of HTTP headers that should be added to each request handled by this virtual host.
`String`	`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`	`getRequestHeadersToRemoveCount()` Specifies a list of HTTP headers that should be removed from each request handled by this virtual host.
`List<String>`	`getRequestHeadersToRemoveList()` Specifies a list of HTTP headers that should be removed from each request handled by this virtual host.
`VirtualHost.TlsRequirementType`	`getRequireTls()` Specifies the type of TLS enforcement the virtual host expects.
`int`	`getRequireTlsValue()` Specifies the type of TLS enforcement the virtual host expects.
`HeaderValueOption`	`getResponseHeadersToAdd(int index)` Specifies a list of HTTP headers that should be added to each response handled by this virtual host.
`int`	`getResponseHeadersToAddCount()` Specifies a list of HTTP headers that should be added to each response handled by this virtual host.
`List<HeaderValueOption>`	`getResponseHeadersToAddList()` Specifies a list of HTTP headers that should be added to each response handled by this virtual host.
`HeaderValueOptionOrBuilder`	`getResponseHeadersToAddOrBuilder(int index)` Specifies a list of HTTP headers that should be added to each response handled by this virtual host.
`List<? extends HeaderValueOptionOrBuilder>`	`getResponseHeadersToAddOrBuilderList()` Specifies a list of HTTP headers that should be added to each response handled by this virtual host.
`String`	`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`	`getResponseHeadersToRemoveCount()` Specifies a list of HTTP headers that should be removed from each response handled by this virtual host.
`List<String>`	`getResponseHeadersToRemoveList()` Specifies a list of HTTP headers that should be removed from each response handled by this virtual host.
`RetryPolicy`	`getRetryPolicy()` Indicates the retry policy for all routes in this virtual host.
`RetryPolicyOrBuilder`	`getRetryPolicyOrBuilder()` Indicates the retry policy for all routes in this virtual host.
`com.google.protobuf.Any`	`getRetryPolicyTypedConfig()` [#not-implemented-hide:] Specifies the configuration for retry policy extension.
`com.google.protobuf.AnyOrBuilder`	`getRetryPolicyTypedConfigOrBuilder()` [#not-implemented-hide:] Specifies the configuration for retry policy extension.
`Route`	`getRoutes(int index)` The list of routes that will be matched, in order, for incoming requests.
`int`	`getRoutesCount()` The list of routes that will be matched, in order, for incoming requests.
`List<Route>`	`getRoutesList()` The list of routes that will be matched, in order, for incoming requests.
`RouteOrBuilder`	`getRoutesOrBuilder(int index)` The list of routes that will be matched, in order, for incoming requests.
`List<? extends RouteOrBuilder>`	`getRoutesOrBuilderList()` The list of routes that will be matched, in order, for incoming requests.
`Map<String,com.google.protobuf.Any>`	`getTypedPerFilterConfig()` Deprecated.
`int`	`getTypedPerFilterConfigCount()` The per_filter_config field can be used to provide virtual host-specific configurations for filters.
`Map<String,com.google.protobuf.Any>`	`getTypedPerFilterConfigMap()` The per_filter_config field can be used to provide virtual host-specific configurations for filters.
`com.google.protobuf.Any`	`getTypedPerFilterConfigOrDefault(String key, com.google.protobuf.Any defaultValue)` The per_filter_config field can be used to provide virtual host-specific configurations for filters.
`com.google.protobuf.Any`	`getTypedPerFilterConfigOrThrow(String key)` The per_filter_config field can be used to provide virtual host-specific configurations for filters.
`VirtualCluster`	`getVirtualClusters(int index)` A list of virtual clusters defined for this virtual host.
`int`	`getVirtualClustersCount()` A list of virtual clusters defined for this virtual host.
`List<VirtualCluster>`	`getVirtualClustersList()` A list of virtual clusters defined for this virtual host.
`VirtualClusterOrBuilder`	`getVirtualClustersOrBuilder(int index)` A list of virtual clusters defined for this virtual host.
`List<? extends VirtualClusterOrBuilder>`	`getVirtualClustersOrBuilderList()` A list of virtual clusters defined for this virtual host.
`boolean`	`hasCors()` Indicates that the virtual host has a CORS policy.
`boolean`	`hasHedgePolicy()` Indicates the hedge policy for all routes in this virtual host.
`boolean`	`hasPerRequestBufferLimitBytes()` The maximum bytes which will be buffered for retries and shadowing.
`boolean`	`hasRetryPolicy()` Indicates the retry policy for all routes in this virtual host.
`boolean`	`hasRetryPolicyTypedConfig()` [#not-implemented-hide:] Specifies the configuration for retry policy extension.

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

Method Detail

getName

String getName()

 The logical name of the virtual host. This is used when emitting certain
 statistics but is not relevant for routing.

string name = 1 [(.validate.rules) = { ... }

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 The logical name of the virtual host. This is used when emitting certain
 statistics but is not relevant for routing.

string name = 1 [(.validate.rules) = { ... }

getDomainsList

List<String> getDomainsList()

 A list of domains (host/authority header) that will be matched to this
 virtual host. Wildcard hosts are supported in the suffix or prefix form.
 Domain search order:
  1. Exact domain names: ``www.foo.com``.
  2. Suffix domain wildcards: ``*.foo.com`` or ``*-bar.foo.com``.
  3. Prefix domain wildcards: ``foo.*`` or ``foo-*``.
  4. Special wildcard ``*`` matching any domain.
 .. note::
   The wildcard will not match the empty string.
   e.g. ``*-bar.foo.com`` will match ``baz-bar.foo.com`` but not ``-bar.foo.com``.
   The longest wildcards match first.
   Only a single virtual host in the entire route configuration can match on ``*``. A domain
   must be unique across all virtual hosts or the config will fail to load.
 Domains cannot contain control characters. This is validated by the well_known_regex HTTP_HEADER_VALUE.

repeated string domains = 2 [(.validate.rules) = { ... }

getDomainsCount

int getDomainsCount()

 A list of domains (host/authority header) that will be matched to this
 virtual host. Wildcard hosts are supported in the suffix or prefix form.
 Domain search order:
  1. Exact domain names: ``www.foo.com``.
  2. Suffix domain wildcards: ``*.foo.com`` or ``*-bar.foo.com``.
  3. Prefix domain wildcards: ``foo.*`` or ``foo-*``.
  4. Special wildcard ``*`` matching any domain.
 .. note::
   The wildcard will not match the empty string.
   e.g. ``*-bar.foo.com`` will match ``baz-bar.foo.com`` but not ``-bar.foo.com``.
   The longest wildcards match first.
   Only a single virtual host in the entire route configuration can match on ``*``. A domain
   must be unique across all virtual hosts or the config will fail to load.
 Domains cannot contain control characters. This is validated by the well_known_regex HTTP_HEADER_VALUE.

repeated string domains = 2 [(.validate.rules) = { ... }

getDomains

String getDomains(int index)

 A list of domains (host/authority header) that will be matched to this
 virtual host. Wildcard hosts are supported in the suffix or prefix form.
 Domain search order:
  1. Exact domain names: ``www.foo.com``.
  2. Suffix domain wildcards: ``*.foo.com`` or ``*-bar.foo.com``.
  3. Prefix domain wildcards: ``foo.*`` or ``foo-*``.
  4. Special wildcard ``*`` matching any domain.
 .. note::
   The wildcard will not match the empty string.
   e.g. ``*-bar.foo.com`` will match ``baz-bar.foo.com`` but not ``-bar.foo.com``.
   The longest wildcards match first.
   Only a single virtual host in the entire route configuration can match on ``*``. A domain
   must be unique across all virtual hosts or the config will fail to load.
 Domains cannot contain control characters. This is validated by the well_known_regex HTTP_HEADER_VALUE.

repeated string domains = 2 [(.validate.rules) = { ... }

getDomainsBytes

com.google.protobuf.ByteString getDomainsBytes(int index)

 A list of domains (host/authority header) that will be matched to this
 virtual host. Wildcard hosts are supported in the suffix or prefix form.
 Domain search order:
  1. Exact domain names: ``www.foo.com``.
  2. Suffix domain wildcards: ``*.foo.com`` or ``*-bar.foo.com``.
  3. Prefix domain wildcards: ``foo.*`` or ``foo-*``.
  4. Special wildcard ``*`` matching any domain.
 .. note::
   The wildcard will not match the empty string.
   e.g. ``*-bar.foo.com`` will match ``baz-bar.foo.com`` but not ``-bar.foo.com``.
   The longest wildcards match first.
   Only a single virtual host in the entire route configuration can match on ``*``. A domain
   must be unique across all virtual hosts or the config will fail to load.
 Domains cannot contain control characters. This is validated by the well_known_regex HTTP_HEADER_VALUE.

repeated string domains = 2 [(.validate.rules) = { ... }

getRoutesList

List<Route> getRoutesList()

 The list of routes that will be matched, in order, for incoming requests.
 The first route that matches will be used.

repeated .envoy.api.v2.route.Route routes = 3;

getRoutes

Route getRoutes(int index)

 The list of routes that will be matched, in order, for incoming requests.
 The first route that matches will be used.

repeated .envoy.api.v2.route.Route routes = 3;

getRoutesCount

int getRoutesCount()

 The list of routes that will be matched, in order, for incoming requests.
 The first route that matches will be used.

repeated .envoy.api.v2.route.Route routes = 3;

getRoutesOrBuilderList

List<? extends RouteOrBuilder> getRoutesOrBuilderList()

 The list of routes that will be matched, in order, for incoming requests.
 The first route that matches will be used.

repeated .envoy.api.v2.route.Route routes = 3;

getRoutesOrBuilder

RouteOrBuilder getRoutesOrBuilder(int index)

 The list of routes that will be matched, in order, for incoming requests.
 The first route that matches will be used.

repeated .envoy.api.v2.route.Route routes = 3;

getRequireTlsValue

int getRequireTlsValue()

 Specifies the type of TLS enforcement the virtual host expects. If this option is not
 specified, there is no TLS requirement for the virtual host.

.envoy.api.v2.route.VirtualHost.TlsRequirementType require_tls = 4 [(.validate.rules) = { ... }

getRequireTls

VirtualHost.TlsRequirementType getRequireTls()

 Specifies the type of TLS enforcement the virtual host expects. If this option is not
 specified, there is no TLS requirement for the virtual host.

.envoy.api.v2.route.VirtualHost.TlsRequirementType require_tls = 4 [(.validate.rules) = { ... }