Package org.fairdatapipeline.config

Interface Config

@Immutable public interface Config
config.yaml configuration file - this specifies the file as rewritten by the FAIR-CLI command.

The config file MUST contain the run_metadata section, and MAY contain the read and write section(s).

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Config.ConfigItem
    Read or Write data product items, specified by name, or (only for write items) possibly ending in * for simple globbing
    static interface 
    Config.ConfigRunMetadata
    Defaults and settings for this coderun.
    static interface 
    Config.ConfigUseItem
    Use-section for a data product.

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<Boolean>
    failOnHashMisMatch()
    Ignored at the moment; I think the FAIR-CLI should deal with hash-checking for input files.
    List<org.fairdatapipeline.config.ImmutableConfigItem>
    readItems()
    The config file MAY contain the read section to specify the read data products
    org.fairdatapipeline.config.ImmutableConfigRunMetadata
    run_metadata()
    The config file MUST contain a run_metadata section to specify the coderun details
    List<org.fairdatapipeline.config.ImmutableConfigItem>
    writeItems()
    The config file MAY contain the write section to specify the write data products

  • Method Details

    • failOnHashMisMatch

      Optional<Boolean> failOnHashMisMatch()
      Ignored at the moment; I think the FAIR-CLI should deal with hash-checking for input files.
      Returns:
      boolean fail_on_hash_mismatch

    • run_metadata

      org.fairdatapipeline.config.ImmutableConfigRunMetadata run_metadata()
      The config file MUST contain a run_metadata section to specify the coderun details
      Returns:
      ImmutableConfigRunMetadata the run metadata

    • readItems

      List<org.fairdatapipeline.config.ImmutableConfigItem> readItems()
      The config file MAY contain the read section to specify the read data products
      Returns:
      List a list of ImmutableConfigItem read items

    • writeItems

      List<org.fairdatapipeline.config.ImmutableConfigItem> writeItems()
      The config file MAY contain the write section to specify the write data products
      Returns:
      List a list of ImmutableConfigItem write items