Class: Turbopuffer::Models::OperationError::Detail

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/turbopuffer/models/operation_error.rb,
sig/turbopuffer/models/operation_error.rbs

Overview

See Also:

  • Turbopuffer::Models::OperationError#detail

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, 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, #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(error:, status: :error) ⇒ Detail

The response to an unsuccessful request.

Parameters:

  • error (String)

    The error message.

  • status (Symbol, :error) (defaults to: :error)

    The status of the request.

  • error: (String)
  • status: (:error) (defaults to: :error)


# File 'lib/turbopuffer/models/operation_error.rb', line 37

Instance Attribute Details

#errorString

The error message.

Parameters:

  • value (String)

Returns:

  • (String)


29
# File 'lib/turbopuffer/models/operation_error.rb', line 29

required :error, String

#statusSymbol, :error

The status of the request.

Parameters:

  • value (:error)

Returns:

  • (Symbol, :error)


35
# File 'lib/turbopuffer/models/operation_error.rb', line 35

required :status, const: :error

Instance Method Details

#to_hash{ error: String, status: :error }

Returns:

  • ({ error: String, status: :error })


30
# File 'sig/turbopuffer/models/operation_error.rbs', line 30

def to_hash: -> { error: String, status: :error }