Package org.fairdatapipeline.config

Interface Config.ConfigItem

Enclosing interface:
Config
@Immutable public static interface Config.ConfigItem
Read or Write data product items, specified by name, or (only for write items) possibly ending in * for simple globbing

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    data_product()
    data_product name (for write items this may end in * for simple globbing)
    Optional<String>
    description()
    For write items only: please set the description to get stored in the registry with this data product
    Optional<String>
    file_type()
    Config write items may specify the file_type (such as csv, h5, or toml) but this can also be specified using Coderun.get_dp_for_write(String, String) method.
    Optional<Boolean>
    isPublic()
    This is ignored.
    org.fairdatapipeline.config.ImmutableConfigUseItem
    use()
    Config (read or write) items MUST have a use section, which MUST specify a version.

  • Method Details

    • data_product

      String data_product()
      data_product name (for write items this may end in * for simple globbing)
      Returns:
      String data product name

    • description

      Optional<String> description()
      For write items only: please set the description to get stored in the registry with this data product
      Returns:
      The description of this write data product, if given

    • use

      org.fairdatapipeline.config.ImmutableConfigUseItem use()
      Config (read or write) items MUST have a use section, which MUST specify a version.
      Returns:
      The ImmutableConfigUseItem use section for this data product.

    • file_type

      Optional<String> file_type()
      Config write items may specify the file_type (such as csv, h5, or toml) but this can also be specified using Coderun.get_dp_for_write(String, String) method.
      Returns:
      String the file_type file extension, if given.

    • isPublic

      Optional<Boolean> isPublic()
      This is ignored. But added by CLI
      Returns:
      Boolean 'public' - this is ignored.