All Superinterfaces:
AuditProjection, BaseProjection, IdProjection, UniqueIdProjection
All Known Implementing Classes:
JobEntity

public interface FinishedJobProjection extends BaseProjection
Projection for a job entity that reached a terminal status.
Since:
4.0.0
  • Method Details

    • getTags

      Set<TagEntity> getTags()
      Get the tags for the job.
      Returns:
      Any tags that were sent in when job was originally requested
    • getGrouping

      Optional<String> getGrouping()
      Get the grouping this job is a part of. e.g. scheduler job name for job run many times
      Returns:
      The grouping
    • getGroupingInstance

      Optional<String> getGroupingInstance()
      Get the instance identifier of a grouping. e.g. the run id of a given scheduled job
      Returns:
      The grouping instance
    • getStatusMsg

      Optional<String> getStatusMsg()
      Get the current status message of the job.
      Returns:
      The status message
    • getStarted

      Optional<Instant> getStarted()
      Get when the job was started.
      Returns:
      The start date
    • getFinished

      Optional<Instant> getFinished()
      Get when the job was finished.
      Returns:
      The finish date
    • getMetadata

      Optional<com.fasterxml.jackson.databind.JsonNode> getMetadata()
      Get the metadata of this entity which is unstructured JSON.
      Specified by:
      getMetadata in interface BaseProjection
      Returns:
      Optional of the metadata json node
    • getCommandArgs

      List<String> getCommandArgs()
      Get the command arguments the user supplied for this job.
      Returns:
      The command arguments
    • getRequestedMemory

      Optional<Long> getRequestedMemory()
      Get the memory requested to run this job with.
      Returns:
      The amount of memory the user requested for this job in MB as an Optional
    • getRequestApiClientHostname

      Optional<String> getRequestApiClientHostname()
      Get the request api client hostname.
      Returns:
      Optional of the client host
    • getRequestApiClientUserAgent

      Optional<String> getRequestApiClientUserAgent()
      Get the user agent.
      Returns:
      Optional of the user agent
    • getNumAttachments

      Optional<Integer> getNumAttachments()
      Get the number of attachments.
      Returns:
      The number of attachments as an Optional
    • getRequestAgentClientHostname

      Optional<String> getRequestAgentClientHostname()
      Get the hostname of the agent that requested this job be run if there was one.
      Returns:
      The hostname wrapped in an Optional
    • getRequestAgentClientVersion

      Optional<String> getRequestAgentClientVersion()
      Get the version of the agent that requested this job be run if there was one.
      Returns:
      The version wrapped in an Optional
    • getExitCode

      Optional<Integer> getExitCode()
      Get the exit code from the process that ran the job.
      Returns:
      The exit code or -1 if the job hasn't finished yet
    • getArchiveLocation

      Optional<String> getArchiveLocation()
      Get the location where the job was archived.
      Returns:
      The archive location
    • getMemoryUsed

      Optional<Long> getMemoryUsed()
      Get the amount of memory (in MB) that this job is/was run with.
      Returns:
      The memory as an Optional as it could be null
    • getClusterCriteria

      List<CriterionEntity> getClusterCriteria()
      Get all the cluster criteria.
      Returns:
      The criteria in priority order
    • getCommandCriterion

      CriterionEntity getCommandCriterion()
      Get the command criterion for this job.
      Returns:
      The command criterion for this job
    • getApplications

      List<ApplicationEntity> getApplications()
      Get the applications used to run this job.
      Returns:
      The applications
    • getCluster

      Optional<ClusterEntity> getCluster()
      Get the cluster that ran or is currently running a given job.
      Returns:
      The cluster entity
    • getCommand

      Optional<CommandEntity> getCommand()
      Get the command that ran or is currently running a given job.
      Returns:
      The command entity