Class: AssemblyAI::Realtime::TerminateSession

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(terminate_session:, additional_properties: nil) ⇒ AssemblyAI::Realtime::TerminateSession

Parameters:

  • terminate_session (Boolean) —

    Set to true to end your streaming session forever

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



22
23
24
25
26
 
# File 'lib/assemblyai/realtime/types/terminate_session.rb', line 22

def initialize(terminate_session:, additional_properties: nil)
  @terminate_session = terminate_session
  @additional_properties = additional_properties
  @_field_set = { "terminate_session": terminate_session }
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



12
13
14
 
# File 'lib/assemblyai/realtime/types/terminate_session.rb', line 12

def additional_properties
  @additional_properties
end

#terminate_session ⇒ Boolean (readonly)

Returns Set to true to end your streaming session forever.

Returns:

  • (Boolean) —

    Set to true to end your streaming session forever



10
11
12
 
# File 'lib/assemblyai/realtime/types/terminate_session.rb', line 10

def terminate_session
  @terminate_session
end

Class Method Details

.from_json(json_object:) ⇒ AssemblyAI::Realtime::TerminateSession

Deserialize a JSON object to an instance of TerminateSession

Parameters:

  • json_object (String)

Returns:



32
33
34
35
36
 
# File 'lib/assemblyai/realtime/types/terminate_session.rb', line 32

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


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

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

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of TerminateSession to a JSON object

Returns:

  • (String) 


41
42
43
 
# File 'lib/assemblyai/realtime/types/terminate_session.rb', line 41

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