Class: DockerEngineRuby::Models::Plugin::Settings::Device

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

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(args:, devices:, env:, mounts:) ⇒ Object

user-configurable settings for the plugin.

Parameters:



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/docker_engine_ruby/models/plugin.rb', line 434

class Device < DockerEngineRuby::Internal::Type::BaseModel
  # @!attribute description
  #
  #   @return [String]
  required :description, String, api_name: :Description

  # @!attribute name
  #
  #   @return [String]
  required :name, String, api_name: :Name

  # @!attribute path
  #
  #   @return [String]
  required :path, String, api_name: :Path

  # @!attribute settable
  #
  #   @return [Array<String>]
  required :settable, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :Settable

  # @!method initialize(description:, name:, path:, settable:)
  #   @param description [String]
  #   @param name [String]
  #   @param path [String]
  #   @param settable [Array<String>]
end

Instance Attribute Details

#description ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :description, String, api_name: :Description

#name ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :name, String, api_name: :Name

#path ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :path, String, api_name: :Path

#settable ⇒ Array<String>

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


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

required :settable, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :Settable

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {