Class: HCloud::StorageBox

Inherits:

Resource

• Object
• Resource
• HCloud::StorageBox

Defined in:

lib/hcloud/resources/storage_box.rb

Overview

Represents a storage box

List all storage boxes

HCloud::StorageBox.all
# => [#<HCloud::StorageBox id: 1, ...>, ...]

Search storage boxes

HCloud::StorageBox.where(name: "my_storage_box")
# => #<HCloud::StorageBox id: 1, ...>

HCloud::StorageBox.where(label_selector: "environment=production")
# => #<HCloud::StorageBox id: 1, ...>

Find storage box by ID

HCloud::StorageBox.find(1)
# => #<HCloud::StorageBox id: 1, ...>

Create storage box

storage_box = HCloud::StorageBox.new(name: "my_storage_box", storage_box_type: "bx20", location: "fsn1", password: "my_password")
storage_box.create
storage_box.created?
# => true

storage_box = HCloud::StorageBox.create(name: "my_storage_box", storage_box_type: "bx20", location: "fsn1", password: "my_password")
# => #<HCloud::Action id: 1, ...>

Note: this method returns a {HCloud::Action} instance rather than the created resource itself

Update storage box

storage_box = HCloud::StorageBox.find(1)
storage_box.name = "another_storage_box"
storage_box.update

Delete storage box

storage_box = HCloud::StorageBox.find(1)
storage_box.delete
# => #<HCloud::Action id: 1, ...>

storage_box.deleted?
# => true

Note: this method returns a {HCloud::Action} instance rather than the deleted resource itself

List storage box contents

storage_box = HCloud::StorageBox.find(1)
storage_box.contents
# => ["photos", "documents", ...]

storage_box = HCloud::StorageBox.find(1)
storage_box.contents(folder: "photos")
# => ["photo1.jpg", "photo2.jpg", ...]

Actions

List actions

actions = HCloud::StorageBox.find(1).actions
# => [#<HCloud::Action id: 1, ...>, ...]

Sort actions

HCloud::StorageBox.find(1).actions.sort(finished: :desc)
# => [#<HCloud::Action id: 1, ...>, ...]

HCloud::StorageBox.find(1).actions.sort(:command, finished: :asc)
# => [#<HCloud::Actions id: 1, ...>, ...]

Search actions

HCloud::StorageBox.find(1).actions.where(command: "start_resource")
# => #<HCloud::Action id: 1, ...>

HCloud::StorageBox.find(1).actions.where(status: "success")
# => #<HCloud::Action id: 1, ...>

Find action by ID

HCloud::StorageBox.find(1).actions.find(1)
# => #<HCloud::Action id: 1, ...>

Resource-specific actions

Change type

HCloud::StorageBox.find(1).change_type(storage_box_type: "bx21")
# => #<HCloud::Action id: 1, ...>

Reset password

HCloud::StorageBox.find(1).reset_password(password: "mypassword")
# => #<HCloud::Action id: 1, ...>

Update access settings

HCloud::StorageBox.find(1).update_access_settings(samba_enabled: false, ssh_enabled: true, webdav_enabled: false, zfs_enabled: false, reachable_externally: false)
# => #<HCloud::Action id: 1, ...>

Enable snapshot plan

HCloud::StorageBox.find(1).enable_snapshot_plan(max_snapshots: 10, minute: 30, hour: 3, day_of_week: nil, day_of_month: nil)
# => #<HCloud::Action id: 1, ...>

Disable snapshot plan

HCloud::StorageBox.find(1).disable_snapshot_plan
# => #<HCloud::Action id: 1, ...>

Rollback snapshot

HCloud::StorageBox.find(1).rollback_snapshot(snapshot_id: 42)
# => #<HCloud::Action id: 1, ...>

Change protection

HCloud::StorageBox.find(1).change_protection(delete: true)
# => #<HCloud::Action id: 1, ...>

Snapshots

See StorageBoxSnapshot for more information on snapshots.

Subaccounts

See StorageBoxSubaccount for more information on subaccounts.

Class Method Summary

• .client ⇒ Object

Instance Method Summary

• #contents(path: nil) ⇒ Object
• #creatable_attributes ⇒ Object
• #updatable_attributes ⇒ Object

Methods inherited from Resource

#==, attribute, #initialize, #inspect, resource_name, #to_h

Constructor Details

This class inherits a constructor from HCloud::Resource

Class Method Details

.client ⇒ Object

# File 'lib/hcloud/resources/storage_box.rb', line 191

def self.client
  HCloud::Client.connection.storage_box_client
end

Instance Method Details

#contents(path: nil) ⇒ Object

# File 'lib/hcloud/resources/storage_box.rb', line 177

def contents(path: nil)
  client
    .get("#{resource_path}/#{id}/folders", path: path)
    .fetch(:folders)
end

#creatable_attributes ⇒ Object

# File 'lib/hcloud/resources/storage_box.rb', line 183

def creatable_attributes
  [:name, :storage_box_type, :password, :ssh_keys, :location, :labels, access_settings: [:samba_enabled, :ssh_enabled, :webdav_enabled, :zfs_enabled, :reachable_externally]]
end

#updatable_attributes ⇒ Object

# File 'lib/hcloud/resources/storage_box.rb', line 187

def updatable_attributes
  [:name, :labels]
end