Package org.fairdatapipeline.config

Interface Config.ConfigRunMetadata

  • Enclosing interface:
    Config
    @Immutable
public static interface Config.ConfigRunMetadata
    Defaults and settings for this coderun.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Optional<java.lang.String> default_input_namespace()
      In which namespace to search for READ data products.
      java.util.Optional<java.lang.String> default_output_namespace()
      In which namespace to place the WRITE data products.
      java.util.Optional<java.lang.String> default_read_version()
      Default write version - Not Used
      java.util.Optional<java.lang.String> default_write_version()
      Default read version - Not Used
      java.util.Optional<java.lang.String> description()
      Set the description field for this code run.
      java.util.Optional<java.lang.Boolean> isPublic()
      This is ignored.
      java.util.Optional<java.lang.String> latest_commit()
      The commit hash of the remote_repo, in order to store the exact version of the analysis code.
      java.util.Optional<java.lang.String> local_data_registry_url()
      this is usually http://localhost:8000/api/ (optional, but it probably shouldn't be)
      java.util.Optional<java.lang.String> local_repo()
      This is ignored.
      java.util.Optional<java.lang.String> remote_data_registry_url()
      I don't know why we would specify this.
      java.util.Optional<java.lang.String> remote_repo()
      This is the location of the repository of the analysis code.
      java.util.Optional<java.lang.String> script()
      This is ignored.
      java.util.Optional<java.lang.String> script_path()
      you can give the path to the submission script (to be stored in the code run) here, or in Coderun(Path, Path) FileApi constructor.
      java.util.Optional<java.lang.String> token()
      The authentication token for the registry.
      java.util.Optional<java.lang.String> write_data_store()
      The file system root of the local data store for new write objects.

    • Method Detail

      • description

        java.util.Optional<java.lang.String> description()
        Set the description field for this code run. (optional, but it really shouldn't be)
        Returns:
        String the description for this code run, if given

      • local_data_registry_url

        java.util.Optional<java.lang.String> local_data_registry_url()
        this is usually http://localhost:8000/api/ (optional, but it probably shouldn't be)
        Returns:
        String the URL of the local data registry, if given.

      • remote_data_registry_url

        java.util.Optional<java.lang.String> remote_data_registry_url()
        I don't know why we would specify this. It is ignored.
        Returns:
        String remote data registry URL, if given.

      • default_input_namespace

        java.util.Optional<java.lang.String> default_input_namespace()
        In which namespace to search for READ data products. this can be overridden in the ConfigUseItem. Optional.
        Returns:
        String default input namespace, if given.

      • default_output_namespace

        java.util.Optional<java.lang.String> default_output_namespace()
        In which namespace to place the WRITE data products. this can be overridden in the ConfigUseItem. Optional.
        Returns:
        String the default output namespace, if given.

      • write_data_store

        java.util.Optional<java.lang.String> write_data_store()
        The file system root of the local data store for new write objects.
        Returns:
        String the write data store Filesystem path on your local machine.

      • local_repo

        java.util.Optional<java.lang.String> local_repo()
        This is ignored.
        Returns:
        String local_repo - this is ignored.

      • remote_repo

        java.util.Optional<java.lang.String> remote_repo()
        This is the location of the repository of the analysis code. For example: https://github.com/FAIRDataPipeline/javaExampleModel
        Returns:
        String remote_repo - this must be a valid URL.

      • script

        java.util.Optional<java.lang.String> script()
        This is ignored.
        Returns:
        String script - this is ignored.

      • script_path

        java.util.Optional<java.lang.String> script_path()
        you can give the path to the submission script (to be stored in the code run) here, or in Coderun(Path, Path) FileApi constructor. Constructor will override the config.
        Returns:
        String script_path - the location of the 'submission script', if given.

      • latest_commit

        java.util.Optional<java.lang.String> latest_commit()
        The commit hash of the remote_repo, in order to store the exact version of the analysis code.
        Returns:
        String latest_commit - the commit hash of the remote_repo, in order to store the exact version of the analysis code.

      • token

        java.util.Optional<java.lang.String> token()
        The authentication token for the registry.
        Returns:
        The authentication token for the registry.

      • isPublic

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

      • default_read_version

        java.util.Optional<java.lang.String> default_read_version()
        Default write version - Not Used
        Returns:
        The default write version - not used.

      • default_write_version

        java.util.Optional<java.lang.String> default_write_version()
        Default read version - Not Used
        Returns:
        The default write version - not used.