Class: Cadenya::Models::ObjectiveEventData::Cancelled

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

Overview

See Also:

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

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

ObjectiveCancelled is the terminal event written when an objective is cancelled. After this event, the objective is super-terminal: no further iterations, compaction, or continuation are permitted.

Parameters:

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

    Optional human-readable note recorded at cancel time. Today the workflow




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

Instance Attribute Details

#message ⇒ String?

Optional human-readable note recorded at cancel time. Today the workflow sets “Cancelled” but this field leaves room for richer reasons (e.g. “Cancelled by user”, “Cancelled by schedule sweep”, “Credit balance exhausted”).

Returns:

  • (String, nil) 


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

optional :message, String