docker-engine 0.1.1 → 0.2.0

data/lib/docker_engine/models/plugin.rb

@@ -0,0 +1,530 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Plugins#delete
+    class Plugin < DockerEngine::Internal::Type::BaseModel
+      # @!attribute config
+      #   The config of a plugin.
+      #
+      #   @return [DockerEngine::Models::Plugin::Config]
+      required :config, -> { DockerEngine::Plugin::Config }, api_name: :Config
+
+      # @!attribute enabled
+      #   True if the plugin is running. False if the plugin is not running, only
+      #   installed.
+      #
+      #   @return [Boolean]
+      required :enabled, DockerEngine::Internal::Type::Boolean, api_name: :Enabled
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String, api_name: :Name
+
+      # @!attribute settings
+      #   user-configurable settings for the plugin.
+      #
+      #   @return [DockerEngine::Models::Plugin::Settings]
+      required :settings, -> { DockerEngine::Plugin::Settings }, api_name: :Settings
+
+      # @!attribute id
+      #
+      #   @return [String, nil]
+      optional :id, String, api_name: :Id
+
+      # @!attribute plugin_reference
+      #   plugin remote reference used to push/pull the plugin
+      #
+      #   @return [String, nil]
+      optional :plugin_reference, String, api_name: :PluginReference
+
+      # @!method initialize(config:, enabled:, name:, settings:, id: nil, plugin_reference: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::Plugin} for more details.
+      #
+      #   A plugin for the Engine API
+      #
+      #   @param config [DockerEngine::Models::Plugin::Config] The config of a plugin.
+      #
+      #   @param enabled [Boolean] True if the plugin is running. False if the plugin is not running, only installe
+      #
+      #   @param name [String]
+      #
+      #   @param settings [DockerEngine::Models::Plugin::Settings] user-configurable settings for the plugin.
+      #
+      #   @param id [String]
+      #
+      #   @param plugin_reference [String] plugin remote reference used to push/pull the plugin
+
+      # @see DockerEngine::Models::Plugin#config
+      class Config < DockerEngine::Internal::Type::BaseModel
+        # @!attribute args
+        #
+        #   @return [DockerEngine::Models::Plugin::Config::Args]
+        required :args, -> { DockerEngine::Plugin::Config::Args }, api_name: :Args
+
+        # @!attribute description
+        #
+        #   @return [String]
+        required :description, String, api_name: :Description
+
+        # @!attribute documentation
+        #
+        #   @return [String]
+        required :documentation, String, api_name: :Documentation
+
+        # @!attribute entrypoint
+        #
+        #   @return [Array<String>]
+        required :entrypoint, DockerEngine::Internal::Type::ArrayOf[String], api_name: :Entrypoint
+
+        # @!attribute env
+        #
+        #   @return [Array<DockerEngine::Models::Plugin::Config::Env>]
+        required :env,
+                 -> { DockerEngine::Internal::Type::ArrayOf[DockerEngine::Plugin::Config::Env] },
+                 api_name: :Env
+
+        # @!attribute interface
+        #   The interface between Docker and the plugin
+        #
+        #   @return [DockerEngine::Models::Plugin::Config::Interface]
+        required :interface, -> { DockerEngine::Plugin::Config::Interface }, api_name: :Interface
+
+        # @!attribute ipc_host
+        #
+        #   @return [Boolean]
+        required :ipc_host, DockerEngine::Internal::Type::Boolean, api_name: :IpcHost
+
+        # @!attribute linux
+        #
+        #   @return [DockerEngine::Models::Plugin::Config::Linux]
+        required :linux, -> { DockerEngine::Plugin::Config::Linux }, api_name: :Linux
+
+        # @!attribute mounts
+        #
+        #   @return [Array<DockerEngine::Models::Plugin::Config::Mount>]
+        required :mounts,
+                 -> { DockerEngine::Internal::Type::ArrayOf[DockerEngine::Plugin::Config::Mount] },
+                 api_name: :Mounts
+
+        # @!attribute network
+        #
+        #   @return [DockerEngine::Models::Plugin::Config::Network]
+        required :network, -> { DockerEngine::Plugin::Config::Network }, api_name: :Network
+
+        # @!attribute pid_host
+        #
+        #   @return [Boolean]
+        required :pid_host, DockerEngine::Internal::Type::Boolean, api_name: :PidHost
+
+        # @!attribute propagated_mount
+        #
+        #   @return [String]
+        required :propagated_mount, String, api_name: :PropagatedMount
+
+        # @!attribute work_dir
+        #
+        #   @return [String]
+        required :work_dir, String, api_name: :WorkDir
+
+        # @!attribute rootfs
+        #
+        #   @return [DockerEngine::Models::Plugin::Config::Rootfs, nil]
+        optional :rootfs, -> { DockerEngine::Plugin::Config::Rootfs }
+
+        # @!attribute user
+        #
+        #   @return [DockerEngine::Models::Plugin::Config::User, nil]
+        optional :user, -> { DockerEngine::Plugin::Config::User }, api_name: :User
+
+        # @!method initialize(args:, description:, documentation:, entrypoint:, env:, interface:, ipc_host:, linux:, mounts:, network:, pid_host:, propagated_mount:, work_dir:, rootfs: nil, user: nil)
+        #   The config of a plugin.
+        #
+        #   @param args [DockerEngine::Models::Plugin::Config::Args]
+        #
+        #   @param description [String]
+        #
+        #   @param documentation [String]
+        #
+        #   @param entrypoint [Array<String>]
+        #
+        #   @param env [Array<DockerEngine::Models::Plugin::Config::Env>]
+        #
+        #   @param interface [DockerEngine::Models::Plugin::Config::Interface] The interface between Docker and the plugin
+        #
+        #   @param ipc_host [Boolean]
+        #
+        #   @param linux [DockerEngine::Models::Plugin::Config::Linux]
+        #
+        #   @param mounts [Array<DockerEngine::Models::Plugin::Config::Mount>]
+        #
+        #   @param network [DockerEngine::Models::Plugin::Config::Network]
+        #
+        #   @param pid_host [Boolean]
+        #
+        #   @param propagated_mount [String]
+        #
+        #   @param work_dir [String]
+        #
+        #   @param rootfs [DockerEngine::Models::Plugin::Config::Rootfs]
+        #
+        #   @param user [DockerEngine::Models::Plugin::Config::User]
+
+        # @see DockerEngine::Models::Plugin::Config#args
+        class Args < DockerEngine::Internal::Type::BaseModel
+          # @!attribute description
+          #
+          #   @return [String]
+          required :description, String, api_name: :Description
+
+          # @!attribute name
+          #
+          #   @return [String]
+          required :name, String, api_name: :Name
+
+          # @!attribute settable
+          #
+          #   @return [Array<String>]
+          required :settable, DockerEngine::Internal::Type::ArrayOf[String], api_name: :Settable
+
+          # @!attribute value
+          #
+          #   @return [Array<String>]
+          required :value, DockerEngine::Internal::Type::ArrayOf[String], api_name: :Value
+
+          # @!method initialize(description:, name:, settable:, value:)
+          #   @param description [String]
+          #   @param name [String]
+          #   @param settable [Array<String>]
+          #   @param value [Array<String>]
+        end
+
+        class Env < DockerEngine::Internal::Type::BaseModel
+          # @!attribute description
+          #
+          #   @return [String]
+          required :description, String, api_name: :Description
+
+          # @!attribute name
+          #
+          #   @return [String]
+          required :name, String, api_name: :Name
+
+          # @!attribute settable
+          #
+          #   @return [Array<String>]
+          required :settable, DockerEngine::Internal::Type::ArrayOf[String], api_name: :Settable
+
+          # @!attribute value
+          #
+          #   @return [String]
+          required :value, String, api_name: :Value
+
+          # @!method initialize(description:, name:, settable:, value:)
+          #   @param description [String]
+          #   @param name [String]
+          #   @param settable [Array<String>]
+          #   @param value [String]
+        end
+
+        # @see DockerEngine::Models::Plugin::Config#interface
+        class Interface < DockerEngine::Internal::Type::BaseModel
+          # @!attribute socket
+          #
+          #   @return [String]
+          required :socket, String, api_name: :Socket
+
+          # @!attribute types
+          #
+          #   @return [Array<String>]
+          required :types, DockerEngine::Internal::Type::ArrayOf[String], api_name: :Types
+
+          # @!attribute protocol_scheme
+          #   Protocol to use for clients connecting to the plugin.
+          #
+          #   @return [Symbol, DockerEngine::Models::Plugin::Config::Interface::ProtocolScheme, nil]
+          optional :protocol_scheme,
+                   enum: -> { DockerEngine::Plugin::Config::Interface::ProtocolScheme },
+                   api_name: :ProtocolScheme
+
+          # @!method initialize(socket:, types:, protocol_scheme: nil)
+          #   The interface between Docker and the plugin
+          #
+          #   @param socket [String]
+          #
+          #   @param types [Array<String>]
+          #
+          #   @param protocol_scheme [Symbol, DockerEngine::Models::Plugin::Config::Interface::ProtocolScheme] Protocol to use for clients connecting to the plugin.
+
+          # Protocol to use for clients connecting to the plugin.
+          #
+          # @see DockerEngine::Models::Plugin::Config::Interface#protocol_scheme
+          module ProtocolScheme
+            extend DockerEngine::Internal::Type::Enum
+
+            EMPTY = :""
+            MOBY_PLUGINS_HTTP_V1 = :"moby.plugins.http/v1"
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # @see DockerEngine::Models::Plugin::Config#linux
+        class Linux < DockerEngine::Internal::Type::BaseModel
+          # @!attribute allow_all_devices
+          #
+          #   @return [Boolean]
+          required :allow_all_devices, DockerEngine::Internal::Type::Boolean, api_name: :AllowAllDevices
+
+          # @!attribute capabilities
+          #
+          #   @return [Array<String>]
+          required :capabilities, DockerEngine::Internal::Type::ArrayOf[String], api_name: :Capabilities
+
+          # @!attribute devices
+          #
+          #   @return [Array<DockerEngine::Models::Plugin::Config::Linux::Device>]
+          required :devices,
+                   -> { DockerEngine::Internal::Type::ArrayOf[DockerEngine::Plugin::Config::Linux::Device] },
+                   api_name: :Devices
+
+          # @!method initialize(allow_all_devices:, capabilities:, devices:)
+          #   @param allow_all_devices [Boolean]
+          #   @param capabilities [Array<String>]
+          #   @param devices [Array<DockerEngine::Models::Plugin::Config::Linux::Device>]
+
+          class Device < DockerEngine::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, DockerEngine::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
+        end
+
+        class Mount < DockerEngine::Internal::Type::BaseModel
+          # @!attribute description
+          #
+          #   @return [String]
+          required :description, String, api_name: :Description
+
+          # @!attribute destination
+          #
+          #   @return [String]
+          required :destination, String, api_name: :Destination
+
+          # @!attribute name
+          #
+          #   @return [String]
+          required :name, String, api_name: :Name
+
+          # @!attribute options
+          #
+          #   @return [Array<String>]
+          required :options, DockerEngine::Internal::Type::ArrayOf[String], api_name: :Options
+
+          # @!attribute settable
+          #
+          #   @return [Array<String>]
+          required :settable, DockerEngine::Internal::Type::ArrayOf[String], api_name: :Settable
+
+          # @!attribute source
+          #
+          #   @return [String]
+          required :source, String, api_name: :Source
+
+          # @!attribute type
+          #
+          #   @return [String]
+          required :type, String, api_name: :Type
+
+          # @!method initialize(description:, destination:, name:, options:, settable:, source:, type:)
+          #   @param description [String]
+          #   @param destination [String]
+          #   @param name [String]
+          #   @param options [Array<String>]
+          #   @param settable [Array<String>]
+          #   @param source [String]
+          #   @param type [String]
+        end
+
+        # @see DockerEngine::Models::Plugin::Config#network
+        class Network < DockerEngine::Internal::Type::BaseModel
+          # @!attribute type
+          #
+          #   @return [String]
+          required :type, String, api_name: :Type
+
+          # @!method initialize(type:)
+          #   @param type [String]
+        end
+
+        # @see DockerEngine::Models::Plugin::Config#rootfs
+        class Rootfs < DockerEngine::Internal::Type::BaseModel
+          # @!attribute diff_ids
+          #
+          #   @return [Array<String>, nil]
+          optional :diff_ids, DockerEngine::Internal::Type::ArrayOf[String]
+
+          # @!attribute type
+          #
+          #   @return [String, nil]
+          optional :type, String
+
+          # @!method initialize(diff_ids: nil, type: nil)
+          #   @param diff_ids [Array<String>]
+          #   @param type [String]
+        end
+
+        # @see DockerEngine::Models::Plugin::Config#user
+        class User < DockerEngine::Internal::Type::BaseModel
+          # @!attribute gid
+          #
+          #   @return [Integer, nil]
+          optional :gid, Integer, api_name: :GID
+
+          # @!attribute uid
+          #
+          #   @return [Integer, nil]
+          optional :uid, Integer, api_name: :UID
+
+          # @!method initialize(gid: nil, uid: nil)
+          #   @param gid [Integer]
+          #   @param uid [Integer]
+        end
+      end
+
+      # @see DockerEngine::Models::Plugin#settings
+      class Settings < DockerEngine::Internal::Type::BaseModel
+        # @!attribute args
+        #
+        #   @return [Array<String>]
+        required :args, DockerEngine::Internal::Type::ArrayOf[String], api_name: :Args
+
+        # @!attribute devices
+        #
+        #   @return [Array<DockerEngine::Models::Plugin::Settings::Device>]
+        required :devices,
+                 -> { DockerEngine::Internal::Type::ArrayOf[DockerEngine::Plugin::Settings::Device] },
+                 api_name: :Devices
+
+        # @!attribute env
+        #
+        #   @return [Array<String>]
+        required :env, DockerEngine::Internal::Type::ArrayOf[String], api_name: :Env
+
+        # @!attribute mounts
+        #
+        #   @return [Array<DockerEngine::Models::Plugin::Settings::Mount>]
+        required :mounts,
+                 -> { DockerEngine::Internal::Type::ArrayOf[DockerEngine::Plugin::Settings::Mount] },
+                 api_name: :Mounts
+
+        # @!method initialize(args:, devices:, env:, mounts:)
+        #   user-configurable settings for the plugin.
+        #
+        #   @param args [Array<String>]
+        #   @param devices [Array<DockerEngine::Models::Plugin::Settings::Device>]
+        #   @param env [Array<String>]
+        #   @param mounts [Array<DockerEngine::Models::Plugin::Settings::Mount>]
+
+        class Device < DockerEngine::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, DockerEngine::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
+
+        class Mount < DockerEngine::Internal::Type::BaseModel
+          # @!attribute description
+          #
+          #   @return [String]
+          required :description, String, api_name: :Description
+
+          # @!attribute destination
+          #
+          #   @return [String]
+          required :destination, String, api_name: :Destination
+
+          # @!attribute name
+          #
+          #   @return [String]
+          required :name, String, api_name: :Name
+
+          # @!attribute options
+          #
+          #   @return [Array<String>]
+          required :options, DockerEngine::Internal::Type::ArrayOf[String], api_name: :Options
+
+          # @!attribute settable
+          #
+          #   @return [Array<String>]
+          required :settable, DockerEngine::Internal::Type::ArrayOf[String], api_name: :Settable
+
+          # @!attribute source
+          #
+          #   @return [String]
+          required :source, String, api_name: :Source
+
+          # @!attribute type
+          #
+          #   @return [String]
+          required :type, String, api_name: :Type
+
+          # @!method initialize(description:, destination:, name:, options:, settable:, source:, type:)
+          #   @param description [String]
+          #   @param destination [String]
+          #   @param name [String]
+          #   @param options [Array<String>]
+          #   @param settable [Array<String>]
+          #   @param source [String]
+          #   @param type [String]
+        end
+      end
+    end
+  end
+end

data/lib/docker_engine/models/plugin_create_params.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Plugins#create
+    class PluginCreateParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute name
+      #   The name of the plugin. The `:latest` tag is optional, and is the default if
+      #   omitted.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute body
+      #
+      #   @return [Pathname, StringIO, IO, String, DockerEngine::FilePart]
+      required :body, DockerEngine::Internal::Type::FileInput
+
+      # @!method initialize(name:, body:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::PluginCreateParams} for more details.
+      #
+      #   @param name [String] The name of the plugin. The `:latest` tag is optional, and is the
+      #
+      #   @param body [Pathname, StringIO, IO, String, DockerEngine::FilePart]
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/plugin_delete_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Plugins#delete
+    class PluginDeleteParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute force
+      #   Disable the plugin before removing. This may result in issues if the plugin is
+      #   in use by a container.
+      #
+      #   @return [Boolean, nil]
+      optional :force, DockerEngine::Internal::Type::Boolean
+
+      # @!method initialize(force: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::PluginDeleteParams} for more details.
+      #
+      #   @param force [Boolean] Disable the plugin before removing. This may result in issues if the
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/plugin_disable_params.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Plugins#disable
+    class PluginDisableParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute force
+      #   Force disable a plugin even if still in use.
+      #
+      #   @return [Boolean, nil]
+      optional :force, DockerEngine::Internal::Type::Boolean
+
+      # @!method initialize(force: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::PluginDisableParams} for more details.
+      #
+      #   @param force [Boolean] Force disable a plugin even if still in use.
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/plugin_enable_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Plugins#enable
+    class PluginEnableParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute timeout
+      #   Set the HTTP client timeout (in seconds)
+      #
+      #   @return [Integer, nil]
+      optional :timeout, Integer
+
+      # @!method initialize(timeout: nil, request_options: {})
+      #   @param timeout [Integer] Set the HTTP client timeout (in seconds)
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/plugin_inspect_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Plugins#inspect_
+    class PluginInspectParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/plugin_list_params.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Plugins#list
+    class PluginListParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute filters
+      #   A JSON encoded value of the filters (a `map[string][]string`) to process on the
+      #   plugin list.
+      #
+      #   Available filters:
+      #
+      #   - `capability=<capability name>`
+      #   - `enable=<true>|<false>`
+      #
+      #   @return [String, nil]
+      optional :filters, String
+
+      # @!method initialize(filters: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::PluginListParams} for more details.
+      #
+      #   @param filters [String] A JSON encoded value of the filters (a `map[string][]string`) to
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/plugin_list_response.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @type [DockerEngine::Internal::Type::Converter]
+    PluginListResponse = DockerEngine::Internal::Type::ArrayOf[-> { DockerEngine::Plugin }]
+  end
+end