Class: Cadenya::Models::Objective

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Cadenya::Models::Objective

Defined in:

lib/cadenya/models/objective.rb

Overview

See Also:

• Resources::Objectives#create

Instance Attribute Summary

• #data ⇒ Cadenya::Models::ObjectiveData
• #metadata ⇒ Cadenya::Models::OperationMetadata

  Metadata for ephemeral operations and activities (e.g., objectives, executions, runs).

• #status ⇒ Cadenya::Models::ObjectiveStatus

Instance Method Summary

• #initialize(data:, metadata:, status:, info: nil, last_five_windows: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see Objective for more details.

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(data:, metadata:, status:, info: nil, last_five_windows: nil) ⇒ Object

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

Parameters:

• data (Cadenya::Models::ObjectiveData)
• metadata (Cadenya::Models::OperationMetadata) —

  Metadata for ephemeral operations and activities (e.g., objectives, executions,

• status (Cadenya::Models::ObjectiveStatus)
• info (Cadenya::Models::ObjectiveInfo) (defaults to: nil) —

  ObjectiveInfo provides read-only aggregated statistics about an objective’s exec

• last_five_windows (Array<Cadenya::Models::ObjectiveContextWindow>) (defaults to: nil) —

  Read-only list of the last five windows of execution for this objective, ordered

# File 'lib/cadenya/models/objective.rb', line 43

Instance Attribute Details

#data ⇒ Cadenya::Models::ObjectiveData

Returns:

• (Cadenya::Models::ObjectiveData)

# File 'lib/cadenya/models/objective.rb', line 10

required :data, -> { Cadenya::ObjectiveData }

#metadata ⇒ Cadenya::Models::OperationMetadata

Metadata for ephemeral operations and activities (e.g., objectives, executions, runs)

Returns:

• (Cadenya::Models::OperationMetadata)

# File 'lib/cadenya/models/objective.rb', line 17

required :metadata, -> { Cadenya::OperationMetadata }

#status ⇒ Cadenya::Models::ObjectiveStatus

Returns:

• (Cadenya::Models::ObjectiveStatus)

# File 'lib/cadenya/models/objective.rb', line 22

required :status, -> { Cadenya::ObjectiveStatus }