Class: Stagehand::Models::StreamEvent::Data::StreamEventSystemDataOutput

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Stagehand::Models::StreamEvent::Data::StreamEventSystemDataOutput

Defined in:

lib/stagehand/models/stream_event.rb

Defined Under Namespace

Modules: Status

Instance Attribute Summary

• #error ⇒ String^?

  Error message (present when status is ‘error’).

• #result ⇒ Object^?

  Operation result (present when status is ‘finished’).

• #status ⇒ Symbol, Stagehand::Models::StreamEvent::Data::StreamEventSystemDataOutput::Status

  Current status of the streaming operation.

Instance Method Summary

• #initialize(status:, error: nil, result: nil) ⇒ Object constructor

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(status:, error: nil, result: nil) ⇒ Object

Parameters:

• status (Symbol, Stagehand::Models::StreamEvent::Data::StreamEventSystemDataOutput::Status) —

  Current status of the streaming operation

• error (String) (defaults to: nil) —

  Error message (present when status is ‘error’)

• result (Object) (defaults to: nil) —

  Operation result (present when status is ‘finished’)

# File 'lib/stagehand/models/stream_event.rb', line 61

Instance Attribute Details

#error ⇒ String^?

Error message (present when status is ‘error’)

Returns:

• (String, nil)

# File 'lib/stagehand/models/stream_event.rb', line 53

optional :error, String

#result ⇒ Object^?

Operation result (present when status is ‘finished’)

Returns:

• (Object, nil)

# File 'lib/stagehand/models/stream_event.rb', line 59

optional :result, Stagehand::Internal::Type::Unknown

#status ⇒ Symbol, Stagehand::Models::StreamEvent::Data::StreamEventSystemDataOutput::Status

Current status of the streaming operation

Returns:

• (Symbol, Stagehand::Models::StreamEvent::Data::StreamEventSystemDataOutput::Status)

# File 'lib/stagehand/models/stream_event.rb', line 47

required :status, enum: -> { Stagehand::StreamEvent::Data::StreamEventSystemDataOutput::Status }