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 Classes
    Modifier and Type
    Class
    Description
    static final class 
    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 enum 
     

    Nested 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

    Fields
    Modifier and Type
    Field
    Description
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
     
    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 final com.google.protobuf.Descriptors.Descriptor
     
    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>`.
    com.google.protobuf.Parser<ConfigSource>
     
    Path on the filesystem to source and watch for configuration updates.
    com.google.protobuf.ByteString
    Path on the filesystem to source and watch for configuration updates.
    API version for xDS resources.
    int
    API version for xDS resources.
    [#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.
    int
     
    boolean
    When set, ADS will be used to fetch resources.
    boolean
    API configuration source.
    int
     
    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
    Path on the filesystem to source and watch for configuration updates.
    boolean
    [#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
     
    final boolean
     
     
     
     
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
     
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(byte[] data)
     
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(com.google.protobuf.ByteString data)
     
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
     
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
     
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<ConfigSource>
     
     
    void
    writeTo(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, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods 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

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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
    • getConfigSourceSpecifierCase

      public ConfigSource.ConfigSourceSpecifierCase getConfigSourceSpecifierCase()
      Specified by:
      getConfigSourceSpecifierCase in interface ConfigSourceOrBuilder
    • 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.
    • getApiConfigSource

      public ApiConfigSource getApiConfigSource()
       API configuration source.
       
      .envoy.api.v2.core.ApiConfigSource api_config_source = 2;
      Specified by:
      getApiConfigSource in interface ConfigSourceOrBuilder
      Returns:
      The apiConfigSource.
    • getApiConfigSourceOrBuilder

      public ApiConfigSourceOrBuilder getApiConfigSourceOrBuilder()
       API configuration source.
       
      .envoy.api.v2.core.ApiConfigSource api_config_source = 2;
      Specified by:
      getApiConfigSourceOrBuilder in interface ConfigSourceOrBuilder
    • 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.
    • getAdsOrBuilder

      public AggregatedConfigSourceOrBuilder 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:
      getAdsOrBuilder in interface ConfigSourceOrBuilder
    • 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(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

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

      public static ConfigSource parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

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

      public static ConfigSource parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • 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
    • newBuilder

      public static ConfigSource.Builder newBuilder()
    • newBuilder

      public static ConfigSource.Builder newBuilder(ConfigSource prototype)
    • 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