--- title: Volumes "og:title": Ruby SDK Volumes reference description: Create and manage named volumes with the Ruby SDK. --- See [Volumes](/sandboxes/volumes) for storage behavior. Ruby exposes named-volume management but not the complete mount builder available in Rust. ## Volume #### Microsandbox::Volume.builder() ```ruby Microsandbox::Volume.builder(name) # => VolumeBuilder ``` Configure a named volume.

Parameters

nameString

Volume name.

Returns

VolumeBuilder

A volume builder.

#### Microsandbox::Volume.get() ```ruby Microsandbox::Volume.get(name) # => VolumeHandle ``` Look up a named volume.

Parameters

nameString

Volume name.

Returns

VolumeHandle

Metadata and filesystem access for the named volume.

#### Microsandbox::Volume.list() ```ruby Microsandbox::Volume.list # => Array ```

Returns

Array<VolumeHandle>

List named volumes.

#### Microsandbox::Volume.remove() ```ruby Microsandbox::Volume.remove(name) # => nil ``` Remove a named volume.

Parameters

nameString

Volume name.

Returns

nil

No return value.

## VolumeBuilder #### builder.directory() ```ruby builder.directory # => VolumeBuilder ```

Returns

VolumeBuilder

Select a directory volume.

#### builder.disk() ```ruby builder.disk # => VolumeBuilder ```

Returns

VolumeBuilder

Select a disk volume (local only).

#### builder.quota() ```ruby builder.quota(mib) # => VolumeBuilder ``` Set quota in MiB.

Parameters

mibInteger

Capacity in MiB.

Returns

VolumeBuilder

This builder for chaining.

#### builder.size() ```ruby builder.size(mib) # => VolumeBuilder ``` Set disk size in MiB.

Parameters

mibInteger

Capacity in MiB.

Returns

VolumeBuilder

This builder for chaining.

#### builder.label() ```ruby builder.label(key, value) # => VolumeBuilder ``` Add a string label.

Parameters

keyString

Label key.

valueString

Label value.

Returns

VolumeBuilder

This builder for chaining.

#### builder.create() ```ruby builder.create # => VolumeHandle ``` ```ruby volume = Microsandbox::Volume.builder("build-cache") .directory .label("purpose", "build") .create puts volume.name ``` Create the volume; consumes the builder.

Returns

VolumeHandle

The created volume handle.

## VolumeHandle #### volume.name ```ruby volume.name # => String ```

Returns

String

Volume name.

#### volume.kind ```ruby volume.kind # => String ```

Returns

String

dir or disk.

#### volume.quota_mib ```ruby volume.quota_mib # => Integer | nil ```

Returns

Integer | nil

Configured quota.

#### volume.used_bytes ```ruby volume.used_bytes # => Integer ```

Returns

Integer

Used bytes.

#### volume.capacity_bytes ```ruby volume.capacity_bytes # => Integer | nil ```

Returns

Integer | nil

Capacity.

#### volume.labels ```ruby volume.labels # => Hash ```

Returns

Hash

String keys and values.

#### volume.created_at ```ruby volume.created_at # => String | nil ```

Returns

String | nil

RFC 3339 creation timestamp.

#### volume.remove() ```ruby volume.remove # => nil ``` Remove this volume.

Returns

nil

No return value.