Class: Cadenya::Models::ObjectiveEventData::Notice

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

Overview

See Also:

  • Cadenya::Models::ObjectiveEventData#notice

Defined Under Namespace

Modules: Level

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(key: nil, level: nil, message: nil) ⇒ Object

Some parameter documentations has been truncated, see Cadenya::Models::ObjectiveEventData::Notice for more details.

Notice is a non-terminal diagnostic emitted by the runtime when something noteworthy but non-fatal happens during an objective — for example a just-in-time tool set failing to load, or a previously loaded tool being dropped because it was archived. Notices carry no structured payload; they exist to make the objective timeline self-explanatory.

Parameters:

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

    Stable machine-readable identifier for the notice kind (for example

  • level (Symbol, Cadenya::Models::ObjectiveEventData::Notice::Level) (defaults to: nil)
  • message (String) (defaults to: nil) —

    Human-readable description of what happened.




# File 'lib/cadenya/models/objective_event_data.rb', line 212

Instance Attribute Details

#key ⇒ String?

Stable machine-readable identifier for the notice kind (for example "tool_set_load_failed", "tool_archived"). Clients can switch on it or use it as an i18n key; the message is the English fallback.

Parameters:

  • (String)

Returns:

  • (String, nil) 


199
 
# File 'lib/cadenya/models/objective_event_data.rb', line 199

optional :key, String

#level ⇒ Symbol, ...

Returns:



204
 
# File 'lib/cadenya/models/objective_event_data.rb', line 204

optional :level, enum: -> { Cadenya::ObjectiveEventData::Notice::Level }

#message ⇒ String?

Human-readable description of what happened.

Parameters:

  • (String)

Returns:

  • (String, nil) 


210
 
# File 'lib/cadenya/models/objective_event_data.rb', line 210

optional :message, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


201
 
# File 'sig/cadenya/models/objective_event_data.rbs', line 201

def to_hash: -> {