Class: IbmCloudPower::PVMInstanceCapture

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PVMInstanceCapture

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
142
143
144
 
# File 'lib/ibm_cloud_power/models/pvm_instance_capture.rb', line 100

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IbmCloudPower::PVMInstanceCapture` 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::PVMInstanceCapture`. 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?(:'capture_destination')
    self.capture_destination = attributes[:'capture_destination']
  else
    self.capture_destination = 'cloud-storage'
  end

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

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

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

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

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

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

Instance Attribute Details

#capture_destination ⇒ Object

Destination for the deployable image



19
20
21
 
# File 'lib/ibm_cloud_power/models/pvm_instance_capture.rb', line 19

def capture_destination
  @capture_destination
end

#capture_name ⇒ Object

Name of the deployable image created for the captured PVMInstance



22
23
24
 
# File 'lib/ibm_cloud_power/models/pvm_instance_capture.rb', line 22

def capture_name
  @capture_name
end

#capture_volume_ids ⇒ Object

List of Data volume IDs to include in the captured PVMInstance



25
26
27
 
# File 'lib/ibm_cloud_power/models/pvm_instance_capture.rb', line 25

def capture_volume_ids
  @capture_volume_ids
end

#cloud_storage_access_key ⇒ Object

Cloud Storage Access key



28
29
30
 
# File 'lib/ibm_cloud_power/models/pvm_instance_capture.rb', line 28

def cloud_storage_access_key
  @cloud_storage_access_key
end

#cloud_storage_image_path ⇒ Object

Cloud Storage Image Path (bucket-name [/folder/../..])



31
32
33
 
# File 'lib/ibm_cloud_power/models/pvm_instance_capture.rb', line 31

def cloud_storage_image_path
  @cloud_storage_image_path
end

#cloud_storage_region ⇒ Object

Cloud Storage Region



34
35
36
 
# File 'lib/ibm_cloud_power/models/pvm_instance_capture.rb', line 34

def cloud_storage_region
  @cloud_storage_region
end

#cloud_storage_secret_key ⇒ Object

Cloud Storage Secret key



37
38
39
 
# File 'lib/ibm_cloud_power/models/pvm_instance_capture.rb', line 37

def cloud_storage_secret_key
  @cloud_storage_secret_key
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



75
76
77
 
# File 'lib/ibm_cloud_power/models/pvm_instance_capture.rb', line 75

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/ibm_cloud_power/models/pvm_instance_capture.rb', line 62

def self.attribute_map
  {
    :'capture_destination' => :'captureDestination',
    :'capture_name' => :'captureName',
    :'capture_volume_ids' => :'captureVolumeIDs',
    :'cloud_storage_access_key' => :'cloudStorageAccessKey',
    :'cloud_storage_image_path' => :'cloudStorageImagePath',
    :'cloud_storage_region' => :'cloudStorageRegion',
    :'cloud_storage_secret_key' => :'cloudStorageSecretKey'
  }
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



210
211
212
 
# File 'lib/ibm_cloud_power/models/pvm_instance_capture.rb', line 210

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



93
94
95
96
 
# File 'lib/ibm_cloud_power/models/pvm_instance_capture.rb', line 93

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

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/ibm_cloud_power/models/pvm_instance_capture.rb', line 80

def self.openapi_types
  {
    :'capture_destination' => :'String',
    :'capture_name' => :'String',
    :'capture_volume_ids' => :'Array<String>',
    :'cloud_storage_access_key' => :'String',
    :'cloud_storage_image_path' => :'String',
    :'cloud_storage_region' => :'String',
    :'cloud_storage_secret_key' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/ibm_cloud_power/models/pvm_instance_capture.rb', line 183

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      capture_destination == o.capture_destination &&
      capture_name == o.capture_name &&
      capture_volume_ids == o.capture_volume_ids &&
      cloud_storage_access_key == o.cloud_storage_access_key &&
      cloud_storage_image_path == o.cloud_storage_image_path &&
      cloud_storage_region == o.cloud_storage_region &&
      cloud_storage_secret_key == o.cloud_storage_secret_key
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



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
274
275
276
277
278
 
# File 'lib/ibm_cloud_power/models/pvm_instance_capture.rb', line 241

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = IbmCloudPower.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/ibm_cloud_power/models/pvm_instance_capture.rb', line 312

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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/ibm_cloud_power/models/pvm_instance_capture.rb', line 217

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


197
198
199
 
# File 'lib/ibm_cloud_power/models/pvm_instance_capture.rb', line 197

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



203
204
205
 
# File 'lib/ibm_cloud_power/models/pvm_instance_capture.rb', line 203

def hash
  [capture_destination, capture_name, capture_volume_ids, cloud_storage_access_key, cloud_storage_image_path, cloud_storage_region, cloud_storage_secret_key].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



148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/ibm_cloud_power/models/pvm_instance_capture.rb', line 148

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

  if @capture_name.nil?
    invalid_properties.push('invalid value for "capture_name", capture_name 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



288
289
290
 
# File 'lib/ibm_cloud_power/models/pvm_instance_capture.rb', line 288

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



294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/ibm_cloud_power/models/pvm_instance_capture.rb', line 294

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



282
283
284
 
# File 'lib/ibm_cloud_power/models/pvm_instance_capture.rb', line 282

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



163
164
165
166
167
168
169
 
# File 'lib/ibm_cloud_power/models/pvm_instance_capture.rb', line 163

def valid?
  return false if @capture_destination.nil?
  capture_destination_validator = EnumAttributeValidator.new('String', ["image-catalog", "cloud-storage", "both"])
  return false unless capture_destination_validator.valid?(@capture_destination)
  return false if @capture_name.nil?
  true
end