Class: DockerEngineRuby::Models::ConfigSpec

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

Defined Under Namespace

Classes: Templating

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(data: nil, labels: nil, name: nil, templating: nil) ⇒ Object

Some parameter documentations has been truncated, see DockerEngineRuby::Models::ConfigSpec for more details.

Parameters:

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

    Data is the data to store as a config, formatted as a standard base64-encoded

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

    User-defined key/value metadata.

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

    User-defined name of the config.

  • templating (DockerEngineRuby::Models::ConfigSpec::Templating) (defaults to: nil) —

    Driver represents a driver (network, logging, secrets).




# File 'lib/docker_engine_ruby/models/config_spec.rb', line 33

Instance Attribute Details

#data ⇒ String?

Data is the data to store as a config, formatted as a standard base64-encoded ([RFC 4648](tools.ietf.org/html/rfc4648#section-4)) string. The maximum allowed size is 1000KB, as defined in [MaxConfigSize](pkg.go.dev/github.com/moby/swarmkit/v2

Returns:

  • (String, nil) 


13
 
# File 'lib/docker_engine_ruby/models/config_spec.rb', line 13

optional :data, String, api_name: :Data

#labels ⇒ Hash{Symbol=>String}?

User-defined key/value metadata.

Returns:

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


19
 
# File 'lib/docker_engine_ruby/models/config_spec.rb', line 19

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

#name ⇒ String?

User-defined name of the config.

Returns:

  • (String, nil) 


25
 
# File 'lib/docker_engine_ruby/models/config_spec.rb', line 25

optional :name, String, api_name: :Name

#templating ⇒ DockerEngineRuby::Models::ConfigSpec::Templating?

Driver represents a driver (network, logging, secrets).

Returns:



31
 
# File 'lib/docker_engine_ruby/models/config_spec.rb', line 31

optional :templating, -> { DockerEngineRuby::ConfigSpec::Templating }, api_name: :Templating