Enum SamzaExitMode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<SamzaExitMode>

    public enum SamzaExitMode
    extends java.lang.Enum<SamzaExitMode>
    Various methods for stopping/exiting a Samza task.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      NO_OP
      Do nothing; this mode is mostly used in test cases.
      SUCCESS_EXIT
      Directly exit the Samza process with status code 0, which should be only used by stream reprocessing job; besides, status 0 will leave a green mark for Samza task, so this mode should be used when the stream reprocessing job succeeds.
      THROW_ERROR_EXCEPTION
      Stop the Samza task by keep throwing exception.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void exit()  
      static SamzaExitMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static SamzaExitMode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • SUCCESS_EXIT

        public static final SamzaExitMode SUCCESS_EXIT
        Directly exit the Samza process with status code 0, which should be only used by stream reprocessing job; besides, status 0 will leave a green mark for Samza task, so this mode should be used when the stream reprocessing job succeeds.
      • THROW_ERROR_EXCEPTION

        public static final SamzaExitMode THROW_ERROR_EXCEPTION
        Stop the Samza task by keep throwing exception.
      • NO_OP

        public static final SamzaExitMode NO_OP
        Do nothing; this mode is mostly used in test cases.
    • Method Detail

      • values

        public static SamzaExitMode[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (SamzaExitMode c : SamzaExitMode.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static SamzaExitMode valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • exit

        public void exit()