Class: ApprovalApiClient::Request

Inherits:
Object
  • Object
show all
Defined in:
lib/insights-approval-api-client/models/request.rb

Overview

Approval request. It may have child requests. Only a leaf node request can have workflow_id

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Request

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
221
222
223
224
225
226
227
228
 
# File 'lib/insights-approval-api-client/models/request.rb', line 148

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_at ⇒ Object

Timestamp of creation



33
34
35
 
# File 'lib/insights-approval-api-client/models/request.rb', line 33

def created_at
  @created_at
end

#decision ⇒ Object

Approval decision. Possible value: undecided, approved, canceled, denied, or error



24
25
26
 
# File 'lib/insights-approval-api-client/models/request.rb', line 24

def decision
  @decision
end

#description ⇒ Object

Request description



57
58
59
 
# File 'lib/insights-approval-api-client/models/request.rb', line 57

def description
  @description
end

#finished_at ⇒ Object

Timestamp of finishing (skipped, canceled, or completed)



39
40
41
 
# File 'lib/insights-approval-api-client/models/request.rb', line 39

def finished_at
  @finished_at
end

#group_name ⇒ Object

Name of approver group(s) assigned to approve this request



60
61
62
 
# File 'lib/insights-approval-api-client/models/request.rb', line 60

def group_name
  @group_name
end

#id ⇒ Object

Returns the value of attribute id.



18
19
20
 
# File 'lib/insights-approval-api-client/models/request.rb', line 18

def id
  @id
end

#metadata ⇒ Object

JSON Metadata about the request



66
67
68
 
# File 'lib/insights-approval-api-client/models/request.rb', line 66

def metadata
  @metadata
end

#name ⇒ Object

Request name



54
55
56
 
# File 'lib/insights-approval-api-client/models/request.rb', line 54

def name
  @name
end

#notified_at ⇒ Object

Timestamp of notification sent to approvers



36
37
38
 
# File 'lib/insights-approval-api-client/models/request.rb', line 36

def notified_at
  @notified_at
end

#number_of_children ⇒ Object

Number of child requests



42
43
44
 
# File 'lib/insights-approval-api-client/models/request.rb', line 42

def number_of_children
  @number_of_children
end

#number_of_finished_children ⇒ Object

Number of finished child requests



45
46
47
 
# File 'lib/insights-approval-api-client/models/request.rb', line 45

def number_of_finished_children
  @number_of_finished_children
end

#owner ⇒ Object

Requester’s id



48
49
50
 
# File 'lib/insights-approval-api-client/models/request.rb', line 48

def owner
  @owner
end

#parent_id ⇒ Object

Parent request id



63
64
65
 
# File 'lib/insights-approval-api-client/models/request.rb', line 63

def parent_id
  @parent_id
end

#reason ⇒ Object

Reason for the decision. Optional. Present normally when the decision is denied



27
28
29
 
# File 'lib/insights-approval-api-client/models/request.rb', line 27

def reason
  @reason
end

#requester_name ⇒ Object

Requester’s full name



51
52
53
 
# File 'lib/insights-approval-api-client/models/request.rb', line 51

def requester_name
  @requester_name
end

#state ⇒ Object

The state of the request. Possible value: canceled, completed, failed, notified, skipped, or started



21
22
23
 
# File 'lib/insights-approval-api-client/models/request.rb', line 21

def state
  @state
end

#workflow_id ⇒ Object

Associate workflow id. Available only if the request is a leaf node



30
31
32
 
# File 'lib/insights-approval-api-client/models/request.rb', line 30

def workflow_id
  @workflow_id
end

Class Method Details

.attribute_map ⇒ Object

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



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/insights-approval-api-client/models/request.rb', line 91

def self.attribute_map
  {
    :'id' => :'id',
    :'state' => :'state',
    :'decision' => :'decision',
    :'reason' => :'reason',
    :'workflow_id' => :'workflow_id',
    :'created_at' => :'created_at',
    :'notified_at' => :'notified_at',
    :'finished_at' => :'finished_at',
    :'number_of_children' => :'number_of_children',
    :'number_of_finished_children' => :'number_of_finished_children',
    :'owner' => :'owner',
    :'requester_name' => :'requester_name',
    :'name' => :'name',
    :'description' => :'description',
    :'group_name' => :'group_name',
    :'parent_id' => :'parent_id',
    :'metadata' => :'metadata'
  }
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



306
307
308
 
# File 'lib/insights-approval-api-client/models/request.rb', line 306

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



137
138
139
140
141
142
143
144
 
# File 'lib/insights-approval-api-client/models/request.rb', line 137

def self.openapi_nullable
  Set.new([
    :'reason',
    :'workflow_id',
    :'notified_at',
    :'finished_at',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/insights-approval-api-client/models/request.rb', line 114

def self.openapi_types
  {
    :'id' => :'String',
    :'state' => :'String',
    :'decision' => :'String',
    :'reason' => :'String',
    :'workflow_id' => :'String',
    :'created_at' => :'DateTime',
    :'notified_at' => :'DateTime',
    :'finished_at' => :'DateTime',
    :'number_of_children' => :'Integer',
    :'number_of_finished_children' => :'Integer',
    :'owner' => :'String',
    :'requester_name' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'group_name' => :'String',
    :'parent_id' => :'String',
    :'metadata' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/insights-approval-api-client/models/request.rb', line 269

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      state == o.state &&
      decision == o.decision &&
      reason == o.reason &&
      workflow_id == o.workflow_id &&
      created_at == o.created_at &&
      notified_at == o.notified_at &&
      finished_at == o.finished_at &&
      number_of_children == o.number_of_children &&
      number_of_finished_children == o.number_of_finished_children &&
      owner == o.owner &&
      requester_name == o.requester_name &&
      name == o.name &&
      description == o.description &&
      group_name == o.group_name &&
      parent_id == o.parent_id &&
      metadata == o.metadata
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



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/insights-approval-api-client/models/request.rb', line 334

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



403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/insights-approval-api-client/models/request.rb', line 403

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



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/insights-approval-api-client/models/request.rb', line 313

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


293
294
295
 
# File 'lib/insights-approval-api-client/models/request.rb', line 293

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



299
300
301
 
# File 'lib/insights-approval-api-client/models/request.rb', line 299

def hash
  [id, state, decision, reason, workflow_id, created_at, notified_at, finished_at, number_of_children, number_of_finished_children, owner, requester_name, name, description, group_name, parent_id, metadata].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



232
233
234
235
 
# File 'lib/insights-approval-api-client/models/request.rb', line 232

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



379
380
381
 
# File 'lib/insights-approval-api-client/models/request.rb', line 379

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



385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/insights-approval-api-client/models/request.rb', line 385

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



373
374
375
 
# File 'lib/insights-approval-api-client/models/request.rb', line 373

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



239
240
241
242
243
244
245
 
# File 'lib/insights-approval-api-client/models/request.rb', line 239

def valid?
  state_validator = EnumAttributeValidator.new('String', ["canceled", "completed", "failed", "notified", "pending", "skipped", "started"])
  return false unless state_validator.valid?(@state)
  decision_validator = EnumAttributeValidator.new('String', ["undecided", "approved", "canceled", "denied", "error"])
  return false unless decision_validator.valid?(@decision)
  true
end