SnapshotService

SnapshotService class for Daytona SDK.

Constructors

new SnapshotService()

ruby

def initialize(snapshots_api:, object_storage_api:, default_region_id:, otel_state:)

Parameters:

snapshots_api DaytonaApiClient:SnapshotsApi - The snapshots API client
object_storage_api DaytonaApiClient:ObjectStorageApi - The object storage API client
default_region_id String, nil - Default region ID for snapshot creation
otel_state Daytona:OtelState, nil -

Returns:

SnapshotService - a new instance of SnapshotService

Methods

list()

ruby

def list(page:, limit:)

List all Snapshots.

Parameters:

page Integer, Nil -
limit Integer, Nil -

Returns:

Daytona:PaginatedResource - Paginated list of all Snapshots

Raises:

Daytona:Sdk:Error -

Examples:

ruby

daytona = Daytona::Daytona.new
response = daytona.snapshot.list(page: 1, limit: 10)
snapshots.items.each { |snapshot| puts "#{snapshot.name} (#{snapshot.image_name})" }

delete()

ruby

def delete(snapshot)

Delete a Snapshot.

Parameters:

snapshot Daytona:Snapshot - Snapshot to delete

Returns:

void

Examples:

ruby

daytona = Daytona::Daytona.new
snapshot = daytona.snapshot.get("demo")
daytona.snapshot.delete(snapshot)
puts "Snapshot deleted"

get()

ruby

def get(name)

Get a Snapshot by name.

Parameters:

name String - Name of the Snapshot to get

Returns:

Daytona:Snapshot - The Snapshot object

Examples:

ruby

daytona = Daytona::Daytona.new
snapshot = daytona.snapshot.get("demo")
puts "#{snapshot.name} (#{snapshot.image_name})"

create()

ruby

def create(params, on_logs:)

Creates and registers a new snapshot from the given Image definition.

Parameters:

params Daytona:CreateSnapshotParams - Parameters for snapshot creation
on_logs Proc, Nil - Callback proc handling snapshot creation logs

Returns:

Daytona:Snapshot - The created snapshot

Examples:

ruby

image = Image.debianSlim('3.12').pipInstall('numpy')
params = CreateSnapshotParams.new(name: 'my-snapshot', image: image)
snapshot = daytona.snapshot.create(params) do |chunk|
  print chunk
end

activate()

ruby

def activate(snapshot)

Activate a snapshot

Parameters:

snapshot Daytona:Snapshot - The snapshot instance

Returns:

Daytona:Snapshot