Class: CMV4APIClient::Property

Inherits:
Object
  • Object
show all
Defined in:
lib/cmv4-openapi-client/models/property.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Property

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
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
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 150

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



19
20
21
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 19

def address
  @address
end

#address_address ⇒ Object

Returns the value of attribute address_address.



21
22
23
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 21

def address_address
  @address_address
end

#address_country ⇒ Object

Returns the value of attribute address_country.



23
24
25
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 23

def address_country
  @address_country
end

#address_location ⇒ Object

Returns the value of attribute address_location.



25
26
27
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 25

def address_location
  @address_location
end

#address_post_code ⇒ Object

Returns the value of attribute address_post_code.



27
28
29
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 27

def address_post_code
  @address_post_code
end

#address_state ⇒ Object

Returns the value of attribute address_state.



29
30
31
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 29

def address_state
  @address_state
end

#address_suburb ⇒ Object

Returns the value of attribute address_suburb.



31
32
33
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 31

def address_suburb
  @address_suburb
end

#created ⇒ Object

Returns the value of attribute created.



33
34
35
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 33

def created
  @created
end

#created_by ⇒ Object

Returns the value of attribute created_by.



35
36
37
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 35

def created_by
  @created_by
end

#database_id ⇒ Object

Returns the value of attribute database_id.



37
38
39
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 37

def database_id
  @database_id
end

#deleted ⇒ Object

Returns the value of attribute deleted.



39
40
41
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 39

def deleted
  @deleted
end

#descriptor ⇒ Object

Returns the value of attribute descriptor.



41
42
43
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 41

def descriptor
  @descriptor
end

#distribution_lists ⇒ Object

Returns the value of attribute distribution_lists.



43
44
45
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 43

def distribution_lists
  @distribution_lists
end

#id ⇒ Object

Returns the value of attribute id.



17
18
19
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 17

def id
  @id
end

#modified ⇒ Object

Returns the value of attribute modified.



45
46
47
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 45

def modified
  @modified
end

#modified_by ⇒ Object

Returns the value of attribute modified_by.



47
48
49
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 47

def modified_by
  @modified_by
end

#modified_end_time ⇒ Object

Returns the value of attribute modified_end_time.



49
50
51
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 49

def modified_end_time
  @modified_end_time
end

#property_groups ⇒ Object

Returns the value of attribute property_groups.



51
52
53
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 51

def property_groups
  @property_groups
end

#property_name ⇒ Object

Returns the value of attribute property_name.



53
54
55
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 53

def property_name
  @property_name
end

#property_number ⇒ Object

Returns the value of attribute property_number.



55
56
57
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 55

def property_number
  @property_number
end

#reference ⇒ Object

Returns the value of attribute reference.



57
58
59
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 57

def reference
  @reference
end

#related_projects ⇒ Object

Returns the value of attribute related_projects.



59
60
61
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 59

def related_projects
  @related_projects
end

#related_stakeholder ⇒ Object

Returns the value of attribute related_stakeholder.



61
62
63
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 61

def related_stakeholder
  @related_stakeholder
end

#visibility ⇒ Object

Returns the value of attribute visibility.



63
64
65
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 63

def visibility
  @visibility
end

Class Method Details

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 66

def self.attribute_map
  {
    :'id' => :'id',
    :'address' => :'address',
    :'address_address' => :'address.address',
    :'address_country' => :'address.country',
    :'address_location' => :'address.location',
    :'address_post_code' => :'address.postCode',
    :'address_state' => :'address.state',
    :'address_suburb' => :'address.suburb',
    :'created' => :'created',
    :'created_by' => :'createdBy',
    :'database_id' => :'databaseId',
    :'deleted' => :'deleted',
    :'descriptor' => :'descriptor',
    :'distribution_lists' => :'distributionLists',
    :'modified' => :'modified',
    :'modified_by' => :'modifiedBy',
    :'modified_end_time' => :'modifiedEndTime',
    :'property_groups' => :'propertyGroups',
    :'property_name' => :'propertyName',
    :'property_number' => :'propertyNumber',
    :'reference' => :'reference',
    :'related_projects' => :'relatedProjects',
    :'related_stakeholder' => :'relatedStakeholder',
    :'visibility' => :'visibility'
  }
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



323
324
325
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 323

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 126

def self.openapi_nullable
  Set.new([
    :'address',
    :'address_address',
    :'address_country',
    :'address_location',
    :'address_post_code',
    :'address_state',
    :'address_suburb',
    :'created_by',
    :'descriptor',
    :'distribution_lists',
    :'modified_by',
    :'property_groups',
    :'property_name',
    :'property_number',
    :'reference',
    :'related_projects',
    :'related_stakeholder',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 96

def self.openapi_types
  {
    :'id' => :'Integer',
    :'address' => :'AddressModel',
    :'address_address' => :'String',
    :'address_country' => :'String',
    :'address_location' => :'String',
    :'address_post_code' => :'String',
    :'address_state' => :'String',
    :'address_suburb' => :'String',
    :'created' => :'DateTime',
    :'created_by' => :'IdentityModel',
    :'database_id' => :'String',
    :'deleted' => :'Boolean',
    :'descriptor' => :'String',
    :'distribution_lists' => :'ClassificationSetModel',
    :'modified' => :'DateTime',
    :'modified_by' => :'IdentityModel',
    :'modified_end_time' => :'DateTime',
    :'property_groups' => :'ClassificationSetModel',
    :'property_name' => :'String',
    :'property_number' => :'String',
    :'reference' => :'String',
    :'related_projects' => :'Array<RelatedValue>',
    :'related_stakeholder' => :'Array<RelatedValue>',
    :'visibility' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 279

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      address == o.address &&
      address_address == o.address_address &&
      address_country == o.address_country &&
      address_location == o.address_location &&
      address_post_code == o.address_post_code &&
      address_state == o.address_state &&
      address_suburb == o.address_suburb &&
      created == o.created &&
      created_by == o.created_by &&
      database_id == o.database_id &&
      deleted == o.deleted &&
      descriptor == o.descriptor &&
      distribution_lists == o.distribution_lists &&
      modified == o.modified &&
      modified_by == o.modified_by &&
      modified_end_time == o.modified_end_time &&
      property_groups == o.property_groups &&
      property_name == o.property_name &&
      property_number == o.property_number &&
      reference == o.reference &&
      related_projects == o.related_projects &&
      related_stakeholder == o.related_stakeholder &&
      visibility == o.visibility
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



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 351

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



420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 420

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



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 330

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]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


310
311
312
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 310

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



316
317
318
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 316

def hash
  [id, address, address_address, address_country, address_location, address_post_code, address_state, address_suburb, created, created_by, database_id, deleted, descriptor, distribution_lists, modified, modified_by, modified_end_time, property_groups, property_name, property_number, reference, related_projects, related_stakeholder, visibility].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



266
267
268
269
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 266

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



396
397
398
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 396

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



402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 402

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



390
391
392
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 390

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



273
274
275
 
# File 'lib/cmv4-openapi-client/models/property.rb', line 273

def valid?
  true
end