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

Interface ConfigSourceOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ConfigSource, ConfigSource.Builder
    public interface ConfigSourceOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      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.
      ConfigSource.ConfigSourceSpecifierCase getConfigSourceSpecifierCase()  
      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>`.
      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.
      boolean hasAds()
      When set, ADS will be used to fetch resources.
      boolean hasApiConfigSource()
      API configuration source.
      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 hasPath()
      Path on the filesystem to source and watch for configuration updates.
      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.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • hasPath

        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;
        Returns:
        Whether the path field is set.

      • getPath

        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;
        Returns:
        The path.

      • getPathBytes

        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;
        Returns:
        The bytes for path.

      • hasApiConfigSource

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

      • getApiConfigSource

        ApiConfigSource getApiConfigSource()
         API configuration source.
        .envoy.api.v2.core.ApiConfigSource api_config_source = 2;
        Returns:
        The apiConfigSource.

      • getApiConfigSourceOrBuilder

        ApiConfigSourceOrBuilder getApiConfigSourceOrBuilder()
         API configuration source.
        .envoy.api.v2.core.ApiConfigSource api_config_source = 2;

      • hasAds

        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;
        Returns:
        Whether the ads field is set.

      • getAds

        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;
        Returns:
        The ads.

      • getAdsOrBuilder

        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;

      • hasSelf

        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;
        Returns:
        Whether the self field is set.

      • getSelf

        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;
        Returns:
        The self.

      • getSelfOrBuilder

        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;

      • hasInitialFetchTimeout

        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;
        Returns:
        Whether the initialFetchTimeout field is set.

      • getInitialFetchTimeout

        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;
        Returns:
        The initialFetchTimeout.

      • getInitialFetchTimeoutOrBuilder

        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;

      • getResourceApiVersionValue

        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) = { ... }
        Returns:
        The enum numeric value on the wire for resourceApiVersion.

      • getResourceApiVersion

        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) = { ... }
        Returns:
        The resourceApiVersion.