Class: Cadenya::Models::AgentEntry

Inherits:

Internal::Type::BaseModel

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

Defined in:

lib/cadenya/models/agent_entry.rb

Defined Under Namespace

Modules: State

Instance Attribute Summary

• #labels ⇒ Hash{Symbol=>String}^?
• #name ⇒ String
• #schedules ⇒ Hash{Symbol=>Cadenya::Models::AgentScheduleEntry}^?

  Schedules under this agent, keyed by external_id.

• #spec ⇒ Cadenya::Models::AgentSpec

  Agent specification (user-provided configuration).

• #state ⇒ Symbol, ...

  Desired lifecycle state for the agent.

• #variations ⇒ Hash{Symbol=>Cadenya::Models::AgentVariationEntry}^?

  Variations under this agent, keyed by external_id.

Instance Method Summary

• #initialize(name:, spec:, labels: nil, schedules: nil, state: nil, variations: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see AgentEntry 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(name:, spec:, labels: nil, schedules: nil, state: nil, variations: nil) ⇒ Object

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

Parameters:

• name (String)
• spec (Cadenya::Models::AgentSpec) —

  Agent specification (user-provided configuration)

• labels (Hash{Symbol=>String}) (defaults to: nil)
• schedules (Hash{Symbol=>Cadenya::Models::AgentScheduleEntry}) (defaults to: nil) —

  Schedules under this agent, keyed by external_id.

• state (Symbol, Cadenya::Models::AgentEntry::State) (defaults to: nil) —

  Desired lifecycle state for the agent. Defaults to STATE_DRAFT when

• variations (Hash{Symbol=>Cadenya::Models::AgentVariationEntry}) (defaults to: nil) —

  Variations under this agent, keyed by external_id.

# File 'lib/cadenya/models/agent_entry.rb', line 42

Instance Attribute Details

#labels ⇒ Hash{Symbol=>String}^?

Returns:

• (Hash{Symbol=>String}, nil)

# File 'lib/cadenya/models/agent_entry.rb', line 20

optional :labels, Cadenya::Internal::Type::HashOf[String]

#name ⇒ String

Returns:

• (String)

# File 'lib/cadenya/models/agent_entry.rb', line 9

required :name, String

#schedules ⇒ Hash{Symbol=>Cadenya::Models::AgentScheduleEntry}^?

Schedules under this agent, keyed by external_id.

Returns:

• (Hash{Symbol=>Cadenya::Models::AgentScheduleEntry}, nil)

# File 'lib/cadenya/models/agent_entry.rb', line 26

optional :schedules, -> { Cadenya::Internal::Type::HashOf[Cadenya::AgentScheduleEntry] }

#spec ⇒ Cadenya::Models::AgentSpec

Agent specification (user-provided configuration)

Returns:

• (Cadenya::Models::AgentSpec)

# File 'lib/cadenya/models/agent_entry.rb', line 15

required :spec, -> { Cadenya::AgentSpec }

#state ⇒ Symbol, ...

Desired lifecycle state for the agent. Defaults to STATE_DRAFT when unspecified. STATE_PUBLISHED publishes the agent once its variations exist; see also BulkWorkspaceApplyData.automatically_publish_agents.

Returns:

• (Symbol, Cadenya::Models::AgentEntry::State, nil)

# File 'lib/cadenya/models/agent_entry.rb', line 34

optional :state, enum: -> { Cadenya::AgentEntry::State }

#variations ⇒ Hash{Symbol=>Cadenya::Models::AgentVariationEntry}^?

Variations under this agent, keyed by external_id.

Returns:

• (Hash{Symbol=>Cadenya::Models::AgentVariationEntry}, nil)

# File 'lib/cadenya/models/agent_entry.rb', line 40

optional :variations, -> { Cadenya::Internal::Type::HashOf[Cadenya::AgentVariationEntry] }