Class: DockerEngineRuby::Models::SwarmSpec

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/docker_engine_ruby/models/swarm_spec.rb

Defined Under Namespace

Classes: CaConfig, Dispatcher, EncryptionConfig, Orchestration, Raft, TaskDefaults

Instance Attribute Summary collapse

Class Method 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(election_tick: nil, heartbeat_tick: nil, keep_old_snapshots: nil, log_entries_for_slow_followers: nil, snapshot_interval: nil) ⇒ Object

Raft configuration.

Parameters:

  • election_tick (Integer) (defaults to: nil)
  • heartbeat_tick (Integer) (defaults to: nil)
  • keep_old_snapshots (Integer) (defaults to: nil)
  • log_entries_for_slow_followers (Integer) (defaults to: nil)
  • snapshot_interval (Integer) (defaults to: nil)


# File 'lib/docker_engine_ruby/models/swarm_spec.rb', line 59


Instance Attribute Details

#ca_configDockerEngineRuby::Models::SwarmSpec::CaConfig?

CA configuration.



10
# File 'lib/docker_engine_ruby/models/swarm_spec.rb', line 10

optional :ca_config, -> { DockerEngineRuby::SwarmSpec::CaConfig }, api_name: :CAConfig, nil?: true

#dispatcherDockerEngineRuby::Models::SwarmSpec::Dispatcher?

Dispatcher configuration.



16
# File 'lib/docker_engine_ruby/models/swarm_spec.rb', line 16

optional :dispatcher, -> { DockerEngineRuby::SwarmSpec::Dispatcher }, api_name: :Dispatcher, nil?: true

#encryption_configDockerEngineRuby::Models::SwarmSpec::EncryptionConfig?

Parameters related to encryption-at-rest.



22
23
24
# File 'lib/docker_engine_ruby/models/swarm_spec.rb', line 22

optional :encryption_config,
-> { DockerEngineRuby::SwarmSpec::EncryptionConfig },
api_name: :EncryptionConfig

#labelsHash{Symbol=>String}?

User-defined key/value metadata.

Returns:

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


30
# File 'lib/docker_engine_ruby/models/swarm_spec.rb', line 30

optional :labels, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Labels

#nameString?

Name of the swarm.

Returns:

  • (String, nil)


36
# File 'lib/docker_engine_ruby/models/swarm_spec.rb', line 36

optional :name, String, api_name: :Name

#orchestrationDockerEngineRuby::Models::SwarmSpec::Orchestration?

Orchestration configuration.



42
43
44
45
# File 'lib/docker_engine_ruby/models/swarm_spec.rb', line 42

optional :orchestration,
-> { DockerEngineRuby::SwarmSpec::Orchestration },
api_name: :Orchestration,
nil?: true

#raftDockerEngineRuby::Models::SwarmSpec::Raft?

Raft configuration.



51
# File 'lib/docker_engine_ruby/models/swarm_spec.rb', line 51

optional :raft, -> { DockerEngineRuby::SwarmSpec::Raft }, api_name: :Raft

#task_defaultsDockerEngineRuby::Models::SwarmSpec::TaskDefaults?

Defaults for creating tasks in this cluster.



57
# File 'lib/docker_engine_ruby/models/swarm_spec.rb', line 57

optional :task_defaults, -> { DockerEngineRuby::SwarmSpec::TaskDefaults }, api_name: :TaskDefaults

Class Method Details

.valuesArray<Symbol>

Returns:

  • (Array<Symbol>)


# File 'lib/docker_engine_ruby/models/swarm_spec.rb', line 153