Class: IbmCloudPower::CloudInstance

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CloudInstance

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
142
143
144
145
146
147
148
149
150
 
# File 'lib/ibm_cloud_power/models/cloud_instance.rb', line 90

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#capabilities ⇒ Object

Cloud Instance Capabilities



43
44
45
 
# File 'lib/ibm_cloud_power/models/cloud_instance.rb', line 43

def capabilities
  @capabilities
end

#cloud_instance_id ⇒ Object

Cloud Instance ID



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

def cloud_instance_id
  @cloud_instance_id
end

#enabled ⇒ Object

Indicates if the cloud instance is enabled



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

def enabled
  @enabled
end

#initialized ⇒ Object

Indicates if the cloud instance is initialized and ready for use



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

def initialized
  @initialized
end

#limits ⇒ Object

Returns the value of attribute limits.



38
39
40
 
# File 'lib/ibm_cloud_power/models/cloud_instance.rb', line 38

def limits
  @limits
end

#name ⇒ Object

Cloud Instance Name



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

def name
  @name
end

#openstack_id ⇒ Object

The open stack ID that controls this cloud instance



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

def openstack_id
  @openstack_id
end

#pvm_instances ⇒ Object

PVM instances owned by the Cloud Instance



46
47
48
 
# File 'lib/ibm_cloud_power/models/cloud_instance.rb', line 46

def pvm_instances
  @pvm_instances
end

#region ⇒ Object

The region the cloud instance lives



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

def region
  @region
end

#tenant_id ⇒ Object

The tenant ID that owns this cloud instance



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

def tenant_id
  @tenant_id
end

#usage ⇒ Object

Returns the value of attribute usage.



40
41
42
 
# File 'lib/ibm_cloud_power/models/cloud_instance.rb', line 40

def usage
  @usage
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'cloud_instance_id' => :'cloudInstanceID',
    :'name' => :'name',
    :'tenant_id' => :'tenantID',
    :'openstack_id' => :'openstackID',
    :'region' => :'region',
    :'enabled' => :'enabled',
    :'initialized' => :'initialized',
    :'limits' => :'limits',
    :'usage' => :'usage',
    :'capabilities' => :'capabilities',
    :'pvm_instances' => :'pvmInstances'
  }
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



248
249
250
 
# File 'lib/ibm_cloud_power/models/cloud_instance.rb', line 248

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



83
84
85
86
 
# File 'lib/ibm_cloud_power/models/cloud_instance.rb', line 83

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

.openapi_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/ibm_cloud_power/models/cloud_instance.rb', line 66

def self.openapi_types
  {
    :'cloud_instance_id' => :'String',
    :'name' => :'String',
    :'tenant_id' => :'String',
    :'openstack_id' => :'String',
    :'region' => :'String',
    :'enabled' => :'Boolean',
    :'initialized' => :'Boolean',
    :'limits' => :'CloudInstanceUsageLimits',
    :'usage' => :'CloudInstanceUsageLimits',
    :'capabilities' => :'Array<String>',
    :'pvm_instances' => :'Array<PVMInstanceReference>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cloud_instance_id == o.cloud_instance_id &&
      name == o.name &&
      tenant_id == o.tenant_id &&
      openstack_id == o.openstack_id &&
      region == o.region &&
      enabled == o.enabled &&
      initialized == o.initialized &&
      limits == o.limits &&
      usage == o.usage &&
      capabilities == o.capabilities &&
      pvm_instances == o.pvm_instances
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



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/ibm_cloud_power/models/cloud_instance.rb', line 278

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



347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/ibm_cloud_power/models/cloud_instance.rb', line 347

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



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/ibm_cloud_power/models/cloud_instance.rb', line 255

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


235
236
237
 
# File 'lib/ibm_cloud_power/models/cloud_instance.rb', line 235

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



241
242
243
 
# File 'lib/ibm_cloud_power/models/cloud_instance.rb', line 241

def hash
  [cloud_instance_id, name, tenant_id, openstack_id, region, enabled, initialized, limits, usage, capabilities, pvm_instances].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



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/ibm_cloud_power/models/cloud_instance.rb', line 154

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

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

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

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

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

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

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

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

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

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



323
324
325
 
# File 'lib/ibm_cloud_power/models/cloud_instance.rb', line 323

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



329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/ibm_cloud_power/models/cloud_instance.rb', line 329

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



317
318
319
 
# File 'lib/ibm_cloud_power/models/cloud_instance.rb', line 317

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



201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/ibm_cloud_power/models/cloud_instance.rb', line 201

def valid?
  return false if @cloud_instance_id.nil?
  return false if @name.nil?
  return false if @tenant_id.nil?
  return false if @openstack_id.nil?
  return false if @region.nil?
  return false if @enabled.nil?
  return false if @initialized.nil?
  return false if @limits.nil?
  return false if @usage.nil?
  return false if @pvm_instances.nil?
  true
end