Class: IbmCloudResourceController::ResourceInstance

Inherits:
Object
  • Object
show all
Defined in:
lib/ibm_cloud_resource_controller/models/resource_instance.rb

Overview

A resource instance.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ResourceInstance

Initializes the object



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
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
274
275
276
277
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
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 203

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

An alpha-numeric value identifying the account ID.



34
35
36
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 34

def 
  @account_id
end

#allow_cleanup ⇒ Object

A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.



64
65
66
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 64

def allow_cleanup
  @allow_cleanup
end

#created_at ⇒ Object

The date when the instance was created.



88
89
90
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 88

def created_at
  @created_at
end

#created_by ⇒ Object

The subject who created the instance.



91
92
93
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 91

def created_by
  @created_by
end

#crn ⇒ Object

The full Cloud Resource Name (CRN) associated with the instance. For more information about this format, see [Cloud Resource Names](cloud.ibm.com/docs/overview?topic=overview-crn).



25
26
27
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 25

def crn
  @crn
end

#dashboard_url ⇒ Object

The resource-broker-provided URL to access administrative features of the instance.



73
74
75
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 73

def dashboard_url
  @dashboard_url
end

#deleted_at ⇒ Object

The date when the instance was deleted.



100
101
102
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 100

def deleted_at
  @deleted_at
end

#deleted_by ⇒ Object

The subject who deleted the instance.



103
104
105
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 103

def deleted_by
  @deleted_by
end

#guid ⇒ Object

When you create a new resource, a globally unique identifier (GUID) is assigned. This GUID is a unique internal identifier managed by the resource controller that corresponds to the instance.



22
23
24
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 22

def guid
  @guid
end

#id ⇒ Object

The ID associated with the instance.



19
20
21
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 19

def id
  @id
end

#last_operation ⇒ Object

The status of the last operation requested on the instance.



70
71
72
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 70

def last_operation
  @last_operation
end

#locked ⇒ Object

A boolean that dictates if the resource instance is locked or not.



67
68
69
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 67

def locked
  @locked
end

#name ⇒ Object

The human-readable name of the instance.



31
32
33
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 31

def name
  @name
end

#parameters ⇒ Object

The current configuration parameters of the instance.



52
53
54
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 52

def parameters
  @parameters
end

#plan_history ⇒ Object

The plan history of the instance.



76
77
78
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 76

def plan_history
  @plan_history
end

#resource_aliases_url ⇒ Object

The relative path to the resource aliases for the instance.



79
80
81
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 79

def resource_aliases_url
  @resource_aliases_url
end

#resource_bindings_url ⇒ Object

The relative path to the resource bindings for the instance.



82
83
84
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 82

def resource_bindings_url
  @resource_bindings_url
end

#resource_group_crn ⇒ Object

The long ID (full CRN) of the resource group.



40
41
42
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 40

def resource_group_crn
  @resource_group_crn
end

#resource_group_id ⇒ Object

The short ID of the resource group.



37
38
39
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 37

def resource_group_id
  @resource_group_id
end

#resource_id ⇒ Object

The unique ID of the offering. This value is provided by and stored in the global catalog.



43
44
45
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 43

def resource_id
  @resource_id
end

#resource_keys_url ⇒ Object

The relative path to the resource keys for the instance.



85
86
87
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 85

def resource_keys_url
  @resource_keys_url
end

#resource_plan_id ⇒ Object

The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.



46
47
48
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 46

def resource_plan_id
  @resource_plan_id
end

#restored_at ⇒ Object

The date when the instance under reclamation was restored.



112
113
114
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 112

def restored_at
  @restored_at
end

#restored_by ⇒ Object

The subject who restored the instance back from reclamation.



115
116
117
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 115

def restored_by
  @restored_by
end

#scheduled_reclaim_at ⇒ Object

The date when the instance was scheduled for reclamation.



106
107
108
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 106

def scheduled_reclaim_at
  @scheduled_reclaim_at
end

#scheduled_reclaim_by ⇒ Object

The subject who initiated the instance reclamation.



109
110
111
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 109

def scheduled_reclaim_by
  @scheduled_reclaim_by
end

#state ⇒ Object

The current state of the instance. For example, if the instance is deleted, it will return removed.



55
56
57
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 55

def state
  @state
end

#sub_type ⇒ Object

The sub-type of instance, e.g. cfaas.



61
62
63
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 61

def sub_type
  @sub_type
end

#target_crn ⇒ Object

The full deployment CRN as defined in the global catalog. The Cloud Resource Name (CRN) of the deployment location where the instance is provisioned.



49
50
51
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 49

def target_crn
  @target_crn
end

#type ⇒ Object

The type of the instance, e.g. service_instance.



58
59
60
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 58

def type
  @type
end

#updated_at ⇒ Object

The date when the instance was last updated.



94
95
96
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 94

def updated_at
  @updated_at
end

#updated_by ⇒ Object

The subject who updated the instance.



97
98
99
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 97

def updated_by
  @updated_by
end

#url ⇒ Object

When you provision a new resource, a relative URL path is created identifying the location of the instance.



28
29
30
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 28

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

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



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
151
152
153
154
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 118

def self.attribute_map
  {
    :'id' => :'id',
    :'guid' => :'guid',
    :'crn' => :'crn',
    :'url' => :'url',
    :'name' => :'name',
    :'account_id' => :'account_id',
    :'resource_group_id' => :'resource_group_id',
    :'resource_group_crn' => :'resource_group_crn',
    :'resource_id' => :'resource_id',
    :'resource_plan_id' => :'resource_plan_id',
    :'target_crn' => :'target_crn',
    :'parameters' => :'parameters',
    :'state' => :'state',
    :'type' => :'type',
    :'sub_type' => :'sub_type',
    :'allow_cleanup' => :'allow_cleanup',
    :'locked' => :'locked',
    :'last_operation' => :'last_operation',
    :'dashboard_url' => :'dashboard_url',
    :'plan_history' => :'plan_history',
    :'resource_aliases_url' => :'resource_aliases_url',
    :'resource_bindings_url' => :'resource_bindings_url',
    :'resource_keys_url' => :'resource_keys_url',
    :'created_at' => :'created_at',
    :'created_by' => :'created_by',
    :'updated_at' => :'updated_at',
    :'updated_by' => :'updated_by',
    :'deleted_at' => :'deleted_at',
    :'deleted_by' => :'deleted_by',
    :'scheduled_reclaim_at' => :'scheduled_reclaim_at',
    :'scheduled_reclaim_by' => :'scheduled_reclaim_by',
    :'restored_at' => :'restored_at',
    :'restored_by' => :'restored_by'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



423
424
425
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 423

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



196
197
198
199
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 196

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

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 157

def self.openapi_types
  {
    :'id' => :'String',
    :'guid' => :'String',
    :'crn' => :'String',
    :'url' => :'String',
    :'name' => :'String',
    :'account_id' => :'String',
    :'resource_group_id' => :'String',
    :'resource_group_crn' => :'String',
    :'resource_id' => :'String',
    :'resource_plan_id' => :'String',
    :'target_crn' => :'String',
    :'parameters' => :'Hash<String, Object>',
    :'state' => :'String',
    :'type' => :'String',
    :'sub_type' => :'String',
    :'allow_cleanup' => :'Boolean',
    :'locked' => :'Boolean',
    :'last_operation' => :'Hash<String, Object>',
    :'dashboard_url' => :'String',
    :'plan_history' => :'Array<PlanHistoryItem>',
    :'resource_aliases_url' => :'String',
    :'resource_bindings_url' => :'String',
    :'resource_keys_url' => :'String',
    :'created_at' => :'DateTime',
    :'created_by' => :'String',
    :'updated_at' => :'DateTime',
    :'updated_by' => :'String',
    :'deleted_at' => :'DateTime',
    :'deleted_by' => :'String',
    :'scheduled_reclaim_at' => :'DateTime',
    :'scheduled_reclaim_by' => :'String',
    :'restored_at' => :'DateTime',
    :'restored_by' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 370

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      guid == o.guid &&
      crn == o.crn &&
      url == o.url &&
      name == o.name &&
       == o. &&
      resource_group_id == o.resource_group_id &&
      resource_group_crn == o.resource_group_crn &&
      resource_id == o.resource_id &&
      resource_plan_id == o.resource_plan_id &&
      target_crn == o.target_crn &&
      parameters == o.parameters &&
      state == o.state &&
      type == o.type &&
      sub_type == o.sub_type &&
      allow_cleanup == o.allow_cleanup &&
      locked == o.locked &&
      last_operation == o.last_operation &&
      dashboard_url == o.dashboard_url &&
      plan_history == o.plan_history &&
      resource_aliases_url == o.resource_aliases_url &&
      resource_bindings_url == o.resource_bindings_url &&
      resource_keys_url == o.resource_keys_url &&
      created_at == o.created_at &&
      created_by == o.created_by &&
      updated_at == o.updated_at &&
      updated_by == o.updated_by &&
      deleted_at == o.deleted_at &&
      deleted_by == o.deleted_by &&
      scheduled_reclaim_at == o.scheduled_reclaim_at &&
      scheduled_reclaim_by == o.scheduled_reclaim_by &&
      restored_at == o.restored_at &&
      restored_by == o.restored_by
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 453

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
    IbmCloudResourceController.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



522
523
524
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 522

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



430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 430

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

See Also:

  • `==` method


410
411
412
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 410

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



416
417
418
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 416

def hash
  [id, guid, crn, url, name, , resource_group_id, resource_group_crn, resource_id, resource_plan_id, target_crn, parameters, state, type, sub_type, allow_cleanup, locked, last_operation, dashboard_url, plan_history, resource_aliases_url, resource_bindings_url, resource_keys_url, created_at, created_by, updated_at, updated_by, deleted_at, deleted_by, scheduled_reclaim_at, scheduled_reclaim_by, restored_at, restored_by].hash
end

#list_invalid_properties ⇒ Object

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



357
358
359
360
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 357

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



498
499
500
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 498

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



504
505
506
507
508
509
510
511
512
513
514
515
516
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 504

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



492
493
494
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 492

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



364
365
366
 
# File 'lib/ibm_cloud_resource_controller/models/resource_instance.rb', line 364

def valid?
  true
end