Class: OpenAI::Models::Live::ServerEvent::TransportFailed::Error

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/live/server_event.rb,
sig/openai/models/live/server_event.rbs

Overview

See Also:

  • OpenAI::Models::Live::ServerEvent::TransportFailed#error

Instance Attribute Summary collapse

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, fields, hash, #hash, inherited, #inspect, inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, coerce_with_error, dump, #dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(code:, message:, param: nil, type: :call_error) ⇒ Object

Parameters:

  • code (String) —

    The call setup failure code.

  • message (String)
  • param (String) (defaults to: nil) —

    The parameter related to the error, if any. Empty when no parameter applies.

  • type (Symbol, :call_error) (defaults to: :call_error) 



# File 'lib/openai/models/live/server_event.rb', line 277

Instance Attribute Details

#code ⇒ String

The call setup failure code.

Parameters:

  • value (String)

Returns:

  • (String) 


259
 
# File 'lib/openai/models/live/server_event.rb', line 259

required :code, String

#message ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


264
 
# File 'lib/openai/models/live/server_event.rb', line 264

required :message, String

#param ⇒ String?

The parameter related to the error, if any. Empty when no parameter applies.

Parameters:

  • (String)

Returns:

  • (String, nil) 


275
 
# File 'lib/openai/models/live/server_event.rb', line 275

optional :param, String

#type ⇒ Symbol, :call_error

Parameters:

  • value (:call_error)

Returns:

  • (Symbol, :call_error) 


269
 
# File 'lib/openai/models/live/server_event.rb', line 269

required :type, const: :call_error

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


199
 
# File 'sig/openai/models/live/server_event.rbs', line 199

def to_hash: -> {