Package io.envoyproxy.envoy.api.v2.core
Class ConfigSource
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.api.v2.core.ConfigSource
- All Implemented Interfaces:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,ConfigSourceOrBuilder,Serializable
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_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: 7]Protobuf type
envoy.api.v2.core.ConfigSource- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classConfiguration for :ref:`listeners <config_listeners>`, :ref:`clusters <config_cluster_manager>`, :ref:`routes <envoy_api_msg_RouteConfiguration>`, :ref:`endpoints <arch_overview_service_discovery>` etc. may either be sourced from the filesystem or from an xDS API source.static enumNested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleangetAds()When set, ADS will be used to fetch resources.When set, ADS will be used to fetch resources.API configuration source.API configuration source.static ConfigSourcestatic final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.DurationWhen 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.DurationOrBuilderWhen 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>getPath()Path on the filesystem to source and watch for configuration updates.com.google.protobuf.ByteStringPath on the filesystem to source and watch for configuration updates.API version for xDS resources.intAPI 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.intbooleanhasAds()When set, ADS will be used to fetch resources.booleanAPI configuration source.inthashCode()booleanWhen 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>`.booleanhasPath()Path on the filesystem to source and watch for configuration updates.booleanhasSelf()[#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.FieldAccessorTablefinal booleanstatic ConfigSource.Builderstatic ConfigSource.BuildernewBuilder(ConfigSource prototype) protected ConfigSource.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static ConfigSourceparseDelimitedFrom(InputStream input) static ConfigSourceparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ConfigSourceparseFrom(byte[] data) static ConfigSourceparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ConfigSourceparseFrom(com.google.protobuf.ByteString data) static ConfigSourceparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ConfigSourceparseFrom(com.google.protobuf.CodedInputStream input) static ConfigSourceparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ConfigSourceparseFrom(InputStream input) static ConfigSourceparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ConfigSourceparseFrom(ByteBuffer data) static ConfigSourceparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<ConfigSource>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
PATH_FIELD_NUMBER
public static final int PATH_FIELD_NUMBER- See Also:
-
API_CONFIG_SOURCE_FIELD_NUMBER
public static final int API_CONFIG_SOURCE_FIELD_NUMBER- See Also:
-
ADS_FIELD_NUMBER
public static final int ADS_FIELD_NUMBER- See Also:
-
SELF_FIELD_NUMBER
public static final int SELF_FIELD_NUMBER- See Also:
-
INITIAL_FETCH_TIMEOUT_FIELD_NUMBER
public static final int INITIAL_FETCH_TIMEOUT_FIELD_NUMBER- See Also:
-
RESOURCE_API_VERSION_FIELD_NUMBER
public static final int RESOURCE_API_VERSION_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
getConfigSourceSpecifierCase
- Specified by:
getConfigSourceSpecifierCasein interfaceConfigSourceOrBuilder
-
hasPath
public boolean hasPath()Path on the filesystem to source and watch for configuration updates. When sourcing configuration for :ref:`secret <envoy_api_msg_auth.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;- Specified by:
hasPathin interfaceConfigSourceOrBuilder- Returns:
- Whether the path field is set.
-
getPath
Path on the filesystem to source and watch for configuration updates. When sourcing configuration for :ref:`secret <envoy_api_msg_auth.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;- Specified by:
getPathin interfaceConfigSourceOrBuilder- Returns:
- The path.
-
getPathBytes
public 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_auth.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;- Specified by:
getPathBytesin interfaceConfigSourceOrBuilder- Returns:
- The bytes for path.
-
hasApiConfigSource
public boolean hasApiConfigSource()API configuration source.
.envoy.api.v2.core.ApiConfigSource api_config_source = 2;- Specified by:
hasApiConfigSourcein interfaceConfigSourceOrBuilder- Returns:
- Whether the apiConfigSource field is set.
-
getApiConfigSource
API configuration source.
.envoy.api.v2.core.ApiConfigSource api_config_source = 2;- Specified by:
getApiConfigSourcein interfaceConfigSourceOrBuilder- Returns:
- The apiConfigSource.
-
getApiConfigSourceOrBuilder
API configuration source.
.envoy.api.v2.core.ApiConfigSource api_config_source = 2;- Specified by:
getApiConfigSourceOrBuilderin interfaceConfigSourceOrBuilder
-
hasAds
public boolean hasAds()When set, ADS will be used to fetch resources. The ADS API configuration source in the bootstrap configuration is used.
.envoy.api.v2.core.AggregatedConfigSource ads = 3;- Specified by:
hasAdsin interfaceConfigSourceOrBuilder- Returns:
- Whether the ads field is set.
-
getAds
When set, ADS will be used to fetch resources. The ADS API configuration source in the bootstrap configuration is used.
.envoy.api.v2.core.AggregatedConfigSource ads = 3;- Specified by:
getAdsin interfaceConfigSourceOrBuilder- Returns:
- The ads.
-
getAdsOrBuilder
When set, ADS will be used to fetch resources. The ADS API configuration source in the bootstrap configuration is used.
.envoy.api.v2.core.AggregatedConfigSource ads = 3;- Specified by:
getAdsOrBuilderin interfaceConfigSourceOrBuilder
-
hasSelf
public 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.api.v2.core.SelfConfigSource self = 5;- Specified by:
hasSelfin interfaceConfigSourceOrBuilder- Returns:
- Whether the self field is set.
-
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.api.v2.core.SelfConfigSource self = 5;- Specified by:
getSelfin interfaceConfigSourceOrBuilder- Returns:
- The self.
-
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.api.v2.core.SelfConfigSource self = 5;- Specified by:
getSelfOrBuilderin interfaceConfigSourceOrBuilder
-
hasInitialFetchTimeout
public 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;- Specified by:
hasInitialFetchTimeoutin interfaceConfigSourceOrBuilder- Returns:
- Whether the initialFetchTimeout field is set.
-
getInitialFetchTimeout
public 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;- Specified by:
getInitialFetchTimeoutin interfaceConfigSourceOrBuilder- Returns:
- The initialFetchTimeout.
-
getInitialFetchTimeoutOrBuilder
public 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;- Specified by:
getInitialFetchTimeoutOrBuilderin interfaceConfigSourceOrBuilder
-
getResourceApiVersionValue
public 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.api.v2.core.ApiVersion resource_api_version = 6 [(.validate.rules) = { ... }- Specified by:
getResourceApiVersionValuein interfaceConfigSourceOrBuilder- Returns:
- The enum numeric value on the wire for resourceApiVersion.
-
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.api.v2.core.ApiVersion resource_api_version = 6 [(.validate.rules) = { ... }- Specified by:
getResourceApiVersionin interfaceConfigSourceOrBuilder- Returns:
- The resourceApiVersion.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static ConfigSource parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ConfigSource parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ConfigSource parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ConfigSource parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ConfigSource parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ConfigSource parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static ConfigSource parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static ConfigSource parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static ConfigSource parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected ConfigSource.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-