Class: DockerEngineRuby::Models::Plugin

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/docker_engine_ruby/models/plugin.rb,
sig/docker_engine_ruby/models/plugin.rbs

Overview

See Also:

  • DockerEngineRuby::Resources::Plugins#delete

Defined Under Namespace

Classes: Config, Settings

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(gid: nil, uid: nil) ⇒ Object

Parameters:

  • gid (Integer) (defaults to: nil)
  • uid (Integer) (defaults to: nil) 



# File 'lib/docker_engine_ruby/models/plugin.rb', line 42

Instance Attribute Details

#config ⇒ DockerEngineRuby::Models::Plugin::Config

The config of a plugin.

Parameters:

  • value (DockerEngineRuby::Plugin::Config)

Returns:



11
 
# File 'lib/docker_engine_ruby/models/plugin.rb', line 11

required :config, -> { DockerEngineRuby::Plugin::Config }, api_name: :Config

#enabled ⇒ Boolean

True if the plugin is running. False if the plugin is not running, only installed.

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


18
 
# File 'lib/docker_engine_ruby/models/plugin.rb', line 18

required :enabled, DockerEngineRuby::Internal::Type::Boolean, api_name: :Enabled

#id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


34
 
# File 'lib/docker_engine_ruby/models/plugin.rb', line 34

optional :id, String, api_name: :Id

#name ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


23
 
# File 'lib/docker_engine_ruby/models/plugin.rb', line 23

required :name, String, api_name: :Name

#plugin_reference ⇒ String?

plugin remote reference used to push/pull the plugin

Parameters:

  • (String)

Returns:

  • (String, nil) 


40
 
# File 'lib/docker_engine_ruby/models/plugin.rb', line 40

optional :plugin_reference, String, api_name: :PluginReference

#settings ⇒ DockerEngineRuby::Models::Plugin::Settings

user-configurable settings for the plugin.

Parameters:

  • value (DockerEngineRuby::Plugin::Settings)

Returns:



29
 
# File 'lib/docker_engine_ruby/models/plugin.rb', line 29

required :settings, -> { DockerEngineRuby::Plugin::Settings }, api_name: :Settings

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


39
 
# File 'sig/docker_engine_ruby/models/plugin.rbs', line 39

def to_hash: -> {