backup_model - OmniCloudOrg/OmniOrchestrator GitHub Wiki

model (src/backup)

Path: src/backup/model.rs

Table of Contents

Public Items

fn new

Definition

    pub fn new() -> Self {
        let now = chrono::Utc::now();

Documentation

Create a new Backup instance with default values

fn formatted_created_at

Definition

    pub fn formatted_created_at(&self) -> String {
        self.created_at.format("%Y-%m-%d %H:%M:%S").to_string()
    }

    /// Checks if the backup was successful
    pub fn is_successful(&self) -> bool {
    // ... function body
}

Documentation

Returns a formatted string for the backup's created_at field

fn is_successful

Definition

    pub fn is_successful(&self) -> bool {
        self.status == "success"
    }

    /// Sets the backup as successful
    pub fn set_success(&mut self) {
    // ... function body
}

Documentation

Checks if the backup was successful

fn set_success

Definition

    pub fn set_success(&mut self) {
        self.status = "success".to_string();

Documentation

Sets the backup as successful

fn set_failed

Definition

    pub fn set_failed(&mut self, error_msg: Option<String>) {
        self.status = "failed".to_string();

Documentation

Sets the backup as failed with an optional error message

fn set_size

Definition

    pub fn set_size(&mut self, size: u64) {
        self.size_bytes = Some(size.try_into().unwrap_or(0));

Documentation

Updates the backup size

fn mark_validated

Definition

    pub fn mark_validated(&mut self) {
        self.last_validated_at = Some(Utc::now());

Documentation

Records a validation attempt

fn mark_restored

Definition

    pub fn mark_restored(&mut self, target_env: String) {
        self.last_restored_at = Some(Utc::now());

Documentation

Records a restore attempt

fn has_system_components

Definition

    pub fn has_system_components(&self) -> bool {
        self.has_system_core || 
        self.has_directors || 
        self.has_orchestrators || 
        self.has_network_config
    }

    /// Updates the backup metadata
    pub fn update_metadata(&mut self, metadata: Value) {
    // ... function body
}

Documentation

Checks if the backup contains any system components

fn update_metadata

Definition

    pub fn update_metadata(&mut self, metadata: Value) {
        self.metadata = Some(metadata);

Documentation

Updates the backup metadata

fn age_in_days

Definition

    pub fn age_in_days(&self) -> i64 {
        let now = Utc::now();

Documentation

Gets the age of the backup in days

fn create_backup_job

Definition

    pub fn create_backup_job(
        name: String, 
        description: Option<String>, 
        environment: String, 
        backup_type: String, 
        created_by: String,
        apps_to_include: Option<Vec<String>>,
        services_to_include: Option<Vec<String>>,
        encryption_method: Option<String>,
        encryption_key_id: Option<String>,
        storage_location: String,
    ) -> Self {
    // ... function body
}

Documentation

Create a new backup job, setting up parameters and initializing structures

fn initialize_backup_environment

Definition

    pub fn initialize_backup_environment(&self) -> Result<PathBuf, anyhow::Error> {
        use std::fs;

Documentation

Initialize the backup environment, creating necessary directories

⚠️ **GitHub.com Fallback** ⚠️