Class: Ittybit::TaskResults

Inherits:
Object
  • Object
show all
Defined in:
lib/ittybit/types/task_results.rb

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(passed: OMIT, failed: OMIT, continue: OMIT, additional_properties: nil) ⇒ Ittybit::TaskResults

Parameters:

  • passed (Array<Hash{String => Object}>) (defaults to: OMIT)
  • failed (Array<Hash{String => Object}>) (defaults to: OMIT)
  • continue (Boolean) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



27
28
29
30
31
32
33
34
35
 
# File 'lib/ittybit/types/task_results.rb', line 27

def initialize(passed: OMIT, failed: OMIT, continue: OMIT, additional_properties: nil)
  @passed = passed if passed != OMIT
  @failed = failed if failed != OMIT
  @continue = continue if continue != OMIT
  @additional_properties = additional_properties
  @_field_set = { "passed": passed, "failed": failed, "continue": continue }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



15
16
17
 
# File 'lib/ittybit/types/task_results.rb', line 15

def additional_properties
  @additional_properties
end

#continue ⇒ Boolean (readonly)

Returns:

  • (Boolean) 


13
14
15
 
# File 'lib/ittybit/types/task_results.rb', line 13

def continue
  @continue
end

#failed ⇒ Array<Hash{String => Object}> (readonly)

Returns:

  • (Array<Hash{String => Object}>) 


11
12
13
 
# File 'lib/ittybit/types/task_results.rb', line 11

def failed
  @failed
end

#passed ⇒ Array<Hash{String => Object}> (readonly)

Returns:

  • (Array<Hash{String => Object}>) 


9
10
11
 
# File 'lib/ittybit/types/task_results.rb', line 9

def passed
  @passed
end

Class Method Details

.from_json(json_object:) ⇒ Ittybit::TaskResults

Deserialize a JSON object to an instance of TaskResults

Parameters:

  • json_object (String)

Returns:



41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/ittybit/types/task_results.rb', line 41

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  passed = parsed_json["passed"]
  failed = parsed_json["failed"]
  continue = parsed_json["continue"]
  new(
    passed: passed,
    failed: failed,
    continue: continue,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given

hash and check each fields type against the current object's property
definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


68
69
70
71
72
 
# File 'lib/ittybit/types/task_results.rb', line 68

def self.validate_raw(obj:)
  obj.passed&.is_a?(Array) != false || raise("Passed value for field obj.passed is not the expected type, validation failed.")
  obj.failed&.is_a?(Array) != false || raise("Passed value for field obj.failed is not the expected type, validation failed.")
  obj.continue&.is_a?(Boolean) != false || raise("Passed value for field obj.continue is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of TaskResults to a JSON object

Returns:

  • (String) 


58
59
60
 
# File 'lib/ittybit/types/task_results.rb', line 58

def to_json(*_args)
  @_field_set&.to_json
end