Struct BackupPlan 

pub struct BackupPlan {

    pub plan_id: String,
    pub run_id: String,
    pub fleet: String,
    pub network: String,
    pub root_canister_id: String,
    pub selected_subtree_root: Option<String>,
    pub selected_scope_kind: BackupScopeKind,
    pub include_descendants: bool,
    pub root_included: bool,
    pub requires_root_controller: bool,
    pub snapshot_read_authority: SnapshotReadAuthority,
    pub quiescence_policy: QuiescencePolicy,
    pub topology_hash_before_quiesce: String,
    pub targets: Vec<BackupTarget>,
    pub phases: Vec<BackupOperation>,
}

BackupPlan

Fields

plan_id: String

run_id: String

fleet: String

network: String

root_canister_id: String

selected_subtree_root: Option<String>

selected_scope_kind: BackupScopeKind

include_descendants: bool

root_included: bool

requires_root_controller: bool

snapshot_read_authority: SnapshotReadAuthority

quiescence_policy: QuiescencePolicy

topology_hash_before_quiesce: String

targets: Vec<BackupTarget>

phases: Vec<BackupOperation>

Implementations

impl BackupPlan

pub fn validate_execution_preflight_receipts( &self, topology_receipt: &TopologyPreflightReceipt, quiescence_receipt: &QuiescencePreflightReceipt, preflight_id: &str, as_of: &str, ) -> Result<(), BackupPlanError>

Validate execution-only preflight receipts before mutation starts.

pub fn apply_execution_preflight_receipts( &mut self, receipts: &BackupExecutionPreflightReceipts, as_of: &str, ) -> Result<(), BackupPlanError>

Apply and validate the full execution preflight receipt bundle.

pub fn apply_authority_preflight_receipts( &mut self, preflight_id: &str, control_receipts: &[ControlAuthorityReceipt], snapshot_read_receipts: &[SnapshotReadAuthorityReceipt], as_of: &str, ) -> Result<(), BackupPlanError>

Apply proven authority receipts produced by execution preflights.

pub fn apply_control_authority_receipts( &mut self, preflight_id: &str, receipts: &[ControlAuthorityReceipt], as_of: &str, ) -> Result<(), BackupPlanError>

Apply proven control authority receipts for every selected target.

pub fn apply_snapshot_read_authority_receipts( &mut self, preflight_id: &str, receipts: &[SnapshotReadAuthorityReceipt], as_of: &str, ) -> Result<(), BackupPlanError>

Apply proven snapshot read authority receipts for every selected target.

pub fn control_authority_preflight_request( &self, ) -> ControlAuthorityPreflightRequest

Build the typed control-authority preflight request for this plan.

pub fn snapshot_read_authority_preflight_request( &self, ) -> SnapshotReadAuthorityPreflightRequest

Build the typed snapshot-read preflight request for this plan.

pub fn topology_preflight_request(&self) -> TopologyPreflightRequest

Build the typed topology preflight request for this plan.

pub fn quiescence_preflight_request(&self) -> QuiescencePreflightRequest

Build the typed quiescence preflight request for this plan.

impl BackupPlan

pub fn validate(&self) -> Result<(), BackupPlanError>

Validate the backup plan as a dry-run/planning artifact.

pub fn validate_for_execution(&self) -> Result<(), BackupPlanError>

Validate the backup plan before any live mutation can run.

Trait Implementations

impl Clone for BackupPlan

fn clone(&self) -> BackupPlan

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BackupPlan

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BackupPlan

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for BackupPlan

fn eq(&self, other: &BackupPlan) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for BackupPlan

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for BackupPlan

impl StructuralPartialEq for BackupPlan