io.envoyproxy.envoy.config.bootstrap.v2

Interface BootstrapOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

Bootstrap, Bootstrap.Builder

public interface BootstrapOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Admin	getAdmin() Configuration for the local administration HTTP server.
AdminOrBuilder	getAdminOrBuilder() Configuration for the local administration HTTP server.
ClusterManager	getClusterManager() Configuration for the cluster manager which owns all upstream clusters within the server.
ClusterManagerOrBuilder	getClusterManagerOrBuilder() Configuration for the cluster manager which owns all upstream clusters within the server.
Bootstrap.DynamicResources	getDynamicResources() xDS configuration sources.
Bootstrap.DynamicResourcesOrBuilder	getDynamicResourcesOrBuilder() xDS configuration sources.
boolean	getEnableDispatcherStats() Enable :ref:`stats for event dispatcher <operations_performance>`, defaults to false.
String	getFlagsPath() Optional file system path to search for startup flag files.
com.google.protobuf.ByteString	getFlagsPathBytes() Optional file system path to search for startup flag files.
ApiConfigSource	getHdsConfig() Health discovery service config option.
ApiConfigSourceOrBuilder	getHdsConfigOrBuilder() Health discovery service config option.
String	getHeaderPrefix() Optional string which will be used in lieu of x-envoy in prefixing headers.
com.google.protobuf.ByteString	getHeaderPrefixBytes() Optional string which will be used in lieu of x-envoy in prefixing headers.
LayeredRuntime	getLayeredRuntime() Configuration for the runtime configuration provider.
LayeredRuntimeOrBuilder	getLayeredRuntimeOrBuilder() Configuration for the runtime configuration provider.
Node	getNode() Node identity to present to the management server and for instance identification purposes (e.g. in generated headers).
NodeOrBuilder	getNodeOrBuilder() Node identity to present to the management server and for instance identification purposes (e.g. in generated headers).
OverloadManager	getOverloadManager() Optional overload manager configuration.
OverloadManagerOrBuilder	getOverloadManagerOrBuilder() Optional overload manager configuration.
Runtime	getRuntime() Deprecated.
RuntimeOrBuilder	getRuntimeOrBuilder() Deprecated.
Bootstrap.StaticResources	getStaticResources() Statically specified resources.
Bootstrap.StaticResourcesOrBuilder	getStaticResourcesOrBuilder() Statically specified resources.
StatsConfig	getStatsConfig() Configuration for internal processing of stats.
StatsConfigOrBuilder	getStatsConfigOrBuilder() Configuration for internal processing of stats.
com.google.protobuf.Duration	getStatsFlushInterval() Optional duration between flushes to configured stats sinks.
com.google.protobuf.DurationOrBuilder	getStatsFlushIntervalOrBuilder() Optional duration between flushes to configured stats sinks.
com.google.protobuf.UInt64Value	getStatsServerVersionOverride() Optional proxy version which will be used to set the value of :ref:`server.version statistic <server_statistics>` if specified.
com.google.protobuf.UInt64ValueOrBuilder	getStatsServerVersionOverrideOrBuilder() Optional proxy version which will be used to set the value of :ref:`server.version statistic <server_statistics>` if specified.
StatsSink	getStatsSinks(int index) Optional set of stats sinks.
int	getStatsSinksCount() Optional set of stats sinks.
List<StatsSink>	getStatsSinksList() Optional set of stats sinks.
StatsSinkOrBuilder	getStatsSinksOrBuilder(int index) Optional set of stats sinks.
List<? extends StatsSinkOrBuilder>	getStatsSinksOrBuilderList() Optional set of stats sinks.
Tracing	getTracing() Configuration for an external tracing provider. .. attention:: This field has been deprecated in favor of :ref:`HttpConnectionManager.Tracing.provider <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.Tracing.provider>`.
TracingOrBuilder	getTracingOrBuilder() Configuration for an external tracing provider. .. attention:: This field has been deprecated in favor of :ref:`HttpConnectionManager.Tracing.provider <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.Tracing.provider>`.
boolean	getUseTcpForDnsLookups() Always use TCP queries instead of UDP queries for DNS lookups.
Watchdog	getWatchdog() Optional watchdog configuration.
WatchdogOrBuilder	getWatchdogOrBuilder() Optional watchdog configuration.
boolean	hasAdmin() Configuration for the local administration HTTP server.
boolean	hasClusterManager() Configuration for the cluster manager which owns all upstream clusters within the server.
boolean	hasDynamicResources() xDS configuration sources.
boolean	hasHdsConfig() Health discovery service config option.
boolean	hasLayeredRuntime() Configuration for the runtime configuration provider.
boolean	hasNode() Node identity to present to the management server and for instance identification purposes (e.g. in generated headers).
boolean	hasOverloadManager() Optional overload manager configuration.
boolean	hasRuntime() Deprecated.
boolean	hasStaticResources() Statically specified resources.
boolean	hasStatsConfig() Configuration for internal processing of stats.
boolean	hasStatsFlushInterval() Optional duration between flushes to configured stats sinks.
boolean	hasStatsServerVersionOverride() Optional proxy version which will be used to set the value of :ref:`server.version statistic <server_statistics>` if specified.
boolean	hasTracing() Configuration for an external tracing provider. .. attention:: This field has been deprecated in favor of :ref:`HttpConnectionManager.Tracing.provider <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.Tracing.provider>`.
boolean	hasWatchdog() Optional watchdog configuration.

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

hasNode

boolean hasNode()

 Node identity to present to the management server and for instance
 identification purposes (e.g. in generated headers).
 

.envoy.api.v2.core.Node node = 1;

getNode

Node getNode()

 Node identity to present to the management server and for instance
 identification purposes (e.g. in generated headers).
 

.envoy.api.v2.core.Node node = 1;

getNodeOrBuilder

NodeOrBuilder getNodeOrBuilder()

 Node identity to present to the management server and for instance
 identification purposes (e.g. in generated headers).
 

.envoy.api.v2.core.Node node = 1;

hasStaticResources

boolean hasStaticResources()

 Statically specified resources.
 

.envoy.config.bootstrap.v2.Bootstrap.StaticResources static_resources = 2;

getStaticResources

Bootstrap.StaticResources getStaticResources()

 Statically specified resources.
 

.envoy.config.bootstrap.v2.Bootstrap.StaticResources static_resources = 2;

getStaticResourcesOrBuilder

Bootstrap.StaticResourcesOrBuilder getStaticResourcesOrBuilder()

 Statically specified resources.
 

.envoy.config.bootstrap.v2.Bootstrap.StaticResources static_resources = 2;

hasDynamicResources

boolean hasDynamicResources()

 xDS configuration sources.
 

.envoy.config.bootstrap.v2.Bootstrap.DynamicResources dynamic_resources = 3;

getDynamicResources

Bootstrap.DynamicResources getDynamicResources()

 xDS configuration sources.
 

.envoy.config.bootstrap.v2.Bootstrap.DynamicResources dynamic_resources = 3;

getDynamicResourcesOrBuilder

Bootstrap.DynamicResourcesOrBuilder getDynamicResourcesOrBuilder()

 xDS configuration sources.
 

.envoy.config.bootstrap.v2.Bootstrap.DynamicResources dynamic_resources = 3;

hasClusterManager

boolean hasClusterManager()

 Configuration for the cluster manager which owns all upstream clusters
 within the server.
 

.envoy.config.bootstrap.v2.ClusterManager cluster_manager = 4;

getClusterManager

ClusterManager getClusterManager()

 Configuration for the cluster manager which owns all upstream clusters
 within the server.
 

.envoy.config.bootstrap.v2.ClusterManager cluster_manager = 4;

getClusterManagerOrBuilder

ClusterManagerOrBuilder getClusterManagerOrBuilder()

 Configuration for the cluster manager which owns all upstream clusters
 within the server.
 

.envoy.config.bootstrap.v2.ClusterManager cluster_manager = 4;

hasHdsConfig

boolean hasHdsConfig()

 Health discovery service config option.
 (:ref:`core.ApiConfigSource <envoy_api_msg_core.ApiConfigSource>`)
 

.envoy.api.v2.core.ApiConfigSource hds_config = 14;

getHdsConfig

ApiConfigSource getHdsConfig()

 Health discovery service config option.
 (:ref:`core.ApiConfigSource <envoy_api_msg_core.ApiConfigSource>`)
 

.envoy.api.v2.core.ApiConfigSource hds_config = 14;

getHdsConfigOrBuilder

ApiConfigSourceOrBuilder getHdsConfigOrBuilder()

 Health discovery service config option.
 (:ref:`core.ApiConfigSource <envoy_api_msg_core.ApiConfigSource>`)
 

.envoy.api.v2.core.ApiConfigSource hds_config = 14;

getFlagsPath

String getFlagsPath()

 Optional file system path to search for startup flag files.
 

string flags_path = 5;

getFlagsPathBytes

com.google.protobuf.ByteString getFlagsPathBytes()

 Optional file system path to search for startup flag files.
 

string flags_path = 5;

getStatsSinksList

List<StatsSink> getStatsSinksList()

 Optional set of stats sinks.
 

repeated .envoy.config.metrics.v2.StatsSink stats_sinks = 6;

getStatsSinks

StatsSink getStatsSinks(int index)

 Optional set of stats sinks.
 

repeated .envoy.config.metrics.v2.StatsSink stats_sinks = 6;

getStatsSinksCount

int getStatsSinksCount()

 Optional set of stats sinks.
 

repeated .envoy.config.metrics.v2.StatsSink stats_sinks = 6;

getStatsSinksOrBuilderList

List<? extends StatsSinkOrBuilder> getStatsSinksOrBuilderList()

 Optional set of stats sinks.
 

repeated .envoy.config.metrics.v2.StatsSink stats_sinks = 6;

getStatsSinksOrBuilder

StatsSinkOrBuilder getStatsSinksOrBuilder(int index)

 Optional set of stats sinks.
 

repeated .envoy.config.metrics.v2.StatsSink stats_sinks = 6;

hasStatsConfig

boolean hasStatsConfig()

 Configuration for internal processing of stats.
 

.envoy.config.metrics.v2.StatsConfig stats_config = 13;

getStatsConfig

StatsConfig getStatsConfig()

 Configuration for internal processing of stats.
 

.envoy.config.metrics.v2.StatsConfig stats_config = 13;

getStatsConfigOrBuilder

StatsConfigOrBuilder getStatsConfigOrBuilder()

 Configuration for internal processing of stats.
 

.envoy.config.metrics.v2.StatsConfig stats_config = 13;

hasStatsFlushInterval

boolean hasStatsFlushInterval()

 Optional duration between flushes to configured stats sinks. For
 performance reasons Envoy latches counters and only flushes counters and
 gauges at a periodic interval. If not specified the default is 5000ms (5
 seconds).
 Duration must be at least 1ms and at most 5 min.
 

.google.protobuf.Duration stats_flush_interval = 7 [(.validate.rules) = { ... }

getStatsFlushInterval

com.google.protobuf.Duration getStatsFlushInterval()

 Optional duration between flushes to configured stats sinks. For
 performance reasons Envoy latches counters and only flushes counters and
 gauges at a periodic interval. If not specified the default is 5000ms (5
 seconds).
 Duration must be at least 1ms and at most 5 min.
 

.google.protobuf.Duration stats_flush_interval = 7 [(.validate.rules) = { ... }

getStatsFlushIntervalOrBuilder

com.google.protobuf.DurationOrBuilder getStatsFlushIntervalOrBuilder()

 Optional duration between flushes to configured stats sinks. For
 performance reasons Envoy latches counters and only flushes counters and
 gauges at a periodic interval. If not specified the default is 5000ms (5
 seconds).
 Duration must be at least 1ms and at most 5 min.
 

.google.protobuf.Duration stats_flush_interval = 7 [(.validate.rules) = { ... }

hasWatchdog

boolean hasWatchdog()

 Optional watchdog configuration.
 

.envoy.config.bootstrap.v2.Watchdog watchdog = 8;

getWatchdog

Watchdog getWatchdog()

 Optional watchdog configuration.
 

.envoy.config.bootstrap.v2.Watchdog watchdog = 8;

getWatchdogOrBuilder

WatchdogOrBuilder getWatchdogOrBuilder()

 Optional watchdog configuration.
 

.envoy.config.bootstrap.v2.Watchdog watchdog = 8;

hasTracing

boolean hasTracing()

 Configuration for an external tracing provider.
 .. attention::
  This field has been deprecated in favor of :ref:`HttpConnectionManager.Tracing.provider
  <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.Tracing.provider>`.
 

.envoy.config.trace.v2.Tracing tracing = 9;

getTracing

Tracing getTracing()

 Configuration for an external tracing provider.
 .. attention::
  This field has been deprecated in favor of :ref:`HttpConnectionManager.Tracing.provider
  <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.Tracing.provider>`.
 

.envoy.config.trace.v2.Tracing tracing = 9;

getTracingOrBuilder

TracingOrBuilder getTracingOrBuilder()

 Configuration for an external tracing provider.
 .. attention::
  This field has been deprecated in favor of :ref:`HttpConnectionManager.Tracing.provider
  <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.Tracing.provider>`.
 

.envoy.config.trace.v2.Tracing tracing = 9;

hasRuntime

@Deprecated
boolean hasRuntime()

Deprecated.

 Configuration for the runtime configuration provider (deprecated). If not
 specified, a “null” provider will be used which will result in all defaults
 being used.
 

.envoy.config.bootstrap.v2.Runtime runtime = 11 [deprecated = true, (.envoy.annotations.disallowed_by_default) = true];

getRuntime

@Deprecated
Runtime getRuntime()

Deprecated.

 Configuration for the runtime configuration provider (deprecated). If not
 specified, a “null” provider will be used which will result in all defaults
 being used.
 

.envoy.config.bootstrap.v2.Runtime runtime = 11 [deprecated = true, (.envoy.annotations.disallowed_by_default) = true];

getRuntimeOrBuilder

@Deprecated
RuntimeOrBuilder getRuntimeOrBuilder()

Deprecated.

 Configuration for the runtime configuration provider (deprecated). If not
 specified, a “null” provider will be used which will result in all defaults
 being used.
 

.envoy.config.bootstrap.v2.Runtime runtime = 11 [deprecated = true, (.envoy.annotations.disallowed_by_default) = true];

hasLayeredRuntime

boolean hasLayeredRuntime()

 Configuration for the runtime configuration provider. If not
 specified, a “null” provider will be used which will result in all defaults
 being used.
 

.envoy.config.bootstrap.v2.LayeredRuntime layered_runtime = 17;

getLayeredRuntime

LayeredRuntime getLayeredRuntime()

 Configuration for the runtime configuration provider. If not
 specified, a “null” provider will be used which will result in all defaults
 being used.
 

.envoy.config.bootstrap.v2.LayeredRuntime layered_runtime = 17;

getLayeredRuntimeOrBuilder

LayeredRuntimeOrBuilder getLayeredRuntimeOrBuilder()

 Configuration for the runtime configuration provider. If not
 specified, a “null” provider will be used which will result in all defaults
 being used.
 

.envoy.config.bootstrap.v2.LayeredRuntime layered_runtime = 17;

hasAdmin

boolean hasAdmin()

 Configuration for the local administration HTTP server.
 

.envoy.config.bootstrap.v2.Admin admin = 12;

getAdmin

Admin getAdmin()

 Configuration for the local administration HTTP server.
 

.envoy.config.bootstrap.v2.Admin admin = 12;

getAdminOrBuilder

AdminOrBuilder getAdminOrBuilder()

 Configuration for the local administration HTTP server.
 

.envoy.config.bootstrap.v2.Admin admin = 12;

hasOverloadManager

boolean hasOverloadManager()

 Optional overload manager configuration.
 

.envoy.config.overload.v2alpha.OverloadManager overload_manager = 15;

getOverloadManager

OverloadManager getOverloadManager()

 Optional overload manager configuration.
 

.envoy.config.overload.v2alpha.OverloadManager overload_manager = 15;

getOverloadManagerOrBuilder

OverloadManagerOrBuilder getOverloadManagerOrBuilder()

 Optional overload manager configuration.
 

.envoy.config.overload.v2alpha.OverloadManager overload_manager = 15;

getEnableDispatcherStats

boolean getEnableDispatcherStats()

 Enable :ref:`stats for event dispatcher <operations_performance>`, defaults to false.
 Note that this records a value for each iteration of the event loop on every thread. This
 should normally be minimal overhead, but when using
 :ref:`statsd <envoy_api_msg_config.metrics.v2.StatsdSink>`, it will send each observed value
 over the wire individually because the statsd protocol doesn't have any way to represent a
 histogram summary. Be aware that this can be a very large volume of data.
 

bool enable_dispatcher_stats = 16;

getHeaderPrefix

String getHeaderPrefix()

 Optional string which will be used in lieu of x-envoy in prefixing headers.
 For example, if this string is present and set to X-Foo, then x-envoy-retry-on will be
 transformed into x-foo-retry-on etc.
 Note this applies to the headers Envoy will generate, the headers Envoy will sanitize, and the
 headers Envoy will trust for core code and core extensions only. Be VERY careful making
 changes to this string, especially in multi-layer Envoy deployments or deployments using
 extensions which are not upstream.
 

string header_prefix = 18;

getHeaderPrefixBytes

com.google.protobuf.ByteString getHeaderPrefixBytes()

 Optional string which will be used in lieu of x-envoy in prefixing headers.
 For example, if this string is present and set to X-Foo, then x-envoy-retry-on will be
 transformed into x-foo-retry-on etc.
 Note this applies to the headers Envoy will generate, the headers Envoy will sanitize, and the
 headers Envoy will trust for core code and core extensions only. Be VERY careful making
 changes to this string, especially in multi-layer Envoy deployments or deployments using
 extensions which are not upstream.
 

string header_prefix = 18;

hasStatsServerVersionOverride

boolean hasStatsServerVersionOverride()

 Optional proxy version which will be used to set the value of :ref:`server.version statistic
 <server_statistics>` if specified. Envoy will not process this value, it will be sent as is to
 :ref:`stats sinks <envoy_api_msg_config.metrics.v2.StatsSink>`.
 

.google.protobuf.UInt64Value stats_server_version_override = 19;

getStatsServerVersionOverride

com.google.protobuf.UInt64Value getStatsServerVersionOverride()

 Optional proxy version which will be used to set the value of :ref:`server.version statistic
 <server_statistics>` if specified. Envoy will not process this value, it will be sent as is to
 :ref:`stats sinks <envoy_api_msg_config.metrics.v2.StatsSink>`.
 

.google.protobuf.UInt64Value stats_server_version_override = 19;

getStatsServerVersionOverrideOrBuilder

com.google.protobuf.UInt64ValueOrBuilder getStatsServerVersionOverrideOrBuilder()

 Optional proxy version which will be used to set the value of :ref:`server.version statistic
 <server_statistics>` if specified. Envoy will not process this value, it will be sent as is to
 :ref:`stats sinks <envoy_api_msg_config.metrics.v2.StatsSink>`.
 

.google.protobuf.UInt64Value stats_server_version_override = 19;

getUseTcpForDnsLookups

boolean getUseTcpForDnsLookups()

 Always use TCP queries instead of UDP queries for DNS lookups.
 This may be overridden on a per-cluster basis in cds_config,
 when :ref:`dns_resolvers <envoy_api_field_Cluster.dns_resolvers>` and
 :ref:`use_tcp_for_dns_lookups <envoy_api_field_Cluster.use_tcp_for_dns_lookups>` are
 specified.
 Setting this value causes failure if the
 ``envoy.restart_features.use_apple_api_for_dns_lookups`` runtime value is true during
 server startup. Apple' API only uses UDP for DNS resolution.
 

bool use_tcp_for_dns_lookups = 20;