Interface ConfigSourceOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
ConfigSource
,ConfigSource.Builder
public interface ConfigSourceOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptiongetAds()
When set, ADS will be used to fetch resources.When set, ADS will be used to fetch resources.API configuration source.API configuration source.getAuthorities
(int index) Authorities that this config source may be used for.int
Authorities that this config source may be used for.Authorities that this config source may be used for.getAuthoritiesOrBuilder
(int index) Authorities that this config source may be used for.List
<? extends AuthorityOrBuilder> Authorities that this config source may be used for.com.google.protobuf.Duration
When this timeout is specified, Envoy will wait no longer than the specified time for first config response on this xDS subscription during the :ref:`initialization process <arch_overview_initialization>`.com.google.protobuf.DurationOrBuilder
When this timeout is specified, Envoy will wait no longer than the specified time for first config response on this xDS subscription during the :ref:`initialization process <arch_overview_initialization>`.getPath()
Deprecated.envoy.config.core.v3.ConfigSource.path is deprecated.com.google.protobuf.ByteString
Deprecated.envoy.config.core.v3.ConfigSource.path is deprecated.Local filesystem path configuration source.Local filesystem path configuration source.API version for xDS resources.int
API version for xDS resources.getSelf()
[#not-implemented-hide:] When set, the client will access the resources from the same server it got the ConfigSource from, although not necessarily from the same stream.[#not-implemented-hide:] When set, the client will access the resources from the same server it got the ConfigSource from, although not necessarily from the same stream.boolean
hasAds()
When set, ADS will be used to fetch resources.boolean
API configuration source.boolean
When this timeout is specified, Envoy will wait no longer than the specified time for first config response on this xDS subscription during the :ref:`initialization process <arch_overview_initialization>`.boolean
hasPath()
Deprecated.envoy.config.core.v3.ConfigSource.path is deprecated.boolean
Local filesystem path configuration source.boolean
hasSelf()
[#not-implemented-hide:] When set, the client will access the resources from the same server it got the ConfigSource from, although not necessarily from the same stream.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getAuthoritiesList
Authorities that this config source may be used for. An authority specified in a xdstp:// URL is resolved to a ``ConfigSource`` prior to configuration fetch. This field provides the association between authority name and configuration source. [#not-implemented-hide:]
repeated .xds.core.v3.Authority authorities = 7;
-
getAuthorities
Authorities that this config source may be used for. An authority specified in a xdstp:// URL is resolved to a ``ConfigSource`` prior to configuration fetch. This field provides the association between authority name and configuration source. [#not-implemented-hide:]
repeated .xds.core.v3.Authority authorities = 7;
-
getAuthoritiesCount
int getAuthoritiesCount()Authorities that this config source may be used for. An authority specified in a xdstp:// URL is resolved to a ``ConfigSource`` prior to configuration fetch. This field provides the association between authority name and configuration source. [#not-implemented-hide:]
repeated .xds.core.v3.Authority authorities = 7;
-
getAuthoritiesOrBuilderList
List<? extends AuthorityOrBuilder> getAuthoritiesOrBuilderList()Authorities that this config source may be used for. An authority specified in a xdstp:// URL is resolved to a ``ConfigSource`` prior to configuration fetch. This field provides the association between authority name and configuration source. [#not-implemented-hide:]
repeated .xds.core.v3.Authority authorities = 7;
-
getAuthoritiesOrBuilder
Authorities that this config source may be used for. An authority specified in a xdstp:// URL is resolved to a ``ConfigSource`` prior to configuration fetch. This field provides the association between authority name and configuration source. [#not-implemented-hide:]
repeated .xds.core.v3.Authority authorities = 7;
-
hasPath
Deprecated.envoy.config.core.v3.ConfigSource.path is deprecated. See envoy/config/core/v3/config_source.proto;l=213Deprecated in favor of ``path_config_source``. Use that field instead.
string path = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Returns:
- Whether the path field is set.
-
getPath
Deprecated.envoy.config.core.v3.ConfigSource.path is deprecated. See envoy/config/core/v3/config_source.proto;l=213Deprecated in favor of ``path_config_source``. Use that field instead.
string path = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Returns:
- The path.
-
getPathBytes
Deprecated.envoy.config.core.v3.ConfigSource.path is deprecated. See envoy/config/core/v3/config_source.proto;l=213Deprecated in favor of ``path_config_source``. Use that field instead.
string path = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Returns:
- The bytes for path.
-
hasPathConfigSource
boolean hasPathConfigSource()Local filesystem path configuration source.
.envoy.config.core.v3.PathConfigSource path_config_source = 8;
- Returns:
- Whether the pathConfigSource field is set.
-
getPathConfigSource
PathConfigSource getPathConfigSource()Local filesystem path configuration source.
.envoy.config.core.v3.PathConfigSource path_config_source = 8;
- Returns:
- The pathConfigSource.
-
getPathConfigSourceOrBuilder
PathConfigSourceOrBuilder getPathConfigSourceOrBuilder()Local filesystem path configuration source.
.envoy.config.core.v3.PathConfigSource path_config_source = 8;
-
hasApiConfigSource
boolean hasApiConfigSource()API configuration source.
.envoy.config.core.v3.ApiConfigSource api_config_source = 2;
- Returns:
- Whether the apiConfigSource field is set.
-
getApiConfigSource
ApiConfigSource getApiConfigSource()API configuration source.
.envoy.config.core.v3.ApiConfigSource api_config_source = 2;
- Returns:
- The apiConfigSource.
-
getApiConfigSourceOrBuilder
ApiConfigSourceOrBuilder getApiConfigSourceOrBuilder()API configuration source.
.envoy.config.core.v3.ApiConfigSource api_config_source = 2;
-
hasAds
boolean hasAds()When set, ADS will be used to fetch resources. The ADS API configuration source in the bootstrap configuration is used.
.envoy.config.core.v3.AggregatedConfigSource ads = 3;
- Returns:
- Whether the ads field is set.
-
getAds
AggregatedConfigSource getAds()When set, ADS will be used to fetch resources. The ADS API configuration source in the bootstrap configuration is used.
.envoy.config.core.v3.AggregatedConfigSource ads = 3;
- Returns:
- The ads.
-
getAdsOrBuilder
AggregatedConfigSourceOrBuilder getAdsOrBuilder()When set, ADS will be used to fetch resources. The ADS API configuration source in the bootstrap configuration is used.
.envoy.config.core.v3.AggregatedConfigSource ads = 3;
-
hasSelf
boolean hasSelf()[#not-implemented-hide:] When set, the client will access the resources from the same server it got the ConfigSource from, although not necessarily from the same stream. This is similar to the :ref:`ads<envoy_v3_api_field.ConfigSource.ads>` field, except that the client may use a different stream to the same server. As a result, this field can be used for things like LRS that cannot be sent on an ADS stream. It can also be used to link from (e.g.) LDS to RDS on the same server without requiring the management server to know its name or required credentials. [#next-major-version: In xDS v3, consider replacing the ads field with this one, since this field can implicitly mean to use the same stream in the case where the ConfigSource is provided via ADS and the specified data can also be obtained via ADS.]
.envoy.config.core.v3.SelfConfigSource self = 5;
- Returns:
- Whether the self field is set.
-
getSelf
SelfConfigSource getSelf()[#not-implemented-hide:] When set, the client will access the resources from the same server it got the ConfigSource from, although not necessarily from the same stream. This is similar to the :ref:`ads<envoy_v3_api_field.ConfigSource.ads>` field, except that the client may use a different stream to the same server. As a result, this field can be used for things like LRS that cannot be sent on an ADS stream. It can also be used to link from (e.g.) LDS to RDS on the same server without requiring the management server to know its name or required credentials. [#next-major-version: In xDS v3, consider replacing the ads field with this one, since this field can implicitly mean to use the same stream in the case where the ConfigSource is provided via ADS and the specified data can also be obtained via ADS.]
.envoy.config.core.v3.SelfConfigSource self = 5;
- Returns:
- The self.
-
getSelfOrBuilder
SelfConfigSourceOrBuilder getSelfOrBuilder()[#not-implemented-hide:] When set, the client will access the resources from the same server it got the ConfigSource from, although not necessarily from the same stream. This is similar to the :ref:`ads<envoy_v3_api_field.ConfigSource.ads>` field, except that the client may use a different stream to the same server. As a result, this field can be used for things like LRS that cannot be sent on an ADS stream. It can also be used to link from (e.g.) LDS to RDS on the same server without requiring the management server to know its name or required credentials. [#next-major-version: In xDS v3, consider replacing the ads field with this one, since this field can implicitly mean to use the same stream in the case where the ConfigSource is provided via ADS and the specified data can also be obtained via ADS.]
.envoy.config.core.v3.SelfConfigSource self = 5;
-
hasInitialFetchTimeout
boolean hasInitialFetchTimeout()When this timeout is specified, Envoy will wait no longer than the specified time for first config response on this xDS subscription during the :ref:`initialization process <arch_overview_initialization>`. After reaching the timeout, Envoy will move to the next initialization phase, even if the first config is not delivered yet. The timer is activated when the xDS API subscription starts, and is disarmed on first config update or on error. 0 means no timeout - Envoy will wait indefinitely for the first xDS config (unless another timeout applies). The default is 15s.
.google.protobuf.Duration initial_fetch_timeout = 4;
- Returns:
- Whether the initialFetchTimeout field is set.
-
getInitialFetchTimeout
com.google.protobuf.Duration getInitialFetchTimeout()When this timeout is specified, Envoy will wait no longer than the specified time for first config response on this xDS subscription during the :ref:`initialization process <arch_overview_initialization>`. After reaching the timeout, Envoy will move to the next initialization phase, even if the first config is not delivered yet. The timer is activated when the xDS API subscription starts, and is disarmed on first config update or on error. 0 means no timeout - Envoy will wait indefinitely for the first xDS config (unless another timeout applies). The default is 15s.
.google.protobuf.Duration initial_fetch_timeout = 4;
- Returns:
- The initialFetchTimeout.
-
getInitialFetchTimeoutOrBuilder
com.google.protobuf.DurationOrBuilder getInitialFetchTimeoutOrBuilder()When this timeout is specified, Envoy will wait no longer than the specified time for first config response on this xDS subscription during the :ref:`initialization process <arch_overview_initialization>`. After reaching the timeout, Envoy will move to the next initialization phase, even if the first config is not delivered yet. The timer is activated when the xDS API subscription starts, and is disarmed on first config update or on error. 0 means no timeout - Envoy will wait indefinitely for the first xDS config (unless another timeout applies). The default is 15s.
.google.protobuf.Duration initial_fetch_timeout = 4;
-
getResourceApiVersionValue
int getResourceApiVersionValue()API version for xDS resources. This implies the type URLs that the client will request for resources and the resource type that the client will in turn expect to be delivered.
.envoy.config.core.v3.ApiVersion resource_api_version = 6 [(.validate.rules) = { ... }
- Returns:
- The enum numeric value on the wire for resourceApiVersion.
-
getResourceApiVersion
ApiVersion getResourceApiVersion()API version for xDS resources. This implies the type URLs that the client will request for resources and the resource type that the client will in turn expect to be delivered.
.envoy.config.core.v3.ApiVersion resource_api_version = 6 [(.validate.rules) = { ... }
- Returns:
- The resourceApiVersion.
-
getConfigSourceSpecifierCase
ConfigSource.ConfigSourceSpecifierCase getConfigSourceSpecifierCase()
-