Class: Cerca::Models::EventStreamForThreadEventsParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Cerca::Models::EventStreamForThreadEventsParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/cerca/models/event_stream_for_thread_events_params.rb

Overview

See Also:

• Resources::Events#stream_for_thread_events_streaming

Defined Under Namespace

Modules: History

Instance Attribute Summary

• #agent_id ⇒ String
• #cursor ⇒ String^?

  Opaque pagination cursor returned by a previous request.

• #events ⇒ String^?

  Comma-separated event type filter.

• #history ⇒ Symbol, ...

  When true, starts from the beginning of the retained buffer.

• #last_event_id ⇒ String^?

  Resume an event-log stream after the last received SSE event id.

• #thread_id ⇒ String

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(agent_id:, thread_id:, cursor: nil, events: nil, history: nil, last_event_id: nil, request_options: {}) ⇒ Object constructor

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(agent_id:, thread_id:, cursor: nil, events: nil, history: nil, last_event_id: nil, request_options: {}) ⇒ Object

Parameters:

• agent_id (String)
• thread_id (String)
• cursor (String) (defaults to: nil) —

  Opaque pagination cursor returned by a previous request.

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

  Comma-separated event type filter.

• history (Symbol, Cerca::Models::EventStreamForThreadEventsParams::History) (defaults to: nil) —

  When true, starts from the beginning of the retained buffer.

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

  Resume an event-log stream after the last received SSE event id.

• request_options (Cerca::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/cerca/models/event_stream_for_thread_events_params.rb', line 44

Instance Attribute Details

#agent_id ⇒ String

Returns:

• (String)

# File 'lib/cerca/models/event_stream_for_thread_events_params.rb', line 13

required :agent_id, String

#cursor ⇒ String^?

Opaque pagination cursor returned by a previous request.

Returns:

• (String, nil)

# File 'lib/cerca/models/event_stream_for_thread_events_params.rb', line 24

optional :cursor, String

#events ⇒ String^?

Comma-separated event type filter.

Returns:

• (String, nil)

# File 'lib/cerca/models/event_stream_for_thread_events_params.rb', line 30

optional :events, String

#history ⇒ Symbol, ...

When true, starts from the beginning of the retained buffer.

Returns:

• (Symbol, Cerca::Models::EventStreamForThreadEventsParams::History, nil)

# File 'lib/cerca/models/event_stream_for_thread_events_params.rb', line 36

optional :history, enum: -> { Cerca::EventStreamForThreadEventsParams::History }

#last_event_id ⇒ String^?

Resume an event-log stream after the last received SSE event id.

Returns:

• (String, nil)

# File 'lib/cerca/models/event_stream_for_thread_events_params.rb', line 42

optional :last_event_id, String

#thread_id ⇒ String

Returns:

• (String)

# File 'lib/cerca/models/event_stream_for_thread_events_params.rb', line 18

required :thread_id, String