Package org.fairdatapipeline.config

Interface Config.ConfigRunMetadata

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

  • Method Details

    • description

      Optional<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

      Optional<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

      Optional<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

      Optional<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

      Optional<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

      Optional<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

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

    • remote_repo

      Optional<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

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

    • script_path

      Optional<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

      Optional<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

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

    • isPublic

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

    • default_read_version

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

    • default_write_version

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