Package io.envoyproxy.envoy.config.bootstrap.v3

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 Detail

      • hasNode

        boolean hasNode()
         Node identity to present to the management server and for instance
 identification purposes (e.g. in generated headers).
        .envoy.config.core.v3.Node node = 1;
        Returns:
        Whether the node field is set.

      • getNode

        Node getNode()
         Node identity to present to the management server and for instance
 identification purposes (e.g. in generated headers).
        .envoy.config.core.v3.Node node = 1;
        Returns:
        The node.

      • getNodeOrBuilder

        NodeOrBuilder getNodeOrBuilder()
         Node identity to present to the management server and for instance
 identification purposes (e.g. in generated headers).
        .envoy.config.core.v3.Node node = 1;

      • getNodeContextParamsList

        List<String> getNodeContextParamsList()
         A list of :ref:`Node <envoy_v3_api_msg_config.core.v3.Node>` field names
 that will be included in the context parameters of the effective
 xdstp:// URL that is sent in a discovery request when resource
 locators are used for LDS/CDS. Any non-string field will have its JSON
 encoding set as the context parameter value, with the exception of
 metadata, which will be flattened (see example below). The supported field
 names are:
 - "cluster"
 - "id"
 - "locality.region"
 - "locality.sub_zone"
 - "locality.zone"
 - "metadata"
 - "user_agent_build_version.metadata"
 - "user_agent_build_version.version"
 - "user_agent_name"
 - "user_agent_version"
 The node context parameters act as a base layer dictionary for the context
 parameters (i.e. more specific resource specific context parameters will
 override). Field names will be prefixed with “udpa.node.” when included in
 context parameters.
 For example, if node_context_params is ``["user_agent_name", "metadata"]``,
 the implied context parameters might be::
   node.user_agent_name: "envoy"
   node.metadata.foo: "{\"bar\": \"baz\"}"
   node.metadata.some: "42"
   node.metadata.thing: "\"thing\""
 [#not-implemented-hide:]
        repeated string node_context_params = 26;
        Returns:
        A list containing the nodeContextParams.

      • getNodeContextParamsCount

        int getNodeContextParamsCount()
         A list of :ref:`Node <envoy_v3_api_msg_config.core.v3.Node>` field names
 that will be included in the context parameters of the effective
 xdstp:// URL that is sent in a discovery request when resource
 locators are used for LDS/CDS. Any non-string field will have its JSON
 encoding set as the context parameter value, with the exception of
 metadata, which will be flattened (see example below). The supported field
 names are:
 - "cluster"
 - "id"
 - "locality.region"
 - "locality.sub_zone"
 - "locality.zone"
 - "metadata"
 - "user_agent_build_version.metadata"
 - "user_agent_build_version.version"
 - "user_agent_name"
 - "user_agent_version"
 The node context parameters act as a base layer dictionary for the context
 parameters (i.e. more specific resource specific context parameters will
 override). Field names will be prefixed with “udpa.node.” when included in
 context parameters.
 For example, if node_context_params is ``["user_agent_name", "metadata"]``,
 the implied context parameters might be::
   node.user_agent_name: "envoy"
   node.metadata.foo: "{\"bar\": \"baz\"}"
   node.metadata.some: "42"
   node.metadata.thing: "\"thing\""
 [#not-implemented-hide:]
        repeated string node_context_params = 26;
        Returns:
        The count of nodeContextParams.

      • getNodeContextParams

        String getNodeContextParams​(int index)
         A list of :ref:`Node <envoy_v3_api_msg_config.core.v3.Node>` field names
 that will be included in the context parameters of the effective
 xdstp:// URL that is sent in a discovery request when resource
 locators are used for LDS/CDS. Any non-string field will have its JSON
 encoding set as the context parameter value, with the exception of
 metadata, which will be flattened (see example below). The supported field
 names are:
 - "cluster"
 - "id"
 - "locality.region"
 - "locality.sub_zone"
 - "locality.zone"
 - "metadata"
 - "user_agent_build_version.metadata"
 - "user_agent_build_version.version"
 - "user_agent_name"
 - "user_agent_version"
 The node context parameters act as a base layer dictionary for the context
 parameters (i.e. more specific resource specific context parameters will
 override). Field names will be prefixed with “udpa.node.” when included in
 context parameters.
 For example, if node_context_params is ``["user_agent_name", "metadata"]``,
 the implied context parameters might be::
   node.user_agent_name: "envoy"
   node.metadata.foo: "{\"bar\": \"baz\"}"
   node.metadata.some: "42"
   node.metadata.thing: "\"thing\""
 [#not-implemented-hide:]
        repeated string node_context_params = 26;
        Parameters:
        index - The index of the element to return.
        Returns:
        The nodeContextParams at the given index.

      • getNodeContextParamsBytes

        com.google.protobuf.ByteString getNodeContextParamsBytes​(int index)
         A list of :ref:`Node <envoy_v3_api_msg_config.core.v3.Node>` field names
 that will be included in the context parameters of the effective
 xdstp:// URL that is sent in a discovery request when resource
 locators are used for LDS/CDS. Any non-string field will have its JSON
 encoding set as the context parameter value, with the exception of
 metadata, which will be flattened (see example below). The supported field
 names are:
 - "cluster"
 - "id"
 - "locality.region"
 - "locality.sub_zone"
 - "locality.zone"
 - "metadata"
 - "user_agent_build_version.metadata"
 - "user_agent_build_version.version"
 - "user_agent_name"
 - "user_agent_version"
 The node context parameters act as a base layer dictionary for the context
 parameters (i.e. more specific resource specific context parameters will
 override). Field names will be prefixed with “udpa.node.” when included in
 context parameters.
 For example, if node_context_params is ``["user_agent_name", "metadata"]``,
 the implied context parameters might be::
   node.user_agent_name: "envoy"
   node.metadata.foo: "{\"bar\": \"baz\"}"
   node.metadata.some: "42"
   node.metadata.thing: "\"thing\""
 [#not-implemented-hide:]
        repeated string node_context_params = 26;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the nodeContextParams at the given index.

      • hasStaticResources

        boolean hasStaticResources()
         Statically specified resources.
        .envoy.config.bootstrap.v3.Bootstrap.StaticResources static_resources = 2;
        Returns:
        Whether the staticResources field is set.

      • getStaticResources

        Bootstrap.StaticResources getStaticResources()
         Statically specified resources.
        .envoy.config.bootstrap.v3.Bootstrap.StaticResources static_resources = 2;
        Returns:
        The staticResources.

      • getStaticResourcesOrBuilder

        Bootstrap.StaticResourcesOrBuilder getStaticResourcesOrBuilder()
         Statically specified resources.
        .envoy.config.bootstrap.v3.Bootstrap.StaticResources static_resources = 2;

      • hasDynamicResources

        boolean hasDynamicResources()
         xDS configuration sources.
        .envoy.config.bootstrap.v3.Bootstrap.DynamicResources dynamic_resources = 3;
        Returns:
        Whether the dynamicResources field is set.

      • getDynamicResources

        Bootstrap.DynamicResources getDynamicResources()
         xDS configuration sources.
        .envoy.config.bootstrap.v3.Bootstrap.DynamicResources dynamic_resources = 3;
        Returns:
        The dynamicResources.

      • getDynamicResourcesOrBuilder

        Bootstrap.DynamicResourcesOrBuilder getDynamicResourcesOrBuilder()
         xDS configuration sources.
        .envoy.config.bootstrap.v3.Bootstrap.DynamicResources dynamic_resources = 3;

      • hasClusterManager

        boolean hasClusterManager()
         Configuration for the cluster manager which owns all upstream clusters
 within the server.
        .envoy.config.bootstrap.v3.ClusterManager cluster_manager = 4;
        Returns:
        Whether the clusterManager field is set.

      • getClusterManager

        ClusterManager getClusterManager()
         Configuration for the cluster manager which owns all upstream clusters
 within the server.
        .envoy.config.bootstrap.v3.ClusterManager cluster_manager = 4;
        Returns:
        The clusterManager.

      • getClusterManagerOrBuilder

        ClusterManagerOrBuilder getClusterManagerOrBuilder()
         Configuration for the cluster manager which owns all upstream clusters
 within the server.
        .envoy.config.bootstrap.v3.ClusterManager cluster_manager = 4;

      • hasHdsConfig

        boolean hasHdsConfig()
         Health discovery service config option.
 (:ref:`core.ApiConfigSource <envoy_v3_api_msg_config.core.v3.ApiConfigSource>`)
        .envoy.config.core.v3.ApiConfigSource hds_config = 14;
        Returns:
        Whether the hdsConfig field is set.

      • getHdsConfig

        ApiConfigSource getHdsConfig()
         Health discovery service config option.
 (:ref:`core.ApiConfigSource <envoy_v3_api_msg_config.core.v3.ApiConfigSource>`)
        .envoy.config.core.v3.ApiConfigSource hds_config = 14;
        Returns:
        The hdsConfig.

      • getHdsConfigOrBuilder

        ApiConfigSourceOrBuilder getHdsConfigOrBuilder()
         Health discovery service config option.
 (:ref:`core.ApiConfigSource <envoy_v3_api_msg_config.core.v3.ApiConfigSource>`)
        .envoy.config.core.v3.ApiConfigSource hds_config = 14;

      • getFlagsPath

        String getFlagsPath()
         Optional file system path to search for startup flag files.
        string flags_path = 5;
        Returns:
        The flagsPath.

      • getFlagsPathBytes

        com.google.protobuf.ByteString getFlagsPathBytes()
         Optional file system path to search for startup flag files.
        string flags_path = 5;
        Returns:
        The bytes for flagsPath.

      • getStatsSinksList

        List<StatsSink> getStatsSinksList()
         Optional set of stats sinks.
        repeated .envoy.config.metrics.v3.StatsSink stats_sinks = 6;

      • getStatsSinks

        StatsSink getStatsSinks​(int index)
         Optional set of stats sinks.
        repeated .envoy.config.metrics.v3.StatsSink stats_sinks = 6;

      • getStatsSinksCount

        int getStatsSinksCount()
         Optional set of stats sinks.
        repeated .envoy.config.metrics.v3.StatsSink stats_sinks = 6;

      • getStatsSinksOrBuilderList

        List<? extends StatsSinkOrBuilder> getStatsSinksOrBuilderList()
         Optional set of stats sinks.
        repeated .envoy.config.metrics.v3.StatsSink stats_sinks = 6;

      • getStatsSinksOrBuilder

        StatsSinkOrBuilder getStatsSinksOrBuilder​(int index)
         Optional set of stats sinks.
        repeated .envoy.config.metrics.v3.StatsSink stats_sinks = 6;

      • hasStatsConfig

        boolean hasStatsConfig()
         Configuration for internal processing of stats.
        .envoy.config.metrics.v3.StatsConfig stats_config = 13;
        Returns:
        Whether the statsConfig field is set.

      • getStatsConfig

        StatsConfig getStatsConfig()
         Configuration for internal processing of stats.
        .envoy.config.metrics.v3.StatsConfig stats_config = 13;
        Returns:
        The statsConfig.

      • getStatsConfigOrBuilder

        StatsConfigOrBuilder getStatsConfigOrBuilder()
         Configuration for internal processing of stats.
        .envoy.config.metrics.v3.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). Only one of ``stats_flush_interval`` or ``stats_flush_on_admin``
 can be set.
 Duration must be at least 1ms and at most 5 min.
        .google.protobuf.Duration stats_flush_interval = 7 [(.validate.rules) = { ... }
        Returns:
        Whether the statsFlushInterval field is set.

      • 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). Only one of ``stats_flush_interval`` or ``stats_flush_on_admin``
 can be set.
 Duration must be at least 1ms and at most 5 min.
        .google.protobuf.Duration stats_flush_interval = 7 [(.validate.rules) = { ... }
        Returns:
        The statsFlushInterval.

      • 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). Only one of ``stats_flush_interval`` or ``stats_flush_on_admin``
 can be set.
 Duration must be at least 1ms and at most 5 min.
        .google.protobuf.Duration stats_flush_interval = 7 [(.validate.rules) = { ... }

      • hasStatsFlushOnAdmin

        boolean hasStatsFlushOnAdmin()
         Flush stats to sinks only when queried for on the admin interface. If set,
 a flush timer is not created. Only one of ``stats_flush_on_admin`` or
 ``stats_flush_interval`` can be set.
        bool stats_flush_on_admin = 29 [(.validate.rules) = { ... }
        Returns:
        Whether the statsFlushOnAdmin field is set.

      • getStatsFlushOnAdmin

        boolean getStatsFlushOnAdmin()
         Flush stats to sinks only when queried for on the admin interface. If set,
 a flush timer is not created. Only one of ``stats_flush_on_admin`` or
 ``stats_flush_interval`` can be set.
        bool stats_flush_on_admin = 29 [(.validate.rules) = { ... }
        Returns:
        The statsFlushOnAdmin.

      • hasWatchdog

        @Deprecated
boolean hasWatchdog()
        Deprecated.
        envoy.config.bootstrap.v3.Bootstrap.watchdog is deprecated. See envoy/config/bootstrap/v3/bootstrap.proto;l=192
         Optional watchdog configuration.
 This is for a single watchdog configuration for the entire system.
 Deprecated in favor of ``watchdogs`` which has finer granularity.
        .envoy.config.bootstrap.v3.Watchdog watchdog = 8 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Returns:
        Whether the watchdog field is set.

      • getWatchdog

        @Deprecated
Watchdog getWatchdog()
        Deprecated.
        envoy.config.bootstrap.v3.Bootstrap.watchdog is deprecated. See envoy/config/bootstrap/v3/bootstrap.proto;l=192
         Optional watchdog configuration.
 This is for a single watchdog configuration for the entire system.
 Deprecated in favor of ``watchdogs`` which has finer granularity.
        .envoy.config.bootstrap.v3.Watchdog watchdog = 8 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Returns:
        The watchdog.

      • getWatchdogOrBuilder

        @Deprecated
WatchdogOrBuilder getWatchdogOrBuilder()
        Deprecated.
         Optional watchdog configuration.
 This is for a single watchdog configuration for the entire system.
 Deprecated in favor of ``watchdogs`` which has finer granularity.
        .envoy.config.bootstrap.v3.Watchdog watchdog = 8 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];

      • hasWatchdogs

        boolean hasWatchdogs()
         Optional watchdogs configuration.
 This is used for specifying different watchdogs for the different subsystems.
 [#extension-category: envoy.guarddog_actions]
        .envoy.config.bootstrap.v3.Watchdogs watchdogs = 27;
        Returns:
        Whether the watchdogs field is set.

      • getWatchdogs

        Watchdogs getWatchdogs()
         Optional watchdogs configuration.
 This is used for specifying different watchdogs for the different subsystems.
 [#extension-category: envoy.guarddog_actions]
        .envoy.config.bootstrap.v3.Watchdogs watchdogs = 27;
        Returns:
        The watchdogs.

      • getWatchdogsOrBuilder

        WatchdogsOrBuilder getWatchdogsOrBuilder()
         Optional watchdogs configuration.
 This is used for specifying different watchdogs for the different subsystems.
 [#extension-category: envoy.guarddog_actions]
        .envoy.config.bootstrap.v3.Watchdogs watchdogs = 27;

      • hasTracing

        @Deprecated
boolean hasTracing()
        Deprecated.
        envoy.config.bootstrap.v3.Bootstrap.tracing is deprecated. See envoy/config/bootstrap/v3/bootstrap.proto;l=205
         Configuration for an external tracing provider.
 .. attention::
  This field has been deprecated in favor of :ref:`HttpConnectionManager.Tracing.provider
  <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing.provider>`.
        .envoy.config.trace.v3.Tracing tracing = 9 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Returns:
        Whether the tracing field is set.

      • getTracing

        @Deprecated
Tracing getTracing()
        Deprecated.
        envoy.config.bootstrap.v3.Bootstrap.tracing is deprecated. See envoy/config/bootstrap/v3/bootstrap.proto;l=205
         Configuration for an external tracing provider.
 .. attention::
  This field has been deprecated in favor of :ref:`HttpConnectionManager.Tracing.provider
  <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing.provider>`.
        .envoy.config.trace.v3.Tracing tracing = 9 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Returns:
        The tracing.

      • getTracingOrBuilder

        @Deprecated
TracingOrBuilder getTracingOrBuilder()
        Deprecated.
         Configuration for an external tracing provider.
 .. attention::
  This field has been deprecated in favor of :ref:`HttpConnectionManager.Tracing.provider
  <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing.provider>`.
        .envoy.config.trace.v3.Tracing tracing = 9 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];

      • 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.v3.LayeredRuntime layered_runtime = 17;
        Returns:
        Whether the layeredRuntime field is set.

      • 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.v3.LayeredRuntime layered_runtime = 17;
        Returns:
        The layeredRuntime.

      • 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.v3.LayeredRuntime layered_runtime = 17;

      • hasAdmin

        boolean hasAdmin()
         Configuration for the local administration HTTP server.
        .envoy.config.bootstrap.v3.Admin admin = 12;
        Returns:
        Whether the admin field is set.

      • getAdmin

        Admin getAdmin()
         Configuration for the local administration HTTP server.
        .envoy.config.bootstrap.v3.Admin admin = 12;
        Returns:
        The admin.

      • getAdminOrBuilder

        AdminOrBuilder getAdminOrBuilder()
         Configuration for the local administration HTTP server.
        .envoy.config.bootstrap.v3.Admin admin = 12;

      • hasOverloadManager

        boolean hasOverloadManager()
         Optional overload manager configuration.
        .envoy.config.overload.v3.OverloadManager overload_manager = 15 [(.udpa.annotations.security) = { ... }
        Returns:
        Whether the overloadManager field is set.

      • getOverloadManager

        OverloadManager getOverloadManager()
         Optional overload manager configuration.
        .envoy.config.overload.v3.OverloadManager overload_manager = 15 [(.udpa.annotations.security) = { ... }
        Returns:
        The overloadManager.

      • getOverloadManagerOrBuilder

        OverloadManagerOrBuilder getOverloadManagerOrBuilder()
         Optional overload manager configuration.
        .envoy.config.overload.v3.OverloadManager overload_manager = 15 [(.udpa.annotations.security) = { ... }

      • 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_v3_api_msg_config.metrics.v3.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;
        Returns:
        The enableDispatcherStats.

      • 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;
        Returns:
        The headerPrefix.

      • 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;
        Returns:
        The bytes for headerPrefix.

      • 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_v3_api_msg_config.metrics.v3.StatsSink>`.
        .google.protobuf.UInt64Value stats_server_version_override = 19;
        Returns:
        Whether the statsServerVersionOverride field is set.

      • 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_v3_api_msg_config.metrics.v3.StatsSink>`.
        .google.protobuf.UInt64Value stats_server_version_override = 19;
        Returns:
        The statsServerVersionOverride.

      • 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_v3_api_msg_config.metrics.v3.StatsSink>`.
        .google.protobuf.UInt64Value stats_server_version_override = 19;

      • getUseTcpForDnsLookups

        @Deprecated
boolean getUseTcpForDnsLookups()
        Deprecated.
        envoy.config.bootstrap.v3.Bootstrap.use_tcp_for_dns_lookups is deprecated. See envoy/config/bootstrap/v3/bootstrap.proto;l=253
         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_v3_api_field_config.cluster.v3.Cluster.dns_resolvers>` and
 :ref:`use_tcp_for_dns_lookups <envoy_v3_api_field_config.cluster.v3.Cluster.use_tcp_for_dns_lookups>` are
 specified.
 This field is deprecated in favor of ``dns_resolution_config``
 which aggregates all of the DNS resolver configuration in a single message.
        bool use_tcp_for_dns_lookups = 20 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Returns:
        The useTcpForDnsLookups.

      • hasDnsResolutionConfig

        @Deprecated
boolean hasDnsResolutionConfig()
        Deprecated.
        envoy.config.bootstrap.v3.Bootstrap.dns_resolution_config is deprecated. See envoy/config/bootstrap/v3/bootstrap.proto;l=262
         DNS resolution configuration which includes the underlying dns resolver addresses and options.
 This may be overridden on a per-cluster basis in cds_config, when
 :ref:`dns_resolution_config <envoy_v3_api_field_config.cluster.v3.Cluster.dns_resolution_config>`
 is specified.
 This field is deprecated in favor of
 :ref:`typed_dns_resolver_config <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.typed_dns_resolver_config>`.
        .envoy.config.core.v3.DnsResolutionConfig dns_resolution_config = 30 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Returns:
        Whether the dnsResolutionConfig field is set.

      • getDnsResolutionConfig

        @Deprecated
DnsResolutionConfig getDnsResolutionConfig()
        Deprecated.
        envoy.config.bootstrap.v3.Bootstrap.dns_resolution_config is deprecated. See envoy/config/bootstrap/v3/bootstrap.proto;l=262
         DNS resolution configuration which includes the underlying dns resolver addresses and options.
 This may be overridden on a per-cluster basis in cds_config, when
 :ref:`dns_resolution_config <envoy_v3_api_field_config.cluster.v3.Cluster.dns_resolution_config>`
 is specified.
 This field is deprecated in favor of
 :ref:`typed_dns_resolver_config <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.typed_dns_resolver_config>`.
        .envoy.config.core.v3.DnsResolutionConfig dns_resolution_config = 30 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Returns:
        The dnsResolutionConfig.

      • getDnsResolutionConfigOrBuilder

        @Deprecated
DnsResolutionConfigOrBuilder getDnsResolutionConfigOrBuilder()
        Deprecated.
         DNS resolution configuration which includes the underlying dns resolver addresses and options.
 This may be overridden on a per-cluster basis in cds_config, when
 :ref:`dns_resolution_config <envoy_v3_api_field_config.cluster.v3.Cluster.dns_resolution_config>`
 is specified.
 This field is deprecated in favor of
 :ref:`typed_dns_resolver_config <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.typed_dns_resolver_config>`.
        .envoy.config.core.v3.DnsResolutionConfig dns_resolution_config = 30 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];

      • hasTypedDnsResolverConfig

        boolean hasTypedDnsResolverConfig()
         DNS resolver type configuration extension. This extension can be used to configure c-ares, apple,
 or any other DNS resolver types and the related parameters.
 For example, an object of
 :ref:`CaresDnsResolverConfig <envoy_v3_api_msg_extensions.network.dns_resolver.cares.v3.CaresDnsResolverConfig>`
 can be packed into this ``typed_dns_resolver_config``. This configuration replaces the
 :ref:`dns_resolution_config <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.dns_resolution_config>`
 configuration.
 During the transition period when both ``dns_resolution_config`` and ``typed_dns_resolver_config`` exists,
 when ``typed_dns_resolver_config`` is in place, Envoy will use it and ignore ``dns_resolution_config``.
 When ``typed_dns_resolver_config`` is missing, the default behavior is in place.
 [#extension-category: envoy.network.dns_resolver]
        .envoy.config.core.v3.TypedExtensionConfig typed_dns_resolver_config = 31;
        Returns:
        Whether the typedDnsResolverConfig field is set.

      • getTypedDnsResolverConfig

        TypedExtensionConfig getTypedDnsResolverConfig()
         DNS resolver type configuration extension. This extension can be used to configure c-ares, apple,
 or any other DNS resolver types and the related parameters.
 For example, an object of
 :ref:`CaresDnsResolverConfig <envoy_v3_api_msg_extensions.network.dns_resolver.cares.v3.CaresDnsResolverConfig>`
 can be packed into this ``typed_dns_resolver_config``. This configuration replaces the
 :ref:`dns_resolution_config <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.dns_resolution_config>`
 configuration.
 During the transition period when both ``dns_resolution_config`` and ``typed_dns_resolver_config`` exists,
 when ``typed_dns_resolver_config`` is in place, Envoy will use it and ignore ``dns_resolution_config``.
 When ``typed_dns_resolver_config`` is missing, the default behavior is in place.
 [#extension-category: envoy.network.dns_resolver]
        .envoy.config.core.v3.TypedExtensionConfig typed_dns_resolver_config = 31;
        Returns:
        The typedDnsResolverConfig.

      • getTypedDnsResolverConfigOrBuilder

        TypedExtensionConfigOrBuilder getTypedDnsResolverConfigOrBuilder()
         DNS resolver type configuration extension. This extension can be used to configure c-ares, apple,
 or any other DNS resolver types and the related parameters.
 For example, an object of
 :ref:`CaresDnsResolverConfig <envoy_v3_api_msg_extensions.network.dns_resolver.cares.v3.CaresDnsResolverConfig>`
 can be packed into this ``typed_dns_resolver_config``. This configuration replaces the
 :ref:`dns_resolution_config <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.dns_resolution_config>`
 configuration.
 During the transition period when both ``dns_resolution_config`` and ``typed_dns_resolver_config`` exists,
 when ``typed_dns_resolver_config`` is in place, Envoy will use it and ignore ``dns_resolution_config``.
 When ``typed_dns_resolver_config`` is missing, the default behavior is in place.
 [#extension-category: envoy.network.dns_resolver]
        .envoy.config.core.v3.TypedExtensionConfig typed_dns_resolver_config = 31;

      • getBootstrapExtensionsList

        List<TypedExtensionConfig> getBootstrapExtensionsList()
         Specifies optional bootstrap extensions to be instantiated at startup time.
 Each item contains extension specific configuration.
 [#extension-category: envoy.bootstrap]
        repeated .envoy.config.core.v3.TypedExtensionConfig bootstrap_extensions = 21;

      • getBootstrapExtensions

        TypedExtensionConfig getBootstrapExtensions​(int index)
         Specifies optional bootstrap extensions to be instantiated at startup time.
 Each item contains extension specific configuration.
 [#extension-category: envoy.bootstrap]
        repeated .envoy.config.core.v3.TypedExtensionConfig bootstrap_extensions = 21;

      • getBootstrapExtensionsCount

        int getBootstrapExtensionsCount()
         Specifies optional bootstrap extensions to be instantiated at startup time.
 Each item contains extension specific configuration.
 [#extension-category: envoy.bootstrap]
        repeated .envoy.config.core.v3.TypedExtensionConfig bootstrap_extensions = 21;

      • getBootstrapExtensionsOrBuilderList

        List<? extends TypedExtensionConfigOrBuilder> getBootstrapExtensionsOrBuilderList()
         Specifies optional bootstrap extensions to be instantiated at startup time.
 Each item contains extension specific configuration.
 [#extension-category: envoy.bootstrap]
        repeated .envoy.config.core.v3.TypedExtensionConfig bootstrap_extensions = 21;

      • getBootstrapExtensionsOrBuilder

        TypedExtensionConfigOrBuilder getBootstrapExtensionsOrBuilder​(int index)
         Specifies optional bootstrap extensions to be instantiated at startup time.
 Each item contains extension specific configuration.
 [#extension-category: envoy.bootstrap]
        repeated .envoy.config.core.v3.TypedExtensionConfig bootstrap_extensions = 21;

      • getFatalActionsList

        List<FatalAction> getFatalActionsList()
         Specifies optional extensions instantiated at startup time and
 invoked during crash time on the request that caused the crash.
        repeated .envoy.config.bootstrap.v3.FatalAction fatal_actions = 28;

      • getFatalActions

        FatalAction getFatalActions​(int index)
         Specifies optional extensions instantiated at startup time and
 invoked during crash time on the request that caused the crash.
        repeated .envoy.config.bootstrap.v3.FatalAction fatal_actions = 28;

      • getFatalActionsCount

        int getFatalActionsCount()
         Specifies optional extensions instantiated at startup time and
 invoked during crash time on the request that caused the crash.
        repeated .envoy.config.bootstrap.v3.FatalAction fatal_actions = 28;

      • getFatalActionsOrBuilderList

        List<? extends FatalActionOrBuilder> getFatalActionsOrBuilderList()
         Specifies optional extensions instantiated at startup time and
 invoked during crash time on the request that caused the crash.
        repeated .envoy.config.bootstrap.v3.FatalAction fatal_actions = 28;

      • getFatalActionsOrBuilder

        FatalActionOrBuilder getFatalActionsOrBuilder​(int index)
         Specifies optional extensions instantiated at startup time and
 invoked during crash time on the request that caused the crash.
        repeated .envoy.config.bootstrap.v3.FatalAction fatal_actions = 28;

      • getConfigSourcesList

        List<ConfigSource> getConfigSourcesList()
         Configuration sources that will participate in
 xdstp:// URL authority resolution. The algorithm is as
 follows:
 1. The authority field is taken from the xdstp:// URL, call
    this ``resource_authority``.
 2. ``resource_authority`` is compared against the authorities in any peer
    ``ConfigSource``. The peer ``ConfigSource`` is the configuration source
    message which would have been used unconditionally for resolution
    with opaque resource names. If there is a match with an authority, the
    peer ``ConfigSource`` message is used.
 3. ``resource_authority`` is compared sequentially with the authorities in
    each configuration source in ``config_sources``. The first ``ConfigSource``
    to match wins.
 4. As a fallback, if no configuration source matches, then
    ``default_config_source`` is used.
 5. If ``default_config_source`` is not specified, resolution fails.
 [#not-implemented-hide:]
        repeated .envoy.config.core.v3.ConfigSource config_sources = 22;

      • getConfigSources

        ConfigSource getConfigSources​(int index)
         Configuration sources that will participate in
 xdstp:// URL authority resolution. The algorithm is as
 follows:
 1. The authority field is taken from the xdstp:// URL, call
    this ``resource_authority``.
 2. ``resource_authority`` is compared against the authorities in any peer
    ``ConfigSource``. The peer ``ConfigSource`` is the configuration source
    message which would have been used unconditionally for resolution
    with opaque resource names. If there is a match with an authority, the
    peer ``ConfigSource`` message is used.
 3. ``resource_authority`` is compared sequentially with the authorities in
    each configuration source in ``config_sources``. The first ``ConfigSource``
    to match wins.
 4. As a fallback, if no configuration source matches, then
    ``default_config_source`` is used.
 5. If ``default_config_source`` is not specified, resolution fails.
 [#not-implemented-hide:]
        repeated .envoy.config.core.v3.ConfigSource config_sources = 22;

      • getConfigSourcesCount

        int getConfigSourcesCount()
         Configuration sources that will participate in
 xdstp:// URL authority resolution. The algorithm is as
 follows:
 1. The authority field is taken from the xdstp:// URL, call
    this ``resource_authority``.
 2. ``resource_authority`` is compared against the authorities in any peer
    ``ConfigSource``. The peer ``ConfigSource`` is the configuration source
    message which would have been used unconditionally for resolution
    with opaque resource names. If there is a match with an authority, the
    peer ``ConfigSource`` message is used.
 3. ``resource_authority`` is compared sequentially with the authorities in
    each configuration source in ``config_sources``. The first ``ConfigSource``
    to match wins.
 4. As a fallback, if no configuration source matches, then
    ``default_config_source`` is used.
 5. If ``default_config_source`` is not specified, resolution fails.
 [#not-implemented-hide:]
        repeated .envoy.config.core.v3.ConfigSource config_sources = 22;

      • getConfigSourcesOrBuilderList

        List<? extends ConfigSourceOrBuilder> getConfigSourcesOrBuilderList()
         Configuration sources that will participate in
 xdstp:// URL authority resolution. The algorithm is as
 follows:
 1. The authority field is taken from the xdstp:// URL, call
    this ``resource_authority``.
 2. ``resource_authority`` is compared against the authorities in any peer
    ``ConfigSource``. The peer ``ConfigSource`` is the configuration source
    message which would have been used unconditionally for resolution
    with opaque resource names. If there is a match with an authority, the
    peer ``ConfigSource`` message is used.
 3. ``resource_authority`` is compared sequentially with the authorities in
    each configuration source in ``config_sources``. The first ``ConfigSource``
    to match wins.
 4. As a fallback, if no configuration source matches, then
    ``default_config_source`` is used.
 5. If ``default_config_source`` is not specified, resolution fails.
 [#not-implemented-hide:]
        repeated .envoy.config.core.v3.ConfigSource config_sources = 22;

      • getConfigSourcesOrBuilder

        ConfigSourceOrBuilder getConfigSourcesOrBuilder​(int index)
         Configuration sources that will participate in
 xdstp:// URL authority resolution. The algorithm is as
 follows:
 1. The authority field is taken from the xdstp:// URL, call
    this ``resource_authority``.
 2. ``resource_authority`` is compared against the authorities in any peer
    ``ConfigSource``. The peer ``ConfigSource`` is the configuration source
    message which would have been used unconditionally for resolution
    with opaque resource names. If there is a match with an authority, the
    peer ``ConfigSource`` message is used.
 3. ``resource_authority`` is compared sequentially with the authorities in
    each configuration source in ``config_sources``. The first ``ConfigSource``
    to match wins.
 4. As a fallback, if no configuration source matches, then
    ``default_config_source`` is used.
 5. If ``default_config_source`` is not specified, resolution fails.
 [#not-implemented-hide:]
        repeated .envoy.config.core.v3.ConfigSource config_sources = 22;

      • hasDefaultConfigSource

        boolean hasDefaultConfigSource()
         Default configuration source for xdstp:// URLs if all
 other resolution fails.
 [#not-implemented-hide:]
        .envoy.config.core.v3.ConfigSource default_config_source = 23;
        Returns:
        Whether the defaultConfigSource field is set.

      • getDefaultConfigSource

        ConfigSource getDefaultConfigSource()
         Default configuration source for xdstp:// URLs if all
 other resolution fails.
 [#not-implemented-hide:]
        .envoy.config.core.v3.ConfigSource default_config_source = 23;
        Returns:
        The defaultConfigSource.

      • getDefaultConfigSourceOrBuilder

        ConfigSourceOrBuilder getDefaultConfigSourceOrBuilder()
         Default configuration source for xdstp:// URLs if all
 other resolution fails.
 [#not-implemented-hide:]
        .envoy.config.core.v3.ConfigSource default_config_source = 23;

      • getDefaultSocketInterface

        String getDefaultSocketInterface()
         Optional overriding of default socket interface. The value must be the name of one of the
 socket interface factories initialized through a bootstrap extension
        string default_socket_interface = 24;
        Returns:
        The defaultSocketInterface.

      • getDefaultSocketInterfaceBytes

        com.google.protobuf.ByteString getDefaultSocketInterfaceBytes()
         Optional overriding of default socket interface. The value must be the name of one of the
 socket interface factories initialized through a bootstrap extension
        string default_socket_interface = 24;
        Returns:
        The bytes for defaultSocketInterface.

      • getCertificateProviderInstancesCount

        int getCertificateProviderInstancesCount()
         Global map of CertificateProvider instances. These instances are referred to by name in the
 :ref:`CommonTlsContext.CertificateProviderInstance.instance_name
 <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CommonTlsContext.CertificateProviderInstance.instance_name>`
 field.
 [#not-implemented-hide:]
        map<string, .envoy.config.core.v3.TypedExtensionConfig> certificate_provider_instances = 25;

      • containsCertificateProviderInstances

        boolean containsCertificateProviderInstances​(String key)
         Global map of CertificateProvider instances. These instances are referred to by name in the
 :ref:`CommonTlsContext.CertificateProviderInstance.instance_name
 <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CommonTlsContext.CertificateProviderInstance.instance_name>`
 field.
 [#not-implemented-hide:]
        map<string, .envoy.config.core.v3.TypedExtensionConfig> certificate_provider_instances = 25;

      • getCertificateProviderInstancesMap

        Map<String,​TypedExtensionConfig> getCertificateProviderInstancesMap()
         Global map of CertificateProvider instances. These instances are referred to by name in the
 :ref:`CommonTlsContext.CertificateProviderInstance.instance_name
 <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CommonTlsContext.CertificateProviderInstance.instance_name>`
 field.
 [#not-implemented-hide:]
        map<string, .envoy.config.core.v3.TypedExtensionConfig> certificate_provider_instances = 25;

      • getCertificateProviderInstancesOrDefault

        TypedExtensionConfig getCertificateProviderInstancesOrDefault​(String key,
                                                              TypedExtensionConfig defaultValue)
         Global map of CertificateProvider instances. These instances are referred to by name in the
 :ref:`CommonTlsContext.CertificateProviderInstance.instance_name
 <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CommonTlsContext.CertificateProviderInstance.instance_name>`
 field.
 [#not-implemented-hide:]
        map<string, .envoy.config.core.v3.TypedExtensionConfig> certificate_provider_instances = 25;

      • getCertificateProviderInstancesOrThrow

        TypedExtensionConfig getCertificateProviderInstancesOrThrow​(String key)
         Global map of CertificateProvider instances. These instances are referred to by name in the
 :ref:`CommonTlsContext.CertificateProviderInstance.instance_name
 <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CommonTlsContext.CertificateProviderInstance.instance_name>`
 field.
 [#not-implemented-hide:]
        map<string, .envoy.config.core.v3.TypedExtensionConfig> certificate_provider_instances = 25;

      • getInlineHeadersList

        List<CustomInlineHeader> getInlineHeadersList()
         Specifies a set of headers that need to be registered as inline header. This configuration
 allows users to customize the inline headers on-demand at Envoy startup without modifying
 Envoy's source code.
 Note that the 'set-cookie' header cannot be registered as inline header.
        repeated .envoy.config.bootstrap.v3.CustomInlineHeader inline_headers = 32;

      • getInlineHeaders

        CustomInlineHeader getInlineHeaders​(int index)
         Specifies a set of headers that need to be registered as inline header. This configuration
 allows users to customize the inline headers on-demand at Envoy startup without modifying
 Envoy's source code.
 Note that the 'set-cookie' header cannot be registered as inline header.
        repeated .envoy.config.bootstrap.v3.CustomInlineHeader inline_headers = 32;

      • getInlineHeadersCount

        int getInlineHeadersCount()
         Specifies a set of headers that need to be registered as inline header. This configuration
 allows users to customize the inline headers on-demand at Envoy startup without modifying
 Envoy's source code.
 Note that the 'set-cookie' header cannot be registered as inline header.
        repeated .envoy.config.bootstrap.v3.CustomInlineHeader inline_headers = 32;

      • getInlineHeadersOrBuilderList

        List<? extends CustomInlineHeaderOrBuilder> getInlineHeadersOrBuilderList()
         Specifies a set of headers that need to be registered as inline header. This configuration
 allows users to customize the inline headers on-demand at Envoy startup without modifying
 Envoy's source code.
 Note that the 'set-cookie' header cannot be registered as inline header.
        repeated .envoy.config.bootstrap.v3.CustomInlineHeader inline_headers = 32;

      • getInlineHeadersOrBuilder

        CustomInlineHeaderOrBuilder getInlineHeadersOrBuilder​(int index)
         Specifies a set of headers that need to be registered as inline header. This configuration
 allows users to customize the inline headers on-demand at Envoy startup without modifying
 Envoy's source code.
 Note that the 'set-cookie' header cannot be registered as inline header.
        repeated .envoy.config.bootstrap.v3.CustomInlineHeader inline_headers = 32;

      • getPerfTracingFilePath

        String getPerfTracingFilePath()
         Optional path to a file with performance tracing data created by "Perfetto" SDK in binary
 ProtoBuf format. The default value is "envoy.pftrace".
        string perf_tracing_file_path = 33;
        Returns:
        The perfTracingFilePath.

      • getPerfTracingFilePathBytes

        com.google.protobuf.ByteString getPerfTracingFilePathBytes()
         Optional path to a file with performance tracing data created by "Perfetto" SDK in binary
 ProtoBuf format. The default value is "envoy.pftrace".
        string perf_tracing_file_path = 33;
        Returns:
        The bytes for perfTracingFilePath.

      • hasDefaultRegexEngine

        boolean hasDefaultRegexEngine()
         Optional overriding of default regex engine.
 If the value is not specified, Google RE2 will be used by default.
 [#extension-category: envoy.regex_engines]
        .envoy.config.core.v3.TypedExtensionConfig default_regex_engine = 34;
        Returns:
        Whether the defaultRegexEngine field is set.

      • getDefaultRegexEngine

        TypedExtensionConfig getDefaultRegexEngine()
         Optional overriding of default regex engine.
 If the value is not specified, Google RE2 will be used by default.
 [#extension-category: envoy.regex_engines]
        .envoy.config.core.v3.TypedExtensionConfig default_regex_engine = 34;
        Returns:
        The defaultRegexEngine.

      • getDefaultRegexEngineOrBuilder

        TypedExtensionConfigOrBuilder getDefaultRegexEngineOrBuilder()
         Optional overriding of default regex engine.
 If the value is not specified, Google RE2 will be used by default.
 [#extension-category: envoy.regex_engines]
        .envoy.config.core.v3.TypedExtensionConfig default_regex_engine = 34;