run.halo.app.migration.Backup Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api Show documentation

API of halo project, connecting by other projects.

The newest version!

package run.halo.app.migration;

import io.swagger.v3.oas.annotations.media.Schema;
import java.time.Instant;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.ToString;
import run.halo.app.extension.AbstractExtension;
import run.halo.app.extension.GVK;

@Data
@ToString(callSuper = true)
@EqualsAndHashCode(callSuper = true)
@GVK(group = "migration.halo.run", version = "v1alpha1", kind = "Backup",
    plural = "backups", singular = "backup")
public class Backup extends AbstractExtension {

    private Spec spec = new Spec();

    private Status status = new Status();

    @Data
    @Schema(name = "BackupSpec")
    public static class Spec {

        @Schema(description = "Backup file format. Currently, only zip format is supported.")
        private String format;

        private Instant expiresAt;

    }

    @Data
    @Schema(name = "BackupStatus")
    public static class Status {

        private Phase phase = Phase.PENDING;

        private Instant startTimestamp;

        private Instant completionTimestamp;

        private String failureReason;

        private String failureMessage;

        /**
         * Size of backup file. Data unit: byte
         */
        private Long size;

        /**
         * Name of backup file.
         */
        private String filename;
    }

    public enum Phase {
        PENDING,
        RUNNING,
        SUCCEEDED,
        FAILED,
    }

}