Package com.atgenomix.seqslab.piper.plugin.api.loader

Interface SupportsCopyToLocal

All Superinterfaces:
AutoCloseable, Closeable, Loader, Operator, OperatorPipelineV3, Serializable, org.apache.spark.sql.api.java.UDF0<Iterator<org.apache.spark.sql.Row>>
@DeveloperApi @FeatureBeforeCall public interface SupportsCopyToLocal extends Loader
A mix-in interface for Loader. Dataset loaders can implement this interface to support copying storage files or directories directly to local file system. Loaders supporting this interface typically localize datasets that do not require in-memory processing optimization, e.g. reference files. This feature is invoked before calling operator function.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    setLocalPath(String path)
    Sets the local destination path where the datasets will be saved.

    Methods inherited from interface java.io.Closeable

    close

    Methods inherited from interface com.atgenomix.seqslab.piper.plugin.api.loader.Loader

    init, readSchema

    Methods inherited from interface com.atgenomix.seqslab.piper.plugin.api.Operator

    getName, getOperatorContext

    Methods inherited from interface org.apache.spark.sql.api.java.UDF0

    call

  • Method Details

    • setLocalPath

      String setLocalPath(String path)
      Sets the local destination path where the datasets will be saved.
      Parameters:
      path - Path of local file system
      Returns:
      The same or updated local path