Class JobRequest

  • All Implemented Interfaces:
    java.io.Serializable

    public class JobRequest
    extends ExecutionEnvironmentDTO
    All information needed to make a request to run a new job.
    Since:
    3.0.0
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  JobRequest.Builder
      A builder to create job requests.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int DEFAULT_TIMEOUT_DURATION
      The default number of seconds from start before a job times out.
    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      java.util.Optional<java.lang.String> getCommandArgs()
      Get the arguments to be put on the command line along with the command executable.
      java.util.Optional<java.lang.Integer> getCpu()
      Deprecated.
      Use runtime instead
      java.util.Optional<java.lang.String> getEmail()
      Get the email for the user.
      java.util.Optional<java.lang.String> getGroup()
      Get the group the user should be a member of.
      java.util.Optional<java.lang.String> getGrouping()
      Get the grouping for this job if there currently is one.
      java.util.Optional<java.lang.String> getGroupingInstance()
      Get the grouping instance for this job if there currently is one.
      java.util.Optional<java.lang.Integer> getMemory()
      Deprecated.
      Use runtime instead
      java.util.Optional<java.lang.Integer> getTimeout()
      Get the amount of time requested (in seconds) before this job is timed out on the server.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • DEFAULT_TIMEOUT_DURATION

        public static final int DEFAULT_TIMEOUT_DURATION
        The default number of seconds from start before a job times out.
        See Also:
        Constant Field Values
    • Method Detail

      • getCommandArgs

        public java.util.Optional<java.lang.String> getCommandArgs()
        Get the arguments to be put on the command line along with the command executable.
        Returns:
        The command arguments
      • getGroup

        public java.util.Optional<java.lang.String> getGroup()
        Get the group the user should be a member of.
        Returns:
        The group as an optional
      • getEmail

        public java.util.Optional<java.lang.String> getEmail()
        Get the email for the user.
        Returns:
        The email address as an Optional
      • getCpu

        @Deprecated
        public java.util.Optional<java.lang.Integer> getCpu()
        Deprecated.
        Use runtime instead
        Get the number of CPU's requested to run this job.
        Returns:
        The number of CPU's as an Optional
        Since:
        4.3.0
      • getMemory

        @Deprecated
        public java.util.Optional<java.lang.Integer> getMemory()
        Deprecated.
        Use runtime instead
        Get the amount of memory (in MB) requested to run this job with.
        Returns:
        The amount of memory as an Optional
        Since:
        4.3.0
      • getTimeout

        public java.util.Optional<java.lang.Integer> getTimeout()
        Get the amount of time requested (in seconds) before this job is timed out on the server.
        Returns:
        The timeout as an Optional
      • getGrouping

        public java.util.Optional<java.lang.String> getGrouping()
        Get the grouping for this job if there currently is one.
        Returns:
        The grouping
        Since:
        3.3.0
      • getGroupingInstance

        public java.util.Optional<java.lang.String> getGroupingInstance()
        Get the grouping instance for this job if there currently is one.
        Returns:
        The grouping instance
        Since:
        3.3.0