Package jetbrains.buildServer.serverSide.maintenance

Interface BackupProcess

  • All Known Implementing Classes:
    BackupProcessor
    public interface BackupProcess
    Describes the currently running backup process.

    • Method Detail

      • getBriefInfo

        @NotNull
BackupProcessInfo getBriefInfo()
        Returns brief info of the process.

        Note: the BackupBriefProcessInfo#getFileSize() in the returned datum may return 0 till backup is finished. Tracking the archive size during the backup process is not maintained.

        Returns:
        brief info.

      • getProcessId

        int getProcessId()
        Returns the maintenance process identifier. This identifier is an internal identified of the maintenance process, it doesn't relate to operating system process identifiers or something else.
        Returns:
        the maintenance process identifier.

      • getProgressStatus

        @NotNull
ProgressStatus getProgressStatus()
        Returns the progress status of the process.
        Returns:
        the progress status.

      • getProgressInfo

        @NotNull
ProgressInfo getProgressInfo()
        Returns the progress in percents and a name of phase.
        Returns:
        the progress in percents and a name of phase.

      • cancel

        void cancel()
        Request the process to cancel.

      • hasExceptions

        boolean hasExceptions()
        Determines whether exceptions occurred during process performing.
        Returns:
        true if there are exceptions.

      • getExceptions

        Exception[] getExceptions()
        Returns exceptions that occurred during process performing.
        Returns:
        occurred exceptions in time order.

      • isFinished

        boolean isFinished()
        Determines whether the process has already performed its operations or has been stopped. If this functions has returned true, then this process will never do something more. And, the result is not depended on whether the process has ended successfully or with errors.
        Returns:
        true means all possible works have already done.
        Since:
        7.1