org.apache.flink.table.factories.FactoryUtil.FactoryHelper<F>

Direct Known Subclasses:: FactoryUtil.CatalogFactoryHelper, FactoryUtil.CatalogStoreFactoryHelper, FactoryUtil.ModuleFactoryHelper, FactoryUtil.TableFactoryHelper, WorkflowSchedulerFactoryUtil.WorkflowSchedulerFactoryHelper

@PublicEvolving public static class FactoryUtil.FactoryHelper<F extends Factory> extends Object

Base helper utility for validating all options for a Factory.

Field Details
- factory
  
  protected final F extends Factory factory
- allOptions
  
  protected final org.apache.flink.configuration.Configuration allOptions
- consumedOptionKeys
  
  protected final Set<String> consumedOptionKeys
- deprecatedOptionKeys
  
  protected final Set<String> deprecatedOptionKeys
Constructor Details
- FactoryHelper
  
  public FactoryHelper(F factory, Map<String,String> configuration, org.apache.flink.configuration.ConfigOption<?>... implicitOptions)
Method Details
- validate
  
  public void validate()
  
  Validates the options of the factory. It checks for unconsumed option keys.
- validateExcept
  
  public void validateExcept(String... prefixesToSkip)
  
  Validates the options of the factory. It checks for unconsumed option keys while ignoring the options with given prefixes.
  The option keys that have given prefix prefixToSkip would just be skipped for validation.
  
  Parameters:
  
  prefixesToSkip - Set of option key prefixes to skip validation
- getOptions
  
  public org.apache.flink.configuration.ReadableConfig getOptions()
  
  Returns all options currently being consumed by the factory.

Class FactoryUtil.FactoryHelper<F extends Factory>

Field Summary