Class: IbmCloudPower::Snapshot

Inherits:
Object
  • Object
show all
Defined in:
lib/ibm_cloud_power/models/snapshot.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Snapshot

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/ibm_cloud_power/models/snapshot.rb', line 87

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IbmCloudPower::Snapshot` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `IbmCloudPower::Snapshot`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'snapshot_id')
    self.snapshot_id = attributes[:'snapshot_id']
  end

  if attributes.key?(:'pvm_instance_id')
    self.pvm_instance_id = attributes[:'pvm_instance_id']
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.key?(:'volume_snapshots')
    if (value = attributes[:'volume_snapshots']).is_a?(Hash)
      self.volume_snapshots = value
    end
  end

  if attributes.key?(:'creation_date')
    self.creation_date = attributes[:'creation_date']
  end

  if attributes.key?(:'last_update_date')
    self.last_update_date = attributes[:'last_update_date']
  end

  if attributes.key?(:'action')
    self.action = attributes[:'action']
  end

  if attributes.key?(:'percent_complete')
    self.percent_complete = attributes[:'percent_complete']
  end
end

Instance Attribute Details

#action ⇒ Object

Action performed on the instance snapshot



42
43
44
 
# File 'lib/ibm_cloud_power/models/snapshot.rb', line 42

def action
  @action
end

#creation_date ⇒ Object

Creation Date



36
37
38
 
# File 'lib/ibm_cloud_power/models/snapshot.rb', line 36

def creation_date
  @creation_date
end

#description ⇒ Object

Description of the PVM instance snapshot



27
28
29
 
# File 'lib/ibm_cloud_power/models/snapshot.rb', line 27

def description
  @description
end

#last_update_date ⇒ Object

Last Update Date



39
40
41
 
# File 'lib/ibm_cloud_power/models/snapshot.rb', line 39

def last_update_date
  @last_update_date
end

#name ⇒ Object

Name of the PVM instance snapshot



24
25
26
 
# File 'lib/ibm_cloud_power/models/snapshot.rb', line 24

def name
  @name
end

#percent_complete ⇒ Object

Snapshot completion percentage



45
46
47
 
# File 'lib/ibm_cloud_power/models/snapshot.rb', line 45

def percent_complete
  @percent_complete
end

#pvm_instance_id ⇒ Object

PCloud PVM Instance ID



21
22
23
 
# File 'lib/ibm_cloud_power/models/snapshot.rb', line 21

def pvm_instance_id
  @pvm_instance_id
end

#snapshot_id ⇒ Object

ID of the PVM instance snapshot



18
19
20
 
# File 'lib/ibm_cloud_power/models/snapshot.rb', line 18

def snapshot_id
  @snapshot_id
end

#status ⇒ Object

Status of the PVM instancesnapshot



30
31
32
 
# File 'lib/ibm_cloud_power/models/snapshot.rb', line 30

def status
  @status
end

#volume_snapshots ⇒ Object

A map of volume snapshots included in the PVM instance snapshot



33
34
35
 
# File 'lib/ibm_cloud_power/models/snapshot.rb', line 33

def volume_snapshots
  @volume_snapshots
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/ibm_cloud_power/models/snapshot.rb', line 48

def self.attribute_map
  {
    :'snapshot_id' => :'snapshotID',
    :'pvm_instance_id' => :'pvmInstanceID',
    :'name' => :'name',
    :'description' => :'description',
    :'status' => :'status',
    :'volume_snapshots' => :'volumeSnapshots',
    :'creation_date' => :'creationDate',
    :'last_update_date' => :'lastUpdateDate',
    :'action' => :'action',
    :'percent_complete' => :'percentComplete'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



208
209
210
 
# File 'lib/ibm_cloud_power/models/snapshot.rb', line 208

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



80
81
82
83
 
# File 'lib/ibm_cloud_power/models/snapshot.rb', line 80

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/ibm_cloud_power/models/snapshot.rb', line 64

def self.openapi_types
  {
    :'snapshot_id' => :'String',
    :'pvm_instance_id' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'status' => :'String',
    :'volume_snapshots' => :'Hash<String, String>',
    :'creation_date' => :'DateTime',
    :'last_update_date' => :'DateTime',
    :'action' => :'String',
    :'percent_complete' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/ibm_cloud_power/models/snapshot.rb', line 178

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      snapshot_id == o.snapshot_id &&
      pvm_instance_id == o.pvm_instance_id &&
      name == o.name &&
      description == o.description &&
      status == o.status &&
      volume_snapshots == o.volume_snapshots &&
      creation_date == o.creation_date &&
      last_update_date == o.last_update_date &&
      action == o.action &&
      percent_complete == o.percent_complete
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/ibm_cloud_power/models/snapshot.rb', line 238

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    IbmCloudPower.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/ibm_cloud_power/models/snapshot.rb', line 307

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/ibm_cloud_power/models/snapshot.rb', line 215

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


195
196
197
 
# File 'lib/ibm_cloud_power/models/snapshot.rb', line 195

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



201
202
203
 
# File 'lib/ibm_cloud_power/models/snapshot.rb', line 201

def hash
  [snapshot_id, pvm_instance_id, name, description, status, volume_snapshots, creation_date, last_update_date, action, percent_complete].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/ibm_cloud_power/models/snapshot.rb', line 145

def list_invalid_properties
  invalid_properties = Array.new
  if @snapshot_id.nil?
    invalid_properties.push('invalid value for "snapshot_id", snapshot_id cannot be nil.')
  end

  if @pvm_instance_id.nil?
    invalid_properties.push('invalid value for "pvm_instance_id", pvm_instance_id cannot be nil.')
  end

  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @volume_snapshots.nil?
    invalid_properties.push('invalid value for "volume_snapshots", volume_snapshots cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



283
284
285
 
# File 'lib/ibm_cloud_power/models/snapshot.rb', line 283

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/ibm_cloud_power/models/snapshot.rb', line 289

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



277
278
279
 
# File 'lib/ibm_cloud_power/models/snapshot.rb', line 277

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



168
169
170
171
172
173
174
 
# File 'lib/ibm_cloud_power/models/snapshot.rb', line 168

def valid?
  return false if @snapshot_id.nil?
  return false if @pvm_instance_id.nil?
  return false if @name.nil?
  return false if @volume_snapshots.nil?
  true
end