public final class ConfigSource extends com.google.protobuf.GeneratedMessageV3 implements ConfigSourceOrBuilder
Configuration for :ref:`listeners <config_listeners>`, :ref:`clusters <config_cluster_manager>`, :ref:`routes <envoy_api_msg_config.route.v3.RouteConfiguration>`, :ref:`endpoints <arch_overview_service_discovery>` etc. may either be sourced from the filesystem or from an xDS API source. Filesystem configs are watched with inotify for updates. [#next-free-field: 8]Protobuf type
envoy.config.core.v3.ConfigSource| Modifier and Type | Class and Description |
|---|---|
static class |
ConfigSource.Builder
Configuration for :ref:`listeners <config_listeners>`, :ref:`clusters
<config_cluster_manager>`, :ref:`routes
<envoy_api_msg_config.route.v3.RouteConfiguration>`, :ref:`endpoints
<arch_overview_service_discovery>` etc. may either be sourced from the
filesystem or from an xDS API source.
|
static class |
ConfigSource.ConfigSourceSpecifierCase |
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
ADS_FIELD_NUMBER |
static int |
API_CONFIG_SOURCE_FIELD_NUMBER |
static int |
AUTHORITIES_FIELD_NUMBER |
static int |
INITIAL_FETCH_TIMEOUT_FIELD_NUMBER |
static int |
PATH_FIELD_NUMBER |
static int |
RESOURCE_API_VERSION_FIELD_NUMBER |
static int |
SELF_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
AggregatedConfigSource |
getAds()
When set, ADS will be used to fetch resources.
|
AggregatedConfigSourceOrBuilder |
getAdsOrBuilder()
When set, ADS will be used to fetch resources.
|
ApiConfigSource |
getApiConfigSource()
API configuration source.
|
ApiConfigSourceOrBuilder |
getApiConfigSourceOrBuilder()
API configuration source.
|
Authority |
getAuthorities(int index)
Authorities that this config source may be used for.
|
int |
getAuthoritiesCount()
Authorities that this config source may be used for.
|
List<Authority> |
getAuthoritiesList()
Authorities that this config source may be used for.
|
AuthorityOrBuilder |
getAuthoritiesOrBuilder(int index)
Authorities that this config source may be used for.
|
List<? extends AuthorityOrBuilder> |
getAuthoritiesOrBuilderList()
Authorities that this config source may be used for.
|
ConfigSource.ConfigSourceSpecifierCase |
getConfigSourceSpecifierCase() |
static ConfigSource |
getDefaultInstance() |
ConfigSource |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
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>`.
|
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>`.
|
com.google.protobuf.Parser<ConfigSource> |
getParserForType() |
String |
getPath()
Path on the filesystem to source and watch for configuration updates.
|
com.google.protobuf.ByteString |
getPathBytes()
Path on the filesystem to source and watch for configuration updates.
|
ApiVersion |
getResourceApiVersion()
API version for xDS resources.
|
int |
getResourceApiVersionValue()
API version for xDS resources.
|
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.
|
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.
|
int |
getSerializedSize() |
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
boolean |
hasAds()
When set, ADS will be used to fetch resources.
|
boolean |
hasApiConfigSource()
API configuration source.
|
int |
hashCode() |
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>`.
|
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.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static ConfigSource.Builder |
newBuilder() |
static ConfigSource.Builder |
newBuilder(ConfigSource prototype) |
ConfigSource.Builder |
newBuilderForType() |
protected ConfigSource.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static ConfigSource |
parseDelimitedFrom(InputStream input) |
static ConfigSource |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ConfigSource |
parseFrom(byte[] data) |
static ConfigSource |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ConfigSource |
parseFrom(ByteBuffer data) |
static ConfigSource |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ConfigSource |
parseFrom(com.google.protobuf.ByteString data) |
static ConfigSource |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ConfigSource |
parseFrom(com.google.protobuf.CodedInputStream input) |
static ConfigSource |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ConfigSource |
parseFrom(InputStream input) |
static ConfigSource |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<ConfigSource> |
parser() |
ConfigSource.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int AUTHORITIES_FIELD_NUMBER
public static final int PATH_FIELD_NUMBER
public static final int API_CONFIG_SOURCE_FIELD_NUMBER
public static final int ADS_FIELD_NUMBER
public static final int SELF_FIELD_NUMBER
public static final int INITIAL_FETCH_TIMEOUT_FIELD_NUMBER
public static final int RESOURCE_API_VERSION_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public ConfigSource.ConfigSourceSpecifierCase getConfigSourceSpecifierCase()
getConfigSourceSpecifierCase in interface ConfigSourceOrBuilderpublic List<Authority> 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;getAuthoritiesList in interface ConfigSourceOrBuilderpublic 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;getAuthoritiesOrBuilderList in interface ConfigSourceOrBuilderpublic 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;getAuthoritiesCount in interface ConfigSourceOrBuilderpublic Authority getAuthorities(int index)
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 in interface ConfigSourceOrBuilderpublic AuthorityOrBuilder getAuthoritiesOrBuilder(int index)
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 in interface ConfigSourceOrBuilderpublic String getPath()
Path on the filesystem to source and watch for configuration updates. When sourcing configuration for :ref:`secret <envoy_api_msg_extensions.transport_sockets.tls.v3.Secret>`, the certificate and key files are also watched for updates. .. note:: The path to the source must exist at config load time. .. note:: Envoy will only watch the file path for *moves.* This is because in general only moves are atomic. The same method of swapping files as is demonstrated in the :ref:`runtime documentation <config_runtime_symbolic_link_swap>` can be used here also.
string path = 1;getPath in interface ConfigSourceOrBuilderpublic com.google.protobuf.ByteString getPathBytes()
Path on the filesystem to source and watch for configuration updates. When sourcing configuration for :ref:`secret <envoy_api_msg_extensions.transport_sockets.tls.v3.Secret>`, the certificate and key files are also watched for updates. .. note:: The path to the source must exist at config load time. .. note:: Envoy will only watch the file path for *moves.* This is because in general only moves are atomic. The same method of swapping files as is demonstrated in the :ref:`runtime documentation <config_runtime_symbolic_link_swap>` can be used here also.
string path = 1;getPathBytes in interface ConfigSourceOrBuilderpublic boolean hasApiConfigSource()
API configuration source.
.envoy.config.core.v3.ApiConfigSource api_config_source = 2;hasApiConfigSource in interface ConfigSourceOrBuilderpublic ApiConfigSource getApiConfigSource()
API configuration source.
.envoy.config.core.v3.ApiConfigSource api_config_source = 2;getApiConfigSource in interface ConfigSourceOrBuilderpublic ApiConfigSourceOrBuilder getApiConfigSourceOrBuilder()
API configuration source.
.envoy.config.core.v3.ApiConfigSource api_config_source = 2;getApiConfigSourceOrBuilder in interface ConfigSourceOrBuilderpublic 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;hasAds in interface ConfigSourceOrBuilderpublic 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;getAds in interface ConfigSourceOrBuilderpublic 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;getAdsOrBuilder in interface ConfigSourceOrBuilderpublic 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_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;hasSelf in interface ConfigSourceOrBuilderpublic 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_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;getSelf in interface ConfigSourceOrBuilderpublic 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_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;getSelfOrBuilder in interface ConfigSourceOrBuilderpublic 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;hasInitialFetchTimeout in interface ConfigSourceOrBuilderpublic 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;getInitialFetchTimeout in interface ConfigSourceOrBuilderpublic 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;getInitialFetchTimeoutOrBuilder in interface ConfigSourceOrBuilderpublic 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) = { ... }getResourceApiVersionValue in interface ConfigSourceOrBuilderpublic 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) = { ... }getResourceApiVersion in interface ConfigSourceOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static ConfigSource parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ConfigSource parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ConfigSource parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ConfigSource parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ConfigSource parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ConfigSource parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ConfigSource parseFrom(InputStream input) throws IOException
IOExceptionpublic static ConfigSource parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ConfigSource parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static ConfigSource parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ConfigSource parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static ConfigSource parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic ConfigSource.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static ConfigSource.Builder newBuilder()
public static ConfigSource.Builder newBuilder(ConfigSource prototype)
public ConfigSource.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected ConfigSource.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static ConfigSource getDefaultInstance()
public static com.google.protobuf.Parser<ConfigSource> parser()
public com.google.protobuf.Parser<ConfigSource> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public ConfigSource getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2018–2021 The Envoy Project. All rights reserved.