Class: CMV4APIClient::EntityDefinition

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EntityDefinition

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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/cmv4-openapi-client/models/entity_definition.rb', line 100

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#_alias ⇒ Object

Returns the value of attribute _alias.



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

def _alias
  @_alias
end

#default_visibility ⇒ Object

Returns the value of attribute default_visibility.



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

def default_visibility
  @default_visibility
end

#deleted_field_definition_set ⇒ Object

Returns the value of attribute deleted_field_definition_set.



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

def deleted_field_definition_set
  @deleted_field_definition_set
end

#features ⇒ Object

Returns the value of attribute features.



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

def features
  @features
end

#field_definition_set ⇒ Object

Returns the value of attribute field_definition_set.



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

def field_definition_set
  @field_definition_set
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#nature ⇒ Object

Returns the value of attribute nature.



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

def nature
  @nature
end

#plural_name ⇒ Object

Returns the value of attribute plural_name.



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

def plural_name
  @plural_name
end

#require_project_association ⇒ Object

Returns the value of attribute require_project_association.



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

def require_project_association
  @require_project_association
end

#schema_name ⇒ Object

Returns the value of attribute schema_name.



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

def schema_name
  @schema_name
end

#version ⇒ Object

Returns the value of attribute version.



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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/cmv4-openapi-client/models/entity_definition.rb', line 42

def self.attribute_map
  {
    :'id' => :'id',
    :'_alias' => :'alias',
    :'deleted_field_definition_set' => :'deletedFieldDefinitionSet',
    :'features' => :'features',
    :'field_definition_set' => :'fieldDefinitionSet',
    :'name' => :'name',
    :'plural_name' => :'pluralName',
    :'schema_name' => :'schemaName',
    :'version' => :'version',
    :'nature' => :'nature',
    :'default_visibility' => :'defaultVisibility',
    :'require_project_association' => :'requireProjectAssociation'
  }
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



215
216
217
 
# File 'lib/cmv4-openapi-client/models/entity_definition.rb', line 215

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



91
92
93
94
95
96
 
# File 'lib/cmv4-openapi-client/models/entity_definition.rb', line 91

def self.openapi_all_of
  [
  :'DomainObjectDefinitionBase',
  :'EntityDefinitionAllOf'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/cmv4-openapi-client/models/entity_definition.rb', line 78

def self.openapi_nullable
  Set.new([
    :'_alias',
    :'deleted_field_definition_set',
    :'features',
    :'field_definition_set',
    :'name',
    :'plural_name',
    :'schema_name',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/cmv4-openapi-client/models/entity_definition.rb', line 60

def self.openapi_types
  {
    :'id' => :'Integer',
    :'_alias' => :'String',
    :'deleted_field_definition_set' => :'Hash<String, IKnowledgeBaseFieldDefinition>',
    :'features' => :'Hash<String, IKnowledgeBaseObjectDefinitionFeature>',
    :'field_definition_set' => :'Hash<String, IKnowledgeBaseFieldDefinition>',
    :'name' => :'String',
    :'plural_name' => :'String',
    :'schema_name' => :'String',
    :'version' => :'Integer',
    :'nature' => :'DomainObjectNature',
    :'default_visibility' => :'Visibility',
    :'require_project_association' => :'Boolean'
  }
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
194
195
196
197
198
 
# File 'lib/cmv4-openapi-client/models/entity_definition.rb', line 183

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      _alias == o._alias &&
      deleted_field_definition_set == o.deleted_field_definition_set &&
      features == o.features &&
      field_definition_set == o.field_definition_set &&
      name == o.name &&
      plural_name == o.plural_name &&
      schema_name == o.schema_name &&
      version == o.version &&
      nature == o.nature &&
      default_visibility == o.default_visibility &&
      require_project_association == o.require_project_association
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



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/cmv4-openapi-client/models/entity_definition.rb', line 243

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



312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/cmv4-openapi-client/models/entity_definition.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



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/cmv4-openapi-client/models/entity_definition.rb', line 222

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


202
203
204
 
# File 'lib/cmv4-openapi-client/models/entity_definition.rb', line 202

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



208
209
210
 
# File 'lib/cmv4-openapi-client/models/entity_definition.rb', line 208

def hash
  [id, _alias, deleted_field_definition_set, features, field_definition_set, name, plural_name, schema_name, version, nature, default_visibility, require_project_association].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



170
171
172
173
 
# File 'lib/cmv4-openapi-client/models/entity_definition.rb', line 170

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



288
289
290
 
# File 'lib/cmv4-openapi-client/models/entity_definition.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/cmv4-openapi-client/models/entity_definition.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/cmv4-openapi-client/models/entity_definition.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



177
178
179
 
# File 'lib/cmv4-openapi-client/models/entity_definition.rb', line 177

def valid?
  true
end