Class: CMV4APIClient::Action

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Action

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

  if attributes.key?(:'assigned_toaction')
    self.assigned_toaction = attributes[:'assigned_toaction']
  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?(:'deadline')
    self.deadline = attributes[:'deadline']
  end

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

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

  if attributes.key?(:'initiated')
    self.initiated = attributes[:'initiated']
  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?(:'notified')
    self.notified = attributes[:'notified']
  end

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

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

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

Instance Attribute Details

#action_requested ⇒ Object

Returns the value of attribute action_requested.



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

def action_requested
  @action_requested
end

#action_status ⇒ Object

Returns the value of attribute action_status.



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

def action_status
  @action_status
end

#action_taken ⇒ Object

Returns the value of attribute action_taken.



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

def action_taken
  @action_taken
end

#assigned_byaction ⇒ Object

Returns the value of attribute assigned_byaction.



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

def assigned_byaction
  @assigned_byaction
end

#assigned_toaction ⇒ Object

Returns the value of attribute assigned_toaction.



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

def assigned_toaction
  @assigned_toaction
end

#created ⇒ Object

Returns the value of attribute created.



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

def created
  @created
end

#created_by ⇒ Object

Returns the value of attribute created_by.



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

def created_by
  @created_by
end

#database_id ⇒ Object

Returns the value of attribute database_id.



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

def database_id
  @database_id
end

#deadline ⇒ Object

Returns the value of attribute deadline.



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

def deadline
  @deadline
end

#deleted ⇒ Object

Returns the value of attribute deleted.



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

def deleted
  @deleted
end

#descriptor ⇒ Object

Returns the value of attribute descriptor.



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

def descriptor
  @descriptor
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#initiated ⇒ Object

Returns the value of attribute initiated.



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

def initiated
  @initiated
end

#modified ⇒ Object

Returns the value of attribute modified.



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

def modified
  @modified
end

#modified_by ⇒ Object

Returns the value of attribute modified_by.



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

def modified_by
  @modified_by
end

#modified_end_time ⇒ Object

Returns the value of attribute modified_end_time.



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

def modified_end_time
  @modified_end_time
end

#notified ⇒ Object

Returns the value of attribute notified.



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

def notified
  @notified
end

#related_projects ⇒ Object

Returns the value of attribute related_projects.



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

def related_projects
  @related_projects
end

#resolved ⇒ Object

Returns the value of attribute resolved.



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

def resolved
  @resolved
end

#visibility ⇒ Object

Returns the value of attribute visibility.



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

def visibility
  @visibility
end

Class Method Details

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/cmv4-openapi-client/models/action.rb', line 58

def self.attribute_map
  {
    :'id' => :'id',
    :'action_requested' => :'actionRequested',
    :'action_status' => :'actionStatus',
    :'action_taken' => :'actionTaken',
    :'assigned_byaction' => :'assignedByaction',
    :'assigned_toaction' => :'assignedToaction',
    :'created' => :'created',
    :'created_by' => :'createdBy',
    :'database_id' => :'databaseId',
    :'deadline' => :'deadline',
    :'deleted' => :'deleted',
    :'descriptor' => :'descriptor',
    :'initiated' => :'initiated',
    :'modified' => :'modified',
    :'modified_by' => :'modifiedBy',
    :'modified_end_time' => :'modifiedEndTime',
    :'notified' => :'notified',
    :'related_projects' => :'relatedProjects',
    :'resolved' => :'resolved',
    :'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



277
278
279
 
# File 'lib/cmv4-openapi-client/models/action.rb', line 277

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/cmv4-openapi-client/models/action.rb', line 110

def self.openapi_nullable
  Set.new([
    :'action_requested',
    :'action_status',
    :'action_taken',
    :'assigned_byaction',
    :'assigned_toaction',
    :'created_by',
    :'descriptor',
    :'modified_by',
    :'related_projects',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/cmv4-openapi-client/models/action.rb', line 84

def self.openapi_types
  {
    :'id' => :'Integer',
    :'action_requested' => :'String',
    :'action_status' => :'ClassificationModel',
    :'action_taken' => :'String',
    :'assigned_byaction' => :'RelatedValue',
    :'assigned_toaction' => :'RelatedValue',
    :'created' => :'DateTime',
    :'created_by' => :'IdentityModel',
    :'database_id' => :'String',
    :'deadline' => :'DateTime',
    :'deleted' => :'Boolean',
    :'descriptor' => :'String',
    :'initiated' => :'DateTime',
    :'modified' => :'DateTime',
    :'modified_by' => :'IdentityModel',
    :'modified_end_time' => :'DateTime',
    :'notified' => :'DateTime',
    :'related_projects' => :'Array<RelatedValue>',
    :'resolved' => :'DateTime',
    :'visibility' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/cmv4-openapi-client/models/action.rb', line 237

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      action_requested == o.action_requested &&
      action_status == o.action_status &&
      action_taken == o.action_taken &&
      assigned_byaction == o.assigned_byaction &&
      assigned_toaction == o.assigned_toaction &&
      created == o.created &&
      created_by == o.created_by &&
      database_id == o.database_id &&
      deadline == o.deadline &&
      deleted == o.deleted &&
      descriptor == o.descriptor &&
      initiated == o.initiated &&
      modified == o.modified &&
      modified_by == o.modified_by &&
      modified_end_time == o.modified_end_time &&
      notified == o.notified &&
      related_projects == o.related_projects &&
      resolved == o.resolved &&
      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



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

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



374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/cmv4-openapi-client/models/action.rb', line 374

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



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/cmv4-openapi-client/models/action.rb', line 284

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


264
265
266
 
# File 'lib/cmv4-openapi-client/models/action.rb', line 264

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



270
271
272
 
# File 'lib/cmv4-openapi-client/models/action.rb', line 270

def hash
  [id, action_requested, action_status, action_taken, assigned_byaction, assigned_toaction, created, created_by, database_id, deadline, deleted, descriptor, initiated, modified, modified_by, modified_end_time, notified, related_projects, resolved, 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



224
225
226
227
 
# File 'lib/cmv4-openapi-client/models/action.rb', line 224

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



350
351
352
 
# File 'lib/cmv4-openapi-client/models/action.rb', line 350

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



356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/cmv4-openapi-client/models/action.rb', line 356

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



344
345
346
 
# File 'lib/cmv4-openapi-client/models/action.rb', line 344

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



231
232
233
 
# File 'lib/cmv4-openapi-client/models/action.rb', line 231

def valid?
  true
end