Class: AssemblyAI::Error

Inherits:
Object
  • Object
show all
Defined in:
lib/assemblyai/types/error.rb

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(error:, status: OMIT, additional_properties: nil) ⇒ AssemblyAI::Error

Parameters:

  • error (String) —

    Error message

  • status (String) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



24
25
26
27
28
29
30
31
 
# File 'lib/assemblyai/types/error.rb', line 24

def initialize(error:, status: OMIT, additional_properties: nil)
  @error = error
  @status = status if status != OMIT
  @additional_properties = additional_properties
  @_field_set = { "error": error, "status": status }.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



13
14
15
 
# File 'lib/assemblyai/types/error.rb', line 13

def additional_properties
  @additional_properties
end

#error ⇒ String (readonly)

Returns Error message.

Returns:

  • (String) —

    Error message



9
10
11
 
# File 'lib/assemblyai/types/error.rb', line 9

def error
  @error
end

#status ⇒ String (readonly)

Returns:

  • (String) 


11
12
13
 
# File 'lib/assemblyai/types/error.rb', line 11

def status
  @status
end

Class Method Details

.from_json(json_object:) ⇒ AssemblyAI::Error

Deserialize a JSON object to an instance of Error

Parameters:

  • json_object (String)

Returns:



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/assemblyai/types/error.rb', line 37

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  error = struct["error"]
  status = struct["status"]
  new(
    error: error,
    status: status,
    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) 


61
62
63
64
 
# File 'lib/assemblyai/types/error.rb', line 61

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

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of Error to a JSON object

Returns:

  • (String) 


51
52
53
 
# File 'lib/assemblyai/types/error.rb', line 51

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