VolumeDefinition Class

Namespace: Meziantou.Framework.TemporaryContainers
Assembly: Meziantou.Framework.TemporaryContainers.dll
Package: Meziantou.Framework.TemporaryContainers 1.1.13
Source: VolumeDefinition.cs
Available in package assets: net10.0net11.0

Describes how a volume should be created. Configure an instance and call VolumeDefinition.CreateVolume to obtain a TemporaryVolume.

public sealed class VolumeDefinition

Example

await using var volume = new VolumeDefinition().CreateVolume();

var definition = new ContainerDefinition(ImageSource.FromRegistry("redis:8"));
definition.Mounts.AddVolume(volume, "/data");

await using var container = definition.CreateContainer();
await container.StartAsync();

Constructors

Name	Description
VolumeDefinition()	Initializes a new instance of the `VolumeDefinition` class.
VolumeDefinition(VolumeDefinition)	Initializes a new instance of the `VolumeDefinition` class by deep-copying another definition. The copy can be changed even when `other` belongs to a volume.

VolumeDefinition overloads

VolumeDefinition()

VolumeDefinition.cs

Initializes a new instance of the VolumeDefinition class.

public VolumeDefinition()

VolumeDefinition(VolumeDefinition)

VolumeDefinition.cs

Initializes a new instance of the VolumeDefinition class by deep-copying another definition. The copy can be changed even when other belongs to a volume.

public VolumeDefinition(VolumeDefinition other)

Parameters

other VolumeDefinition: The definition to copy.

Properties

Name	Description
Driver	Gets or sets the volume driver. When `null`, the runtime uses its default driver.
DriverOptions	Gets the driver-specific options.
IsReadOnly	Gets a value indicating whether the definition belongs to a volume, in which case it can no longer be changed.
Labels	Gets the labels.
Name	Gets or sets the volume name. When `null`, a random name is generated, or a name derived from `VolumeDefinition.ReuseId` when that is set.
ReuseId	Gets or sets an identifier used to reuse an existing volume across runs. When set, the volume is not removed on dispose.
Runtime	Gets or sets the container runtime to use.

Driver

VolumeDefinition.cs

Gets or sets the volume driver. When null, the runtime uses its default driver.

public string? Driver { get; set; }

Property value

string?

DriverOptions

VolumeDefinition.cs

Gets the driver-specific options.

public VolumeDriverOptionCollection DriverOptions { get; }

Property value

VolumeDriverOptionCollection

IsReadOnly

VolumeDefinition.cs

Gets a value indicating whether the definition belongs to a volume, in which case it can no longer be changed.

public bool IsReadOnly { get; }

Property value

bool

Labels

VolumeDefinition.cs

Gets the labels.

public ContainerLabelCollection Labels { get; }

Property value

ContainerLabelCollection

Name

VolumeDefinition.cs

Gets or sets the volume name. When null, a random name is generated, or a name derived from VolumeDefinition.ReuseId when that is set.

public string? Name { get; set; }

Property value

string?

ReuseId

VolumeDefinition.cs

Gets or sets an identifier used to reuse an existing volume across runs. When set, the volume is not removed on dispose.

public string? ReuseId { get; set; }

Property value

string?

Runtime

VolumeDefinition.cs

Gets or sets the container runtime to use.

public ContainerRuntime Runtime { get; set; }

Property value

ContainerRuntime

Methods

Name	Description
CreateVolume()	Creates a `TemporaryVolume` from a deep copy of this definition. Later changes to this definition do not affect the returned volume, and the copy the volume owns cannot be changed.

CreateVolume()

VolumeDefinition.cs

Creates a TemporaryVolume from a deep copy of this definition. Later changes to this definition do not affect the returned volume, and the copy the volume owns cannot be changed.

public TemporaryVolume CreateVolume()

Returns

TemporaryVolume A new volume.