Class: Cadenya::Models::BulkWorkspaceApplyData

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

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(bundle_key:, agents: nil, automatically_publish_agents: nil, memory_layers: nil, source_url: nil, tool_sets: nil) ⇒ Object

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

Parameters:

  • bundle_key (String) —

    Required. Bundle ownership key. Resources created or updated by an

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

    Agents to upsert, keyed by external_id.

  • automatically_publish_agents (Boolean) (defaults to: nil) —

    When true, every agent created or updated by this Apply has its

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

    Memory layers to upsert, keyed by external_id.

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

    Optional URL pointing to the source of this apply (GitHub PR,

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

    Tool sets to upsert, keyed by external_id.




# File 'lib/cadenya/models/bulk_workspace_apply_data.rb', line 58

Instance Attribute Details

#agents ⇒ Hash{Symbol=>Cadenya::Models::AgentEntry}?

Agents to upsert, keyed by external_id.

Returns:



19
 
# File 'lib/cadenya/models/bulk_workspace_apply_data.rb', line 19

optional :agents, -> { Cadenya::Internal::Type::HashOf[Cadenya::AgentEntry] }

#automatically_publish_agents ⇒ Boolean?

When true, every agent created or updated by this Apply has its state forced to STATE_PUBLISHED, regardless of the state declared on the agent’s entry. Useful when the bundle represents a production configuration and you want all of its agents live without setting state: STATE_PUBLISHED on each entry.

Default false: each agent entry’s ‘state` controls (which is STATE_DRAFT on create when unspecified).

Returns:

  • (Boolean, nil) 


31
32
33
 
# File 'lib/cadenya/models/bulk_workspace_apply_data.rb', line 31

optional :automatically_publish_agents,
Cadenya::Internal::Type::Boolean,
api_name: :automaticallyPublishAgents

#bundle_key ⇒ String

Required. Bundle ownership key. Resources created or updated by an Apply have their ‘metadata.bundle_key` set to this value. On subsequent applies with the same bundle_key, resources currently bearing this bundle_key but absent from the spec are soft-deleted.

Returns:

  • (String) 


13
 
# File 'lib/cadenya/models/bulk_workspace_apply_data.rb', line 13

required :bundle_key, String, api_name: :bundleKey

#memory_layers ⇒ Hash{Symbol=>Cadenya::Models::MemoryLayerEntry}?

Memory layers to upsert, keyed by external_id.

Returns:



39
40
41
 
# File 'lib/cadenya/models/bulk_workspace_apply_data.rb', line 39

optional :memory_layers,
-> { Cadenya::Internal::Type::HashOf[Cadenya::MemoryLayerEntry] },
api_name: :memoryLayers

#source_url ⇒ String?

Optional URL pointing to the source of this apply (GitHub PR, Jenkins build, GitLab pipeline, etc.). Surfaced in the dashboard so users can jump from an apply back to the change that produced it. Free-form HTTPS URI; not interpreted by the server.

Returns:

  • (String, nil) 


50
 
# File 'lib/cadenya/models/bulk_workspace_apply_data.rb', line 50

optional :source_url, String, api_name: :sourceUrl

#tool_sets ⇒ Hash{Symbol=>Cadenya::Models::ToolSetEntry}?

Tool sets to upsert, keyed by external_id.

Returns:



56
 
# File 'lib/cadenya/models/bulk_workspace_apply_data.rb', line 56

optional :tool_sets, -> { Cadenya::Internal::Type::HashOf[Cadenya::ToolSetEntry] }, api_name: :toolSets