Package org.ovirt.engine.sdk4.types

Enum ImageTransferPhase

    • Enum Constant Detail

      • CANCELLED

        public static final ImageTransferPhase CANCELLED
        This phase will be set as a result of the user cancelling the transfer. The cancellation can only be performed in the Administration Portal.

      • CANCELLED_SYSTEM

        public static final ImageTransferPhase CANCELLED_SYSTEM
        This phase will be set as a result of the system cancelling the transfer.

      • CANCELLED_USER

        public static final ImageTransferPhase CANCELLED_USER
        This phase will be set as a result of the user cancelling the transfer.

      • FINALIZING_CLEANUP

        public static final ImageTransferPhase FINALIZING_CLEANUP
        This phase indicates that the user cancelled the transfer, and necessary cleanup is being done.

      • FINALIZING_FAILURE

        public static final ImageTransferPhase FINALIZING_FAILURE
        This phase can only be set in the Administration Portal, and indicates that there was an error during the transfer, and it is being finalized with a failure.

      • FINALIZING_SUCCESS

        public static final ImageTransferPhase FINALIZING_SUCCESS
        This phase will be set when the user calls <>. Calling finalize is essential to finish the transfer session, and finish using the targeted image. After finalizing, the phase will be changed to `finished_success` or `finished_failure`. Refer to <> for more information.

      • FINISHED_CLEANUP

        public static final ImageTransferPhase FINISHED_CLEANUP
        This phase indicates that the user cancelled the transfer, and necessary cleanup is done.

      • FINISHED_FAILURE

        public static final ImageTransferPhase FINISHED_FAILURE
        Indicates that the targeted image failed the verification, and cannot be used. After reaching this phase, the image transfer entity will be deleted, and the targeted image will be set to illegal. System cancelling the transfer will also result in this.

      • FINISHED_SUCCESS

        public static final ImageTransferPhase FINISHED_SUCCESS
        Indicates that the transfer session was successfully closed, and the targeted image was verified and ready to be used. After reaching this phase, the image transfer entity will be deleted.

      • INITIALIZING

        public static final ImageTransferPhase INITIALIZING
        The initial phase of an image transfer. It is set while the transfer session is establishing. Once the session is established, the phase will be changed to `transferring`

      • PAUSED_SYSTEM

        public static final ImageTransferPhase PAUSED_SYSTEM
        This phase means the session timed out, or some other error occurred with this transfer; for example ovirt-imageio-daemon is not running in the selected host. To resume the session, the client should call <>. After resuming, the phase will change to `resuming`.

      • PAUSED_USER

        public static final ImageTransferPhase PAUSED_USER
        This phase is a result of a pause call by the user, using <>.

      • RESUMING

        public static final ImageTransferPhase RESUMING
        The phase where the transfer has been resumed by the client calling <>. Resuming starts a new session, and after calling it, the phase will be changed to `transferring`, or `paused_system` in case of a failure.

      • TRANSFERRING

        public static final ImageTransferPhase TRANSFERRING
        The phase where the transfer session is open, and the client can input or output the desired image using the preferred tools.

      • UNKNOWN

        public static final ImageTransferPhase UNKNOWN
        An unknown phase. This will only be set in cases of unpredictable errors.

    • Method Detail

      • values

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

      • valueOf

        public static ImageTransferPhase valueOf​(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:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • value

        public String value()