All Known Implementing Classes:
JobEntity

public interface JobRequestProjection
Projection of just the fields needed for a V4 JobRequest.
Since:
4.0.0
  • Method Details

    • getUniqueId

      String getUniqueId()
      Get the unique identifier for this entity.
      Returns:
      The globally unique identifier of this entity
    • isRequestedId

      boolean isRequestedId()
      Get whether the unique identifier of this request was requested by the user or not.
      Returns:
      True if it was requested by the user
    • getName

      String getName()
      Get the name of the resource.
      Returns:
      The name of the resource
    • getUser

      String getUser()
      Get the user who created the resource.
      Returns:
      The user who created the resource
    • getVersion

      String getVersion()
      Get the version.
      Returns:
      The version of the resource (job, app, etc)
    • getDescription

      Optional<String> getDescription()
      Get the description of this resource.
      Returns:
      The description which could be null so it's wrapped in Optional
    • getMetadata

      Optional<com.fasterxml.jackson.databind.JsonNode> getMetadata()
      Get the metadata of this entity which is unstructured JSON.
      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
    • 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
    • getRequestedEnvironmentVariables

      Map<String,String> getRequestedEnvironmentVariables()
      Get all the environment variables that were requested be added to the Job Runtime environment by the user.
      Returns:
      The requested environment variables
    • getRequestedJobDirectoryLocation

      Optional<String> getRequestedJobDirectoryLocation()
      Get the requested directory on disk where the Genie job working directory should be placed if a user asked to override the default.
      Returns:
      The requested job directory location wrapped in an Optional
    • getRequestedAgentEnvironmentExt

      Optional<com.fasterxml.jackson.databind.JsonNode> getRequestedAgentEnvironmentExt()
      Get the extension configuration of a job agent environment.
      Returns:
      The extension configuration if it exists wrapped in an Optional
    • getRequestedAgentConfigExt

      Optional<com.fasterxml.jackson.databind.JsonNode> getRequestedAgentConfigExt()
      Get the extension configuration of a job agent configuration.
      Returns:
      The extension configuration if it exists wrapped in an Optional
    • isInteractive

      boolean isInteractive()
      Get whether the job was an interactive job or not when launched.
      Returns:
      true if the job was interactive
    • getSetupFile

      Optional<FileEntity> getSetupFile()
      Get the setup file for this resource.
      Returns:
      The setup file
    • getGenieUserGroup

      Optional<String> getGenieUserGroup()
      Get the user group for this job.
      Returns:
      the user group
    • 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
    • getDependencies

      Set<FileEntity> getDependencies()
      Get all the dependency files for this job.
      Returns:
      The set of dependencies
    • getConfigs

      Set<FileEntity> getConfigs()
      Get all the configuration files for this job.
      Returns:
      The set of configs
    • isArchivingDisabled

      boolean isArchivingDisabled()
      Get whether log archiving was requested to be disabled for this job or not.
      Returns:
      true if log archival was disabled
    • getEmail

      Optional<String> getEmail()
      Get the email of the user associated with this job if they desire an email notification at completion of the job.
      Returns:
      The email
    • getRequestedCpu

      Optional<Integer> getRequestedCpu()
      Get the number of CPU's requested to run this job.
      Returns:
      The number of CPU's as an Optional
    • getRequestedGpu

      Optional<Integer> getRequestedGpu()
      Get the number of GPUs requested by the job.
      Returns:
      The number of GPUs requested or Optional.empty()
    • 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
    • getRequestedDiskMb

      Optional<Long> getRequestedDiskMb()
      Get the requested disk space for the job if any.
      Returns:
      The requested amount of disk space in MB or Optional.empty()
    • getRequestedNetworkMbps

      Optional<Long> getRequestedNetworkMbps()
      Get the requested network mbps for the job if any.
      Returns:
      The requested network bandwidth in mbps or Optional.empty()
    • getRequestedTimeout

      Optional<Integer> getRequestedTimeout()
      Get the timeout (in seconds) requested by the user for this job.
      Returns:
      The number of seconds before a timeout as an Optional
    • getRequestedApplications

      List<String> getRequestedApplications()
      Get any applications requested by their id.
      Returns:
      The applications
    • getRequestedImages

      Optional<com.fasterxml.jackson.databind.JsonNode> getRequestedImages()
      Get the requested container image configurations if there were any.
      Returns:
      The requested images or Optional.empty()