Package org.veupathdb.lib.compute.platform.job

Interface AsyncJob

  • All Implemented Interfaces:
    
public interface AsyncJob

    Async Job

    Represents a job submitted to the compute platform.

    Since:

    1.0.0

    Author:

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

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract HashID getJobID() Hash ID of this job.
      abstract JobStatus getStatus() Status of this job.
      abstract Integer getQueuePosition() Position of this job in the queue.
      abstract Boolean getOwned() Indicates whether this compute platform process owns this job.
      abstract JsonNode getConfig() Optional, raw configuration for this job.
      abstract OffsetDateTime getCreated() Timestamp for when this job was created (initially queued).
      abstract OffsetDateTime getGrabbed() Timestamp for when this job was pulled off the queue and started.
      abstract OffsetDateTime getFinished() Timestamp for when this job was completed (successfully or not).

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • getJobID

         abstract HashID getJobID()

        Hash ID of this job.

      • getQueuePosition

         abstract Integer getQueuePosition()

        Position of this job in the queue.

        Will only be present if this process owns the job, and the job is currently in the queued status.

      • getOwned

         abstract Boolean getOwned()

        Indicates whether this compute platform process owns this job.

        This field is used to indicate ownership in situations were there are multiple separate compute platform applications sharing a single S3 store instance.

        If this job was found in the local, managed database, this value will be true.

        If this job was not found in the local, managed database, and was instead found only in the S3 store, this value will be false.

      • getConfig

         abstract JsonNode getConfig()

        Optional, raw configuration for this job.

        This will be present if the job was submitted with a configuration.

        If the job was submitted with no configuration, this value will be null.

      • getGrabbed

         abstract OffsetDateTime getGrabbed()

        Timestamp for when this job was pulled off the queue and started.

        If this job is still queued, this value will be null.

      • getFinished

         abstract OffsetDateTime getFinished()

        Timestamp for when this job was completed (successfully or not).

        If this job