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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String data_product()
      data_product name (for write items this may end in * for simple globbing)
      java.util.Optional<java.lang.String> description()
      For write items only: please set the description to get stored in the registry with this data product
      java.util.Optional<java.lang.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.
      java.util.Optional<java.lang.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 Detail

      • data_product

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

      • description

        java.util.Optional<java.lang.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

        java.util.Optional<java.lang.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

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