Class: DockerEngineAPI::Models::Plugin::Config

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• DockerEngineAPI::Models::Plugin::Config

Defined in:

lib/docker_engine_api/models/plugin.rb

Overview

See Also:

• #config

Defined Under Namespace

Classes: Args, Env, Interface, Linux, Mount, Network, Rootfs, User

Instance Attribute Summary

• #args ⇒ DockerEngineAPI::Models::Plugin::Config::Args
• #description ⇒ String
• #documentation ⇒ String
• #entrypoint ⇒ Array<String>
• #env ⇒ Array<DockerEngineAPI::Models::Plugin::Config::Env>
• #interface ⇒ DockerEngineAPI::Models::Plugin::Config::Interface

  The interface between Docker and the plugin.

• #ipc_host ⇒ Boolean
• #linux ⇒ DockerEngineAPI::Models::Plugin::Config::Linux
• #mounts ⇒ Array<DockerEngineAPI::Models::Plugin::Config::Mount>
• #network ⇒ DockerEngineAPI::Models::Plugin::Config::Network
• #pid_host ⇒ Boolean
• #propagated_mount ⇒ String
• #rootfs ⇒ DockerEngineAPI::Models::Plugin::Config::Rootfs^?
• #user ⇒ DockerEngineAPI::Models::Plugin::Config::User^?
• #work_dir ⇒ String

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(diff_ids: nil, type: nil) ⇒ Object constructor

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(diff_ids: nil, type: nil) ⇒ Object

Parameters:

• diff_ids (Array<String>) (defaults to: nil)
• type (String) (defaults to: nil)

# File 'lib/docker_engine_api/models/plugin.rb', line 142

Instance Attribute Details

#args ⇒ DockerEngineAPI::Models::Plugin::Config::Args

Returns:

• (DockerEngineAPI::Models::Plugin::Config::Args)

# File 'lib/docker_engine_api/models/plugin.rb', line 65

required :args, -> { DockerEngineAPI::Plugin::Config::Args }, api_name: :Args

#description ⇒ String

Returns:

• (String)

# File 'lib/docker_engine_api/models/plugin.rb', line 70

required :description, String, api_name: :Description

#documentation ⇒ String

Returns:

• (String)

# File 'lib/docker_engine_api/models/plugin.rb', line 75

required :documentation, String, api_name: :Documentation

#entrypoint ⇒ Array<String>

Returns:

• (Array<String>)

# File 'lib/docker_engine_api/models/plugin.rb', line 80

required :entrypoint, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :Entrypoint

#env ⇒ Array<DockerEngineAPI::Models::Plugin::Config::Env>

Returns:

• (Array<DockerEngineAPI::Models::Plugin::Config::Env>)

# File 'lib/docker_engine_api/models/plugin.rb', line 85

required :env,
-> { DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Plugin::Config::Env] },
api_name: :Env

#interface ⇒ DockerEngineAPI::Models::Plugin::Config::Interface

The interface between Docker and the plugin

Returns:

• (DockerEngineAPI::Models::Plugin::Config::Interface)

# File 'lib/docker_engine_api/models/plugin.rb', line 93

required :interface, -> { DockerEngineAPI::Plugin::Config::Interface }, api_name: :Interface

#ipc_host ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/docker_engine_api/models/plugin.rb', line 98

required :ipc_host, DockerEngineAPI::Internal::Type::Boolean, api_name: :IpcHost

#linux ⇒ DockerEngineAPI::Models::Plugin::Config::Linux

Returns:

• (DockerEngineAPI::Models::Plugin::Config::Linux)

# File 'lib/docker_engine_api/models/plugin.rb', line 103

required :linux, -> { DockerEngineAPI::Plugin::Config::Linux }, api_name: :Linux

#mounts ⇒ Array<DockerEngineAPI::Models::Plugin::Config::Mount>

Returns:

• (Array<DockerEngineAPI::Models::Plugin::Config::Mount>)

# File 'lib/docker_engine_api/models/plugin.rb', line 108

required :mounts,
-> { DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Plugin::Config::Mount] },
api_name: :Mounts

#network ⇒ DockerEngineAPI::Models::Plugin::Config::Network

Returns:

• (DockerEngineAPI::Models::Plugin::Config::Network)

# File 'lib/docker_engine_api/models/plugin.rb', line 115

required :network, -> { DockerEngineAPI::Plugin::Config::Network }, api_name: :Network

#pid_host ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/docker_engine_api/models/plugin.rb', line 120

required :pid_host, DockerEngineAPI::Internal::Type::Boolean, api_name: :PidHost

#propagated_mount ⇒ String

Returns:

• (String)

# File 'lib/docker_engine_api/models/plugin.rb', line 125

required :propagated_mount, String, api_name: :PropagatedMount

#rootfs ⇒ DockerEngineAPI::Models::Plugin::Config::Rootfs^?

Returns:

• (DockerEngineAPI::Models::Plugin::Config::Rootfs, nil)

# File 'lib/docker_engine_api/models/plugin.rb', line 135

optional :rootfs, -> { DockerEngineAPI::Plugin::Config::Rootfs }

#user ⇒ DockerEngineAPI::Models::Plugin::Config::User^?

Returns:

• (DockerEngineAPI::Models::Plugin::Config::User, nil)

# File 'lib/docker_engine_api/models/plugin.rb', line 140

optional :user, -> { DockerEngineAPI::Plugin::Config::User }, api_name: :User

#work_dir ⇒ String

Returns:

• (String)

# File 'lib/docker_engine_api/models/plugin.rb', line 130

required :work_dir, String, api_name: :WorkDir

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/docker_engine_api/models/plugin.rb', line 270