Enum ArchiveStatus

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

    public enum ArchiveStatus
    extends java.lang.Enum<ArchiveStatus>
    Possible archival statuses for a Job.
    Since:
    4.0.0
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ARCHIVED
      Files were archived successfully.
      DISABLED
      Archiving was disabled, files are not archived.
      FAILED
      Archival of files failed, files are not archived.
      NO_FILES
      No files were archived because no files were created.
      PENDING
      Files will be uploaded after the job finishes.
      UNKNOWN
      Archive status is unknown.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static ArchiveStatus valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ArchiveStatus[] 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

      • PENDING

        public static final ArchiveStatus PENDING
        Files will be uploaded after the job finishes.
      • ARCHIVED

        public static final ArchiveStatus ARCHIVED
        Files were archived successfully.
      • FAILED

        public static final ArchiveStatus FAILED
        Archival of files failed, files are not archived.
      • DISABLED

        public static final ArchiveStatus DISABLED
        Archiving was disabled, files are not archived.
      • NO_FILES

        public static final ArchiveStatus NO_FILES
        No files were archived because no files were created. i.e., job never reached the point where a directory is created.
      • UNKNOWN

        public static final ArchiveStatus UNKNOWN
        Archive status is unknown.
    • Method Detail

      • values

        public static ArchiveStatus[] 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 (ArchiveStatus c : ArchiveStatus.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static ArchiveStatus 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