Class ConfigSource

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ConfigSourceOrBuilder, java.io.Serializable

    public final class ConfigSource
    extends com.google.protobuf.GeneratedMessage
    implements ConfigSourceOrBuilder
     Configuration for :ref:`listeners <config_listeners>`, :ref:`clusters
     <config_cluster_manager>`, :ref:`routes
     <envoy_v3_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: 9]
     
    Protobuf type envoy.config.core.v3.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_v3_api_msg_config.route.v3.RouteConfiguration>`, :ref:`endpoints <arch_overview_service_discovery>` etc.
      static class  ConfigSource.ConfigSourceSpecifierCase  
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

        com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,​T extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private ConfigSource()  
      private ConfigSource​(com.google.protobuf.GeneratedMessage.Builder<?> builder)  
    • Field Detail

      • bitField0_

        private int bitField0_
      • configSourceSpecifierCase_

        private int configSourceSpecifierCase_
      • configSourceSpecifier_

        private java.lang.Object configSourceSpecifier_
      • AUTHORITIES_FIELD_NUMBER

        public static final int AUTHORITIES_FIELD_NUMBER
        See Also:
        Constant Field Values
      • authorities_

        private java.util.List<Authority> authorities_
      • PATH_CONFIG_SOURCE_FIELD_NUMBER

        public static final int PATH_CONFIG_SOURCE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • API_CONFIG_SOURCE_FIELD_NUMBER

        public static final int API_CONFIG_SOURCE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • INITIAL_FETCH_TIMEOUT_FIELD_NUMBER

        public static final int INITIAL_FETCH_TIMEOUT_FIELD_NUMBER
        See Also:
        Constant Field Values
      • initialFetchTimeout_

        private com.google.protobuf.Duration initialFetchTimeout_
      • RESOURCE_API_VERSION_FIELD_NUMBER

        public static final int RESOURCE_API_VERSION_FIELD_NUMBER
        See Also:
        Constant Field Values
      • resourceApiVersion_

        private int resourceApiVersion_
      • memoizedIsInitialized

        private byte memoizedIsInitialized
      • DEFAULT_INSTANCE

        private static final ConfigSource DEFAULT_INSTANCE
      • PARSER

        private static final com.google.protobuf.Parser<ConfigSource> PARSER
    • Constructor Detail

      • ConfigSource

        private ConfigSource​(com.google.protobuf.GeneratedMessage.Builder<?> builder)
      • ConfigSource

        private ConfigSource()
    • Method Detail

      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
      • getAuthoritiesList

        public java.util.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;
        Specified by:
        getAuthoritiesList in interface ConfigSourceOrBuilder
      • getAuthoritiesOrBuilderList

        public java.util.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;
        Specified by:
        getAuthoritiesOrBuilderList in interface ConfigSourceOrBuilder
      • getAuthoritiesCount

        public 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;
        Specified by:
        getAuthoritiesCount in interface ConfigSourceOrBuilder
      • getAuthorities

        public 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;
        Specified by:
        getAuthorities in interface ConfigSourceOrBuilder
      • getAuthoritiesOrBuilder

        public 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;
        Specified by:
        getAuthoritiesOrBuilder in interface ConfigSourceOrBuilder
      • hasPath

        @Deprecated
        public boolean hasPath()
        Deprecated.
        envoy.config.core.v3.ConfigSource.path is deprecated. See envoy/config/core/v3/config_source.proto;l=213
         Deprecated in favor of ``path_config_source``. Use that field instead.
         
        string path = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        hasPath in interface ConfigSourceOrBuilder
        Returns:
        Whether the path field is set.
      • getPath

        @Deprecated
        public java.lang.String getPath()
        Deprecated.
        envoy.config.core.v3.ConfigSource.path is deprecated. See envoy/config/core/v3/config_source.proto;l=213
         Deprecated in favor of ``path_config_source``. Use that field instead.
         
        string path = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        getPath in interface ConfigSourceOrBuilder
        Returns:
        The path.
      • getPathBytes

        @Deprecated
        public com.google.protobuf.ByteString getPathBytes()
        Deprecated.
        envoy.config.core.v3.ConfigSource.path is deprecated. See envoy/config/core/v3/config_source.proto;l=213
         Deprecated in favor of ``path_config_source``. Use that field instead.
         
        string path = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        getPathBytes in interface ConfigSourceOrBuilder
        Returns:
        The bytes for path.
      • hasPathConfigSource

        public boolean hasPathConfigSource()
         Local filesystem path configuration source.
         
        .envoy.config.core.v3.PathConfigSource path_config_source = 8;
        Specified by:
        hasPathConfigSource in interface ConfigSourceOrBuilder
        Returns:
        Whether the pathConfigSource field is set.
      • hasApiConfigSource

        public boolean hasApiConfigSource()
         API configuration source.
         
        .envoy.config.core.v3.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.config.core.v3.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.config.core.v3.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_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;
        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_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;
        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_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;
        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.config.core.v3.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.config.core.v3.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.GeneratedMessage
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.IOException
      • getSerializedSize

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

        public boolean equals​(java.lang.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​(java.nio.ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static ConfigSource parseFrom​(java.nio.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​(java.io.InputStream input)
                                      throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static ConfigSource parseFrom​(java.io.InputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static ConfigSource parseDelimitedFrom​(java.io.InputStream input)
                                               throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static ConfigSource parseDelimitedFrom​(java.io.InputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static ConfigSource parseFrom​(com.google.protobuf.CodedInputStream input)
                                      throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static ConfigSource parseFrom​(com.google.protobuf.CodedInputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws java.io.IOException
        Throws:
        java.io.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.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage
      • 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.GeneratedMessage
      • getDefaultInstanceForType

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