Class BackupRetentionResult

Namespace

Typhon.Engine

Assembly

Typhon.Engine.dll

What a retention did.

public sealed record BackupRetentionResult : IEquatable<BackupRetentionResult>

Inheritance

object

BackupRetentionResult

Implements

IEquatable<BackupRetentionResult>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

BackupRetentionResult(BackupRetentionPlan, IReadOnlyList<BackupCompactionResult>, IReadOnlyList<string>, long, TimeSpan, IReadOnlyList<BackupCompactionFailure>)

What a retention did.

public BackupRetentionResult(BackupRetentionPlan Plan, IReadOnlyList<BackupCompactionResult> Compactions, IReadOnlyList<string> Deleted, long BytesFreed, TimeSpan Duration, IReadOnlyList<BackupCompactionFailure> FailedCompactions)

Parameters

Plan BackupRetentionPlan

The plan it applied: the compactions it attempted, then the deletions re-planned on what they published.

Compactions IReadOnlyList<BackupCompactionResult>

The compactions it ran, failed ones excluded (their chains keep every pack this run).

Deleted IReadOnlyList<string>

The pack files deleted, in order.

BytesFreed long

Their bytes, minus the compacted packs written.

Duration TimeSpan

Wall time.

FailedCompactions IReadOnlyList<BackupCompactionFailure>

The compactions attempted that did not publish, and why.

Properties

BytesFreed

Their bytes, minus the compacted packs written.

public long BytesFreed { get; init; }

Property Value

long

Compactions

The compactions it ran, failed ones excluded (their chains keep every pack this run).

public IReadOnlyList<BackupCompactionResult> Compactions { get; init; }

Property Value

IReadOnlyList<BackupCompactionResult>

Deleted

The pack files deleted, in order.

public IReadOnlyList<string> Deleted { get; init; }

Property Value

IReadOnlyList<string>

Duration

Wall time.

public TimeSpan Duration { get; init; }

Property Value

TimeSpan

FailedCompactions

The compactions attempted that did not publish, and why.

public IReadOnlyList<BackupCompactionFailure> FailedCompactions { get; init; }

Property Value

IReadOnlyList<BackupCompactionFailure>

Plan

The plan it applied: the compactions it attempted, then the deletions re-planned on what they published.

public BackupRetentionPlan Plan { get; init; }

Property Value

BackupRetentionPlan

Methods

Deconstruct(out BackupRetentionPlan, out IReadOnlyList<BackupCompactionResult>, out IReadOnlyList<string>, out long, out TimeSpan, out IReadOnlyList<BackupCompactionFailure>)

public void Deconstruct(out BackupRetentionPlan Plan, out IReadOnlyList<BackupCompactionResult> Compactions, out IReadOnlyList<string> Deleted, out long BytesFreed, out TimeSpan Duration, out IReadOnlyList<BackupCompactionFailure> FailedCompactions)

Parameters

Plan BackupRetentionPlan

Compactions IReadOnlyList<BackupCompactionResult>

Deleted IReadOnlyList<string>

BytesFreed long

Duration TimeSpan

FailedCompactions IReadOnlyList<BackupCompactionFailure>

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

Equals(BackupRetentionResult?)

public bool Equals(BackupRetentionResult? other)

Parameters

other BackupRetentionResult

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

Operators

operator ==(BackupRetentionResult?, BackupRetentionResult?)

public static bool operator ==(BackupRetentionResult? left, BackupRetentionResult? right)

Parameters

left BackupRetentionResult

right BackupRetentionResult

Returns

bool

operator !=(BackupRetentionResult?, BackupRetentionResult?)

public static bool operator !=(BackupRetentionResult? left, BackupRetentionResult? right)

Parameters

left BackupRetentionResult

right BackupRetentionResult

Returns

bool