Struct SnapshotPolicySpec 

pub struct SnapshotPolicySpec {

    pub repository: RepositoryRef,
    pub identity: Option<Identity>,
    pub sources: Vec<Source>,
    pub copy_method: CopyMethod,
    pub volume_snapshot_class_name: Option<String>,
    pub staging: Option<StagingSpec>,
    pub group_by: Option<GroupBy>,
    pub retention: Option<Retention>,
    pub default_deletion_policy: Option<DeletionPolicy>,
    pub compression: Option<Compression>,
    pub files: Option<Files>,
    pub extra_args: Vec<String>,
    pub error_handling: Option<ErrorHandling>,
    pub upload: Option<Upload>,
    pub verification: Option<Verification>,
    pub preflight: Option<PreflightSpec>,
    pub suspend: bool,
    pub hooks: Option<Hooks>,
    pub mover: Option<MoverSpec>,
    pub credential_projection: Option<CredentialProjection>,
    pub deletion: Option<PolicyDeletionSpec>,
    pub adoption: Option<SnapshotAdoption>,
}

What to back up: sources, identity, retention, policy, hooks.

Fields

repository: RepositoryRef

Discriminated reference to a Repository or ClusterRepository.

identity: Option<Identity>

Identity overrides — what kopia records as username@hostname:path.

sources: Vec<Source>

What to back up (at least one source; webhook-enforced).

copy_method: CopyMethod

How the source volume is captured before kopia reads it: Snapshot (default), Direct, or Clone.

volume_snapshot_class_name: Option<String>

VolumeSnapshotClass used when copyMethod snapshots/clones the source.

staging: Option<StagingSpec>

Staging knobs for copyMethod: Snapshot/Clone (e.g. how long to wait for the CSI capture to become ready before failing the backup).

group_by: Option<GroupBy>

Multi-PVC consistency grouping; None opts into independent per-PVC snapshots.

retention: Option<Retention>

GFS retention, enforced by the operator pruning Snapshot CRs.

default_deletion_policy: Option<DeletionPolicy>

Default deletionPolicy for Snapshot CRs created against this config.

compression: Option<Compression>

Compression algorithm + per-extension opt-outs.

files: Option<Files>

Paths/patterns kopia should skip while snapshotting.

extra_args: Vec<String>

Escape hatch for kopia flags not yet modeled.

error_handling: Option<ErrorHandling>

Backup-side error handling: let a snapshot complete-with-errors instead of failing outright.

upload: Option<Upload>

Upload parallelism (kopia’s --max-parallel-snapshots / --max-parallel-file-reads).

verification: Option<Verification>

First-class backup verification; opt-in (absent ⇒ no verification runs).

preflight: Option<PreflightSpec>

Named CEL preconditions evaluated before each backup run; opt-in (absent ⇒ no preflight). A failing check holds the Snapshot in Pending (PreflightFailed) and, after timeout, fails it.

suspend: bool

Pause this recipe declaratively (schedules and reconcile skip a suspended policy).

hooks: Option<Hooks>

Pre/post snapshot hooks that run in the workload, not the mover.

mover: Option<MoverSpec>

Per-recipe mover overrides (resources, cache, security context).

credential_projection: Option<CredentialProjection>

Opt-in credential-Secret projection into each backup mover’s namespace (default off).

deletion: Option<PolicyDeletionSpec>

Deletion semantics for the Snapshot CRs carrying this recipe’s config label.

adoption: Option<SnapshotAdoption>

Per-policy override of automatic adoption for discovered snapshots whose resolved identity matches this recipe; absent inherits the repository’s catalog.adoption (see effective_adoption).

Trait Implementations

impl Clone for SnapshotPolicySpec

fn clone(&self) -> SnapshotPolicySpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SnapshotPolicySpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SnapshotPolicySpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for SnapshotPolicySpec

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for SnapshotPolicySpec

fn eq(&self, other: &SnapshotPolicySpec) -> 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 SnapshotPolicySpec

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SnapshotPolicySpec