compute-platform/org.veupathdb.lib.compute.platform/AsyncPlatform

AsyncPlatform

object AsyncPlatform

Asynchronous Compute Platform

Access point for working with the async compute platform library.

Provides methods for submitting jobs, retrieving job details, and fetching job results.

Author

Elizabeth Paige Harper https://github.com/foxcapades

Since

1.0.0

Functions

Link copied to clipboard
@JvmStatic
@JvmOverloads
fun deleteJob(jobID: HashID, throwOnNotExists: Boolean = true)

Deletes the target job only if it exists, is owned by the current service or process, and is in a completed status.

Link copied to clipboard
@JvmStatic
fun expireJob(jobID: HashID)

Marks the target job as expired.

Link copied to clipboard
@JvmStatic
fun getJob(jobID: HashID): AsyncJob?

Looks up and returns the job with the given jobID if such a job exists.

Link copied to clipboard
@JvmStatic
fun getJobFile(jobID: HashID, fileName: String): JobFileReference?

Fetches the target file for the target job.

Link copied to clipboard
@JvmStatic
fun getJobFiles(jobID: HashID): List<JobFileReference>

Fetches the available files for the target job.

Link copied to clipboard
@JvmStatic
fun getOwnedBrokenJobs(): List<AsyncJob>

Fetches a list of jobs owned by the current campus that are in the failed status.

Link copied to clipboard
inline fun init(fn: AsyncPlatformConfig.Builder.() -> Unit)

@JvmStatic
fun init(config: AsyncPlatformConfig)

Initializes the async compute platform library.

Link copied to clipboard
@JvmStatic
fun listJobReferences(): List<JobReference>

Lists references to jobs that may or may not be owned by this service instance.

Link copied to clipboard
@JvmStatic
inline fun submitJob(queue: String, fn: JobSubmission.Builder.() -> Unit)
@JvmStatic
fun submitJob(queue: String, job: JobSubmission)

Submits a new job to the async compute platform.