Class Batch


  • public class Batch
    extends java.lang.Object
    A class representing the batch parameter. Salt uses a string for the batch parameter, but it accept strings representing both exact numerals and percents, so this class encapsulates the creation and usage of the batch strings, adding safety.
    • Field Detail

      • batch

        private java.lang.String batch
      • delay

        private java.util.Optional<java.lang.Double> delay
      • presencePingTimeout

        private java.util.Optional<java.lang.Integer> presencePingTimeout
      • presencePingGatherJobTimeout

        private java.util.Optional<java.lang.Integer> presencePingGatherJobTimeout
    • Method Detail

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • getBatch

        public java.lang.String getBatch()
      • getDelay

        public java.util.Optional<java.lang.Double> getDelay()
      • getPresencePingTimeout

        public java.util.Optional<java.lang.Integer> getPresencePingTimeout()
      • getPresencePingGatherJobTimeout

        public java.util.Optional<java.lang.Integer> getPresencePingGatherJobTimeout()
      • getParams

        public java.util.Map<java.lang.String,​java.lang.Object> getParams()
      • asPercent

        public static Batch asPercent​(int value)
        Construct a Batch from a value representing a percent
        Parameters:
        value - the percent, which must be greater than 0 and less than or equal to 100
        Returns:
        the Batch
      • asAmount

        public static Batch asAmount​(int value)
        Construct a Batch from a value representing an exact amount of items
        Parameters:
        value - the exact amount of items, which must be greater than 0
        Returns:
        the Batch
      • custom

        public static Batch.BatchBuilder custom()
        Returns a BatchBuilder for instantiating a custom Batch.
        Returns:
        a BatchBuilder instance.