Class: IbmCloudResourceController::Reclamation

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

Overview

A reclamation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Reclamation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'custom_properties')
    if (value = attributes[:'custom_properties']).is_a?(Hash)
      self.custom_properties = value
    end
  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
end

Instance Attribute Details

#account_id ⇒ Object

An alpha-numeric value identifying the account ID.



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

def 
  @account_id
end

#created_at ⇒ Object

The date when the reclamation was created.



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

def created_at
  @created_at
end

#created_by ⇒ Object

The subject who created the reclamation.



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

def created_by
  @created_by
end

#custom_properties ⇒ Object

The custom properties of the reclamation.



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

def custom_properties
  @custom_properties
end

#entity_crn ⇒ Object

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



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

def entity_crn
  @entity_crn
end

#entity_id ⇒ Object

The short ID of the entity for the reclamation.



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

def entity_id
  @entity_id
end

#entity_type_id ⇒ Object

The short ID of the entity type for the reclamation.



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

def entity_type_id
  @entity_type_id
end

#id ⇒ Object

The ID associated with the reclamation.



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

def id
  @id
end

#policy_id ⇒ Object

The short ID of policy for the reclamation.



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

def policy_id
  @policy_id
end

#resource_group_id ⇒ Object

The short ID of the resource group.



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

def resource_group_id
  @resource_group_id
end

#resource_instance_id ⇒ Object

The short ID of the resource instance.



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

def resource_instance_id
  @resource_instance_id
end

#state ⇒ Object

The state of the reclamation.



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

def state
  @state
end

#target_time ⇒ Object

The target time that the reclamation retention period end.



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

def target_time
  @target_time
end

#updated_at ⇒ Object

The date when the reclamation was last updated.



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

def updated_at
  @updated_at
end

#updated_by ⇒ Object

The subject who updated the reclamation.



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

def updated_by
  @updated_by
end

Class Method Details

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/ibm_cloud_resource_controller/models/reclamation.rb', line 64

def self.attribute_map
  {
    :'id' => :'id',
    :'entity_id' => :'entity_id',
    :'entity_type_id' => :'entity_type_id',
    :'entity_crn' => :'entity_crn',
    :'resource_instance_id' => :'resource_instance_id',
    :'resource_group_id' => :'resource_group_id',
    :'account_id' => :'account_id',
    :'policy_id' => :'policy_id',
    :'state' => :'state',
    :'target_time' => :'target_time',
    :'custom_properties' => :'custom_properties',
    :'created_at' => :'created_at',
    :'created_by' => :'created_by',
    :'updated_at' => :'updated_at',
    :'updated_by' => :'updated_by'
  }
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



239
240
241
 
# File 'lib/ibm_cloud_resource_controller/models/reclamation.rb', line 239

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/ibm_cloud_resource_controller/models/reclamation.rb', line 85

def self.openapi_types
  {
    :'id' => :'String',
    :'entity_id' => :'String',
    :'entity_type_id' => :'String',
    :'entity_crn' => :'String',
    :'resource_instance_id' => :'String',
    :'resource_group_id' => :'String',
    :'account_id' => :'String',
    :'policy_id' => :'String',
    :'state' => :'String',
    :'target_time' => :'String',
    :'custom_properties' => :'Hash<String, Object>',
    :'created_at' => :'DateTime',
    :'created_by' => :'String',
    :'updated_at' => :'DateTime',
    :'updated_by' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/ibm_cloud_resource_controller/models/reclamation.rb', line 204

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      entity_id == o.entity_id &&
      entity_type_id == o.entity_type_id &&
      entity_crn == o.entity_crn &&
      resource_instance_id == o.resource_instance_id &&
      resource_group_id == o.resource_group_id &&
       == o. &&
      policy_id == o.policy_id &&
      state == o.state &&
      target_time == o.target_time &&
      custom_properties == o.custom_properties &&
      created_at == o.created_at &&
      created_by == o.created_by &&
      updated_at == o.updated_at &&
      updated_by == o.updated_by
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



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

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/ibm_cloud_resource_controller/models/reclamation.rb', line 338

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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/ibm_cloud_resource_controller/models/reclamation.rb', line 246

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


226
227
228
 
# File 'lib/ibm_cloud_resource_controller/models/reclamation.rb', line 226

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



232
233
234
 
# File 'lib/ibm_cloud_resource_controller/models/reclamation.rb', line 232

def hash
  [id, entity_id, entity_type_id, entity_crn, resource_instance_id, resource_group_id, , policy_id, state, target_time, custom_properties, created_at, created_by, updated_at, updated_by].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



191
192
193
194
 
# File 'lib/ibm_cloud_resource_controller/models/reclamation.rb', line 191

def list_invalid_properties
  invalid_properties = Array.new
  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



314
315
316
 
# File 'lib/ibm_cloud_resource_controller/models/reclamation.rb', line 314

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



320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/ibm_cloud_resource_controller/models/reclamation.rb', line 320

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



308
309
310
 
# File 'lib/ibm_cloud_resource_controller/models/reclamation.rb', line 308

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



198
199
200
 
# File 'lib/ibm_cloud_resource_controller/models/reclamation.rb', line 198

def valid?
  true
end