Class: VBox::Medium

Inherits:
Base
  • Object
show all
Defined in:
lib/virtualbox/classes/medium.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#_this, #delete!, #ensure_hash, #initialize, #vbox_class

Constructor Details

This class inherits a constructor from VBox::Base

Instance Attribute Details

#refObject (readonly)

Returns the value of attribute ref.



4
5
6
# File 'lib/virtualbox/classes/medium.rb', line 4

def ref
  @ref
end

Instance Method Details

#allowed_typesObject



69
70
71
# File 'lib/virtualbox/classes/medium.rb', line 69

def allowed_types
  VBox::WebService.send_request(:i_medium_get_allowed_types, _this)
end

#auto_resetObject



98
99
100
# File 'lib/virtualbox/classes/medium.rb', line 98

def auto_reset
  VBox::WebService.send_request(:i_medium_get_auto_reset, _this)
end

#auto_reset=(auto_reset) ⇒ Object



102
103
104
# File 'lib/virtualbox/classes/medium.rb', line 102

def auto_reset=(auto_reset)
  VBox::WebService.send_request(:i_medium_set_auto_reset, _this.merge(:auto_reset => auto_reset))
end

#baseObject



85
86
87
88
# File 'lib/virtualbox/classes/medium.rb', line 85

def base
  base = VBox::WebService.send_request(:i_medium_get_base, _this)
  VBox::Medium.new(base)
end

#childrenObject



78
79
80
81
82
83
# File 'lib/virtualbox/classes/medium.rb', line 78

def children
  children = VBox::WebService.send_request(:i_medium_get_children, _this)
  children.map do |child|
    VBox::Medium.new(child)
  end
end

#clone_to(args = {}) ⇒ Object

Methods



116
117
118
119
120
121
# File 'lib/virtualbox/classes/medium.rb', line 116

def clone_to(args={})
  ensure_hash(args)
  args[:target] = args[:target].ref if args.has_key?(:target) & args[:target].respond_to?(:ref)
  args[:parent] = args[:parent].ref if args.has_key?(:parent) & args[:parent].respond_to?(:ref)
  VBox::WebService.send_request(:i_medium_clone_to, _this.merge(args))
end

#clone_to_base(args = {}) ⇒ Object



123
124
125
126
127
# File 'lib/virtualbox/classes/medium.rb', line 123

def clone_to_base(args={})
  ensure_hash(args)
  args[:target] = args[:target].ref if args.has_key?(:target) & args[:target].respond_to?(:ref)
  VBox::WebService.send_request(:i_medium_clone_to_base, _this.merge(args))
end

#closeObject



129
130
131
# File 'lib/virtualbox/classes/medium.rb', line 129

def close
  VBox::WebService.send_request(:i_medium_close, _this)
end

#compactObject



133
134
135
136
# File 'lib/virtualbox/classes/medium.rb', line 133

def compact
  progress = VBox::WebService.send_request(:i_medium_close, _this)
  VBox::Progress.new(progress)
end

#create_base_storage(args = {}) ⇒ Object



138
139
140
141
142
# File 'lib/virtualbox/classes/medium.rb', line 138

def create_base_storage(args={})
  ensure_hash(args)
  progress = VBox::WebService.send_request(:i_medium_create_base_storage, _this.merge(args))
  VBox::Progress.new(progress)
end

#create_diff_storage(args = {}) ⇒ Object



144
145
146
147
148
149
# File 'lib/virtualbox/classes/medium.rb', line 144

def create_diff_storage(args={})
  ensure_hash(args)
  args[:target] = args[:target].ref if args.has_key?(:target) & args[:target].respond_to?(:ref)
  progress = VBox::WebService.send_request(:i_medium_create_diff_storage, _this.merge(args))
  VBox::Progress.new(progress)
end

#delete_storageObject



151
152
153
154
# File 'lib/virtualbox/classes/medium.rb', line 151

def delete_storage
  progress = VBox::WebService.send_request(:i_medium_delete_storage, _this)
  VBox::Progress.new(progress)
end

#descriptionObject



12
13
14
# File 'lib/virtualbox/classes/medium.rb', line 12

def description
  VBox::WebService.send_request(:i_medium_get_description, _this)
end

#description=(description) ⇒ Object



16
17
18
# File 'lib/virtualbox/classes/medium.rb', line 16

def description=(description)
  VBox::WebService.send_request(:i_medium_set_description, _this.merge(:description => description))
end

#device_typeObject



40
41
42
# File 'lib/virtualbox/classes/medium.rb', line 40

def device_type
  VBox::WebService.send_request(:i_medium_get_device_type, _this)
end

#formatObject



52
53
54
# File 'lib/virtualbox/classes/medium.rb', line 52

def format
  VBox::WebService.send_request(:i_medium_get_format, _this)
end

#get_properties(args = {}) ⇒ Object



156
157
158
159
# File 'lib/virtualbox/classes/medium.rb', line 156

def get_properties(args={})
  ensure_hash(args)
  VBox::WebService.send_request(:i_medium_get_properties, _this.merge(args))
end

#get_property(args = {}) ⇒ Object



161
162
163
164
# File 'lib/virtualbox/classes/medium.rb', line 161

def get_property(args={})
  ensure_hash(args)
  VBox::WebService.send_request(:i_medium_get_property, _this.merge(args))
end

#get_snapshot_ids(args = {}) ⇒ Object



166
167
168
169
# File 'lib/virtualbox/classes/medium.rb', line 166

def get_snapshot_ids(args={})
  ensure_hash(args)
  VBox::WebService.send_request(:i_medium_get_snapshot_ids, _this.merge(args))
end

#host_driveObject



44
45
46
# File 'lib/virtualbox/classes/medium.rb', line 44

def host_drive
  VBox::WebService.send_request(:i_medium_get_host_drive, _this)
end

#idObject

Attributes



8
9
10
# File 'lib/virtualbox/classes/medium.rb', line 8

def id
  VBox::WebService.send_request(:i_medium_get_id, _this)
end

#last_access_errorObject



106
107
108
# File 'lib/virtualbox/classes/medium.rb', line 106

def last_access_error
  VBox::WebService.send_request(:i_medium_get_last_access_error, _this)
end

#locationObject



28
29
30
# File 'lib/virtualbox/classes/medium.rb', line 28

def location
  VBox::WebService.send_request(:i_medium_get_location, _this)
end

#location=(location) ⇒ Object



32
33
34
# File 'lib/virtualbox/classes/medium.rb', line 32

def location=(location)
  VBox::WebService.send_request(:i_medium_set_location, _this.merge(:location => location))
end

#lock_readObject



171
172
173
# File 'lib/virtualbox/classes/medium.rb', line 171

def lock_read
  VBox::WebService.send_request(:i_medium_lock_read, _this.merge(args))
end

#lock_writeObject



175
176
177
# File 'lib/virtualbox/classes/medium.rb', line 175

def lock_write
  VBox::WebService.send_request(:i_medium_lock_write, _this.merge(args))
end

#logical_sizeObject



94
95
96
# File 'lib/virtualbox/classes/medium.rb', line 94

def logical_size
  VBox::WebService.send_request(:i_medium_get_logical_size, _this)
end

#machine_idsObject



110
111
112
# File 'lib/virtualbox/classes/medium.rb', line 110

def machine_ids
  VBox::WebService.send_request(:i_medium_get_machine_ids, _this)
end

#medium_formatObject



56
57
58
59
# File 'lib/virtualbox/classes/medium.rb', line 56

def medium_format
  medium_format = VBox::WebService.send_request(:i_medium_get_medium_format, _this)
  VBox::MediumFormat.new(medium_format)
end

#merge_to(args = {}) ⇒ Object



179
180
181
182
183
184
# File 'lib/virtualbox/classes/medium.rb', line 179

def merge_to(args={})
  ensure_hash(args)
  args[:target] = args[:target].ref if args.has_key?(:target) & args[:target].respond_to?(:ref)
  progress = VBox::WebService.send_request(:i_medium_delete_storage, _this.merge(args))
  VBox::Progress.new(progress)
end

#nameObject



36
37
38
# File 'lib/virtualbox/classes/medium.rb', line 36

def name
  VBox::WebService.send_request(:i_medium_get_name, _this)
end

#parentObject



73
74
75
76
# File 'lib/virtualbox/classes/medium.rb', line 73

def parent
  parent = VBox::WebService.send_request(:i_medium_get_parent, _this)
  VBox::Medium.new(parent)
end

#read_onlyObject



90
91
92
# File 'lib/virtualbox/classes/medium.rb', line 90

def read_only
  VBox::WebService.send_request(:i_medium_get_read_only, _this)
end

#refresh_stateObject



186
187
188
# File 'lib/virtualbox/classes/medium.rb', line 186

def refresh_state
  VBox::WebService.send_request(:i_medium_refresh_state, _this)
end

#resetObject



190
191
192
193
# File 'lib/virtualbox/classes/medium.rb', line 190

def reset
  progress = VBox::WebService.send_request(:i_medium_reset, _this)
  VBox::Progress.new(progress)
end

#resize(args = {}) ⇒ Object



195
196
197
198
199
# File 'lib/virtualbox/classes/medium.rb', line 195

def resize(args={})
  ensure_hash(args)
  progress = VBox::WebService.send_request(:i_medium_resize, _this.merge(args))
  VBox::Progress.new(progress)
end

#set_ids(args = {}) ⇒ Object



201
202
203
204
# File 'lib/virtualbox/classes/medium.rb', line 201

def set_ids(args={})
  ensure_hash(args)
  VBox::WebService.send_request(:i_medium_set_ids, _this.merge(args))
end

#set_properties(args = {}) ⇒ Object



206
207
208
209
# File 'lib/virtualbox/classes/medium.rb', line 206

def set_properties(args={})
  ensure_hash(args)
  VBox::WebService.send_request(:i_medium_set_properties, _this.merge(args))
end

#set_property(args = {}) ⇒ Object



211
212
213
214
# File 'lib/virtualbox/classes/medium.rb', line 211

def set_property(args={})
  ensure_hash(args)
  VBox::WebService.send_request(:i_medium_set_property, _this.merge(args))
end

#sizeObject



48
49
50
# File 'lib/virtualbox/classes/medium.rb', line 48

def size
  VBox::WebService.send_request(:i_medium_get_size, _this)
end

#stateObject



20
21
22
# File 'lib/virtualbox/classes/medium.rb', line 20

def state
  VBox::WebService.send_request(:i_medium_get_state, _this)
end

#typeObject



61
62
63
# File 'lib/virtualbox/classes/medium.rb', line 61

def type
  VBox::WebService.send_request(:i_medium_get_type, _this)
end

#type=(type) ⇒ Object



65
66
67
# File 'lib/virtualbox/classes/medium.rb', line 65

def type=(type)
  VBox::WebService.send_request(:i_medium_set_type, _this.merge(:type => type))
end

#unlock_readObject



216
217
218
# File 'lib/virtualbox/classes/medium.rb', line 216

def unlock_read
  VBox::WebService.send_request(:i_medium_unlock_read, _this.merge(args))
end

#unlock_writeObject



220
221
222
# File 'lib/virtualbox/classes/medium.rb', line 220

def unlock_write
  VBox::WebService.send_request(:i_medium_unlock_write, _this.merge(args))
end

#variantObject



24
25
26
# File 'lib/virtualbox/classes/medium.rb', line 24

def variant
  VBox::WebService.send_request(:i_medium_get_variant, _this)
end