v1alpha1

type Backup struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   BackupSpec   `json:"spec,omitempty"`
	Status BackupStatus `json:"status,omitempty"`
}

type BackupArtifact struct {
	// URI is a driver-/storage-specific URI pointing to the backup artifact.
	// For example: s3://bucket/prefix/file.tar.gz
	URI string `json:"uri"`

	// SizeBytes is the size of the artifact in bytes, if known.
	// +optional
	SizeBytes int64 `json:"sizeBytes,omitempty"`

	// Checksum is the checksum of the artifact, if computed.
	// For example: "sha256:<hex>".
	// +optional
	Checksum string `json:"checksum,omitempty"`
}

type BackupJob struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   BackupJobSpec   `json:"spec,omitempty"`
	Status BackupJobStatus `json:"status,omitempty"`
}

type BackupJobList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []BackupJob `json:"items"`
}

type BackupJobPhase string

type BackupJobSpec struct {
	// PlanRef refers to the Plan that requested this backup run.
	// For ad-hoc/manual backups, this can be omitted.
	// +optional
	PlanRef *corev1.LocalObjectReference `json:"planRef,omitempty"`

	// ApplicationRef holds a reference to the managed application whose state
	// is being backed up.
	ApplicationRef corev1.TypedLocalObjectReference `json:"applicationRef"`

	// StorageRef holds a reference to the Storage object that describes where
	// the backup will be stored.
	StorageRef corev1.TypedLocalObjectReference `json:"storageRef"`

	// StrategyRef holds a reference to the driver-specific BackupStrategy object
	// that describes how the backup should be created.
	StrategyRef corev1.TypedLocalObjectReference `json:"strategyRef"`
}

type BackupJobStatus struct {
	// Phase is a high-level summary of the run's state.
	// Typical values: Pending, Running, Succeeded, Failed.
	// +optional
	Phase BackupJobPhase `json:"phase,omitempty"`

	// BackupRef refers to the Backup object created by this run, if any.
	// +optional
	BackupRef *corev1.LocalObjectReference `json:"backupRef,omitempty"`

	// StartedAt is the time at which the backup run started.
	// +optional
	StartedAt *metav1.Time `json:"startedAt,omitempty"`

	// CompletedAt is the time at which the backup run completed (successfully
	// or otherwise).
	// +optional
	CompletedAt *metav1.Time `json:"completedAt,omitempty"`

	// Message is a human-readable message indicating details about why the
	// backup run is in its current phase, if any.
	// +optional
	Message string `json:"message,omitempty"`

	// Conditions represents the latest available observations of a BackupJob's state.
	// +optional
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

type BackupList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Backup `json:"items"`
}

type BackupPhase string

type BackupSpec struct {
	// ApplicationRef refers to the application that was backed up.
	ApplicationRef corev1.TypedLocalObjectReference `json:"applicationRef"`

	// PlanRef refers to the Plan that produced this backup, if any.
	// For manually triggered backups, this can be omitted.
	// +optional
	PlanRef *corev1.LocalObjectReference `json:"planRef,omitempty"`

	// StorageRef refers to the Storage object that describes where the backup
	// artifact is stored.
	StorageRef corev1.TypedLocalObjectReference `json:"storageRef"`

	// StrategyRef refers to the driver-specific BackupStrategy that was used
	// to create this backup. This allows the driver to later perform restores.
	StrategyRef corev1.TypedLocalObjectReference `json:"strategyRef"`

	// TakenAt is the time at which the backup was taken (as reported by the
	// driver). It may differ slightly from metadata.creationTimestamp.
	TakenAt metav1.Time `json:"takenAt"`

	// DriverMetadata holds driver-specific, opaque metadata associated with
	// this backup (for example snapshot IDs, schema versions, etc.).
	// This data is not interpreted by the core backup controllers.
	// +optional
	DriverMetadata map[string]string `json:"driverMetadata,omitempty"`
}

type BackupStatus struct {
	// Phase is a simple, high-level summary of the backup's state.
	// Typical values are: Pending, Ready, Failed.
	// +optional
	Phase BackupPhase `json:"phase,omitempty"`

	// Artifact describes the stored backup object, if available.
	// +optional
	Artifact *BackupArtifact `json:"artifact,omitempty"`

	// Conditions represents the latest available observations of a Backup's state.
	// +optional
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

type Plan struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   PlanSpec   `json:"spec,omitempty"`
	Status PlanStatus `json:"status,omitempty"`
}

type PlanList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Plan `json:"items"`
}

type PlanSchedule struct {
	// Type is the type of schedule specification. Supported values are
	// [`cron`]. If omitted, defaults to `cron`.
	// +optional
	Type PlanScheduleType `json:"type,omitempty"`

	// Cron contains the cron spec for scheduling backups. Must be
	// specified if the schedule type is `cron`. Since only `cron` is
	// supported, omitting this field is not allowed.
	// +optional
	Cron string `json:"cron,omitempty"`
}

type PlanScheduleType string

type PlanSpec struct {
	// ApplicationRef holds a reference to the managed application,
	// whose state and configuration must be backed up.
	ApplicationRef corev1.TypedLocalObjectReference `json:"applicationRef"`

	// StorageRef holds a reference to the Storage object that
	// describes the location where the backup will be stored.
	StorageRef corev1.TypedLocalObjectReference `json:"storageRef"`

	// StrategyRef holds a reference to the Strategy object that
	// describes, how a backup copy is to be created.
	StrategyRef corev1.TypedLocalObjectReference `json:"strategyRef"`

	// Schedule specifies when backup copies are created.
	Schedule PlanSchedule `json:"schedule"`
}

type PlanStatus struct {
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

type RestoreJob struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   RestoreJobSpec   `json:"spec,omitempty"`
	Status RestoreJobStatus `json:"status,omitempty"`
}

type RestoreJobList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []RestoreJob `json:"items"`
}

type RestoreJobPhase string

type RestoreJobSpec struct {
	// BackupRef refers to the Backup that should be restored.
	BackupRef corev1.LocalObjectReference `json:"backupRef"`

	// TargetApplicationRef refers to the application into which the backup
	// should be restored. If omitted, the driver SHOULD restore into the same
	// application as referenced by backup.spec.applicationRef.
	// +optional
	TargetApplicationRef *corev1.TypedLocalObjectReference `json:"targetApplicationRef,omitempty"`
}

type RestoreJobStatus struct {
	// Phase is a high-level summary of the run's state.
	// Typical values: Pending, Running, Succeeded, Failed.
	// +optional
	Phase RestoreJobPhase `json:"phase,omitempty"`

	// StartedAt is the time at which the restore run started.
	// +optional
	StartedAt *metav1.Time `json:"startedAt,omitempty"`

	// CompletedAt is the time at which the restore run completed (successfully
	// or otherwise).
	// +optional
	CompletedAt *metav1.Time `json:"completedAt,omitempty"`

	// Message is a human-readable message indicating details about why the
	// restore run is in its current phase, if any.
	// +optional
	Message string `json:"message,omitempty"`

	// Conditions represents the latest available observations of a RestoreJob's state.
	// +optional
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}