Class CommandRequest

  • All Implemented Interfaces:
    CommonRequest, java.io.Serializable

    public class CommandRequest
    extends java.lang.Object
    Fields representing all the values users can set when creating a new Command resource.
    Since:
    4.0.0
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  CommandRequest.Builder
      Builder for a V4 Command Request.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Optional<java.lang.Long> getCheckDelay()
      Get the requested amount of time (in milliseconds) between checks of job status for jobs run using this command.
      java.util.List<Criterion> getClusterCriteria()
      Get the ordered list of Criterion for this command to resolve clusters are runtime.
      java.util.List<java.lang.String> getExecutable()
      Get the executable elements (generally a binary followed optionally by default arguments) that should be used with this command when executing a job.
      java.util.Optional<java.lang.Integer> getMemory()
      Get the default amount of memory (in MB) to use for jobs which use this command.
      java.util.Optional<java.lang.String> getRequestedId()
      Get the ID the user has requested for this resource if one was added.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • getMemory

        public java.util.Optional<java.lang.Integer> getMemory()
        Get the default amount of memory (in MB) to use for jobs which use this command.
        Returns:
        Optional wrapper of the amount of memory to use for a job
      • getCheckDelay

        public java.util.Optional<java.lang.Long> getCheckDelay()
        Get the requested amount of time (in milliseconds) between checks of job status for jobs run using this command.
        Returns:
        The amount of time if one was requested wrapped in an Optional
      • getExecutable

        public java.util.List<java.lang.String> getExecutable()
        Get the executable elements (generally a binary followed optionally by default arguments) that should be used with this command when executing a job.
        Returns:
        The executable arguments as an immutable list. Any attempt to modify will throw an exception
      • getClusterCriteria

        public java.util.List<Criterion> getClusterCriteria()
        Get the ordered list of Criterion for this command to resolve clusters are runtime.
        Returns:
        The ordered list of Criterion as an immutable list. Any attempt to modify will throw an exception
      • getRequestedId

        public java.util.Optional<java.lang.String> getRequestedId()
        Get the ID the user has requested for this resource if one was added.
        Specified by:
        getRequestedId in interface CommonRequest
        Returns:
        The ID wrapped in an Optional