compute-platform/org.veupathdb.lib.compute.platform.job/JobSubmission/Builder/addInputFile

addInputFile

fun addInputFile(file: File): JobSubmission.Builder

Adds the given file to the job submission inputs.

Job submission inputs are persisted to the S3 store and will be made available to the job in the local scratch workspace on execution.

The name of the input file will be kept and used as the filename in both S3 and the local scratch space.

The input file name must not be one of the reserved file names listed in the project documentation.

Return

This Builder instance.

Parameters

file

File to add as an input to this job.

Throws

If the name of the given file is one of the reserved file names.

fun addInputFile(name: String, file: File): JobSubmission.Builder

Adds the given file to the job submission inputs.

Job submission inputs are persisted to the S3 store and will be made available to the job in the local scratch workspace on execution.

The given name will be used as the filename in both S3 and the local scratch space.

The given name must not be one of the reserved file names listed in the project documentation.

Return

This Builder instance.

Parameters

name

Name to use for the file in S3 and the local scratch space.

Must not be a reserved file name.

file

File to add as an input to this job.

Throws

If the given name is one of the reserved file names.

fun addInputFile(name: String, content: String): JobSubmission.Builder
fun addInputFile(name: String, content: InputStream): JobSubmission.Builder
fun addInputFile(name: String, content: JsonNode): JobSubmission.Builder
fun addInputFile(name: String, content: Reader): JobSubmission.Builder

Adds the given content as a file to the job submission inputs.

Job submission inputs are persisted to the S3 store and will be made available to the job in the local scratch workspace on execution.

The given name will be used as the filename in both S3 and the local scratch space.

The given name must not be one of the reserved file names listed in the project documentation.

Return

This Builder instance.

Parameters

name

Name to use for the file in S3 and the local scratch space.

Must not be a reserved file name.

content

Content to be written to file in S3 and the local scratch space.

Throws

If the given name is one of the reserved file names.