Interface Source.Builder<B extends Source.Builder<B>>

Type Parameters:
B - type implementation class of this interface
All Known Subinterfaces:
ParsableSource.Builder<B>
All Known Implementing Classes:
AbstractConfigSourceBuilder, AbstractSecretBundleConfigSource.Builder, AbstractSourceBuilder, ClasspathConfigSource.Builder, ClasspathOverrideSource.Builder, ConfigSources.SystemPropertiesConfigSource.Builder, DirectoryConfigSource.Builder, EtcdConfigSourceBuilder, FileConfigSource.Builder, FileOverrideSource.Builder, GitConfigSourceBuilder, MapConfigSource.Builder, MapConfigSource.MapBuilder, SecretBundleLazyConfigSource.Builder, SecretBundleNodeConfigSource.Builder, UrlConfigSource.Builder, UrlOverrideSource.Builder
Enclosing interface:
Source

public static interface Source.Builder<B extends Source.Builder<B>>
Configurable options of a Source.
  • Method Summary

    Modifier and Type
    Method
    Description
    default B
    Configure this source to be optional.
    optional(boolean optional)
    Whether the source is optional or not.
    retryPolicy(Supplier<? extends RetryPolicy> policy)
    Configure a retry policy to be used with this source.
  • Method Details

    • retryPolicy

      B retryPolicy(Supplier<? extends RetryPolicy> policy)
      Configure a retry policy to be used with this source. If none is configured, the source is invoked directly with no retries.
      Parameters:
      policy - retry policy to use
      Returns:
      updated builder instance
    • optional

      B optional(boolean optional)
      Whether the source is optional or not. When configured to be optional, missing underlying data do not cause an exception to be raised.
      Parameters:
      optional - true when this source should be optional
      Returns:
      updated builder instance
    • optional

      default B optional()
      Configure this source to be optional.

      Same as calling optional(true).

      Returns:
      updated builder instance