Package io.envoyproxy.envoy.api.v2.core

Class 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:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ConfigSource.Builder
      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.
      static class  ConfigSource.ConfigSourceSpecifierCase  

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        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

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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:
        hasPath in interface ConfigSourceOrBuilder
        Returns:
        Whether the path field is set.

      • getPath

        public String 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:
        getPath in interface ConfigSourceOrBuilder
        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:
        getPathBytes in interface ConfigSourceOrBuilder
        Returns:
        The bytes for path.

      • hasApiConfigSource

        public boolean hasApiConfigSource()
         API configuration source.
        .envoy.api.v2.core.ApiConfigSource api_config_source = 2;
        Specified by:
        hasApiConfigSource in interface ConfigSourceOrBuilder
        Returns:
        Whether the apiConfigSource field is set.

      • 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:
        hasAds in interface ConfigSourceOrBuilder
        Returns:
        Whether the ads field is set.

      • getAds

        public AggregatedConfigSource 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:
        getAds in interface ConfigSourceOrBuilder
        Returns:
        The ads.

      • 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:
        hasSelf in interface ConfigSourceOrBuilder
        Returns:
        Whether the self field is set.

      • getSelf

        public 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.api.v2.core.SelfConfigSource self = 5;
        Specified by:
        getSelf in interface ConfigSourceOrBuilder
        Returns:
        The self.

      • getSelfOrBuilder

        public 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.api.v2.core.SelfConfigSource self = 5;
        Specified by:
        getSelfOrBuilder in interface ConfigSourceOrBuilder

      • 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:
        hasInitialFetchTimeout in interface ConfigSourceOrBuilder
        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:
        getInitialFetchTimeout in interface ConfigSourceOrBuilder
        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:
        getInitialFetchTimeoutOrBuilder in interface ConfigSourceOrBuilder

      • 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:
        getResourceApiVersionValue in interface ConfigSourceOrBuilder
        Returns:
        The enum numeric value on the wire for resourceApiVersion.

      • getResourceApiVersion

        public 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.api.v2.core.ApiVersion resource_api_version = 6 [(.validate.rules) = { ... }
        Specified by:
        getResourceApiVersion in interface ConfigSourceOrBuilder
        Returns:
        The resourceApiVersion.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.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

        public static ConfigSource parseFrom​(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException
        Throws:
        IOException

      • newBuilderForType

        public ConfigSource.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public ConfigSource.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ConfigSource.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static ConfigSource getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<ConfigSource> parser()

      • getParserForType

        public com.google.protobuf.Parser<ConfigSource> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public ConfigSource getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder