Ruby SDK Volumes reference

See Volumes for storage behavior. Ruby exposes named-volume management but not the complete mount builder available in Rust.

Volume

Microsandbox::Volume.builder()

Microsandbox::Volume.builder(name) # => VolumeBuilder

Configure a named volume.

Parameters

nameString

Volume name.

Returns

VolumeBuilder

A volume builder.

Microsandbox::Volume.get()

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()

Microsandbox::Volume.list # => Array<VolumeHandle>

Returns

Array<VolumeHandle>

List named volumes.

Microsandbox::Volume.remove()

Microsandbox::Volume.remove(name) # => nil

Remove a named volume.

Parameters

nameString

Volume name.

Returns

nil

No return value.

VolumeBuilder

builder.directory()

builder.directory # => VolumeBuilder

Returns

VolumeBuilder

Select a directory volume.

builder.disk()

builder.disk # => VolumeBuilder

Returns

VolumeBuilder

Select a disk volume (local only).

builder.quota()

builder.quota(mib) # => VolumeBuilder

Set quota in MiB.

Parameters

mibInteger

Capacity in MiB.

Returns

VolumeBuilder

This builder for chaining.

builder.size()

builder.size(mib) # => VolumeBuilder

Set disk size in MiB.

Parameters

mibInteger

Capacity in MiB.

Returns

VolumeBuilder

This builder for chaining.

builder.label()

builder.label(key, value) # => VolumeBuilder

Add a string label.

Parameters

keyString

Label key.

valueString

Label value.

Returns

VolumeBuilder

This builder for chaining.

builder.create()

builder.create # => VolumeHandle

Example

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

volume.name # => String

Returns

String

Volume name.

volume.kind

volume.kind # => String

Returns

String

dir or disk.

volume.quota_mib

volume.quota_mib # => Integer | nil

Returns

Integer | nil

Configured quota.

volume.used_bytes

volume.used_bytes # => Integer

Returns

Integer

Used bytes.

volume.capacity_bytes

volume.capacity_bytes # => Integer | nil

Returns

Integer | nil

Capacity.

volume.labels

volume.labels # => Hash

Returns

Hash

String keys and values.

volume.created_at

volume.created_at # => String | nil

Returns

String | nil

RFC 3339 creation timestamp.

volume.remove()

volume.remove # => nil

Remove this volume.

Returns

nil

No return value.

Getting Started

SDKs

CLI

Volumes

Volume

Microsandbox::Volume.builder()

Microsandbox::Volume.get()

Microsandbox::Volume.list()

Microsandbox::Volume.remove()

VolumeBuilder

builder.directory()

builder.disk()

builder.quota()

builder.size()

builder.label()

builder.create()

VolumeHandle

volume.name

volume.kind

volume.quota_mib

volume.used_bytes

volume.capacity_bytes

volume.labels

volume.created_at

volume.remove()

​Volume

​Microsandbox::Volume.builder()

​Microsandbox::Volume.get()

​Microsandbox::Volume.list()

​Microsandbox::Volume.remove()

​VolumeBuilder

​builder.directory()

​builder.disk()

​builder.quota()

​builder.size()

​builder.label()

​builder.create()

​VolumeHandle

​volume.name

​volume.kind

​volume.quota_mib

​volume.used_bytes

​volume.capacity_bytes

​volume.labels

​volume.created_at

​volume.remove()

Volume

Microsandbox::Volume.builder()

Microsandbox::Volume.get()

Microsandbox::Volume.list()

Microsandbox::Volume.remove()

VolumeBuilder

builder.directory()

builder.disk()

builder.quota()

builder.size()

builder.label()

builder.create()

VolumeHandle

volume.name

volume.kind

volume.quota_mib

volume.used_bytes

volume.capacity_bytes

volume.labels

volume.created_at

volume.remove()