docker-engine 0.1.1 → 0.2.0

data/lib/docker_engine/models/container_exec_params.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Containers#exec_
+    class ContainerExecParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute attach_stderr
+      #   Attach to `stderr` of the exec command.
+      #
+      #   @return [Boolean, nil]
+      optional :attach_stderr, DockerEngine::Internal::Type::Boolean, api_name: :AttachStderr
+
+      # @!attribute attach_stdin
+      #   Attach to `stdin` of the exec command.
+      #
+      #   @return [Boolean, nil]
+      optional :attach_stdin, DockerEngine::Internal::Type::Boolean, api_name: :AttachStdin
+
+      # @!attribute attach_stdout
+      #   Attach to `stdout` of the exec command.
+      #
+      #   @return [Boolean, nil]
+      optional :attach_stdout, DockerEngine::Internal::Type::Boolean, api_name: :AttachStdout
+
+      # @!attribute cmd
+      #   Command to run, as a string or array of strings.
+      #
+      #   @return [Array<String>, nil]
+      optional :cmd, DockerEngine::Internal::Type::ArrayOf[String], api_name: :Cmd
+
+      # @!attribute console_size
+      #   Initial console size, as an `[height, width]` array.
+      #
+      #   @return [Array<Integer>, nil]
+      optional :console_size,
+               DockerEngine::Internal::Type::ArrayOf[Integer],
+               api_name: :ConsoleSize,
+               nil?: true
+
+      # @!attribute detach_keys
+      #   Override the key sequence for detaching a container. Format is a single
+      #   character `[a-Z]` or `ctrl-<value>` where `<value>` is one of: `a-z`, `@`, `^`,
+      #   `[`, `,` or `_`.
+      #
+      #   @return [String, nil]
+      optional :detach_keys, String, api_name: :DetachKeys
+
+      # @!attribute env
+      #   A list of environment variables in the form `["VAR=value", ...]`.
+      #
+      #   @return [Array<String>, nil]
+      optional :env, DockerEngine::Internal::Type::ArrayOf[String], api_name: :Env
+
+      # @!attribute privileged
+      #   Runs the exec process with extended privileges.
+      #
+      #   @return [Boolean, nil]
+      optional :privileged, DockerEngine::Internal::Type::Boolean, api_name: :Privileged
+
+      # @!attribute tty
+      #   Allocate a pseudo-TTY.
+      #
+      #   @return [Boolean, nil]
+      optional :tty, DockerEngine::Internal::Type::Boolean, api_name: :Tty
+
+      # @!attribute user
+      #   The user, and optionally, group to run the exec process inside the container.
+      #   Format is one of: `user`, `user:group`, `uid`, or `uid:gid`.
+      #
+      #   @return [String, nil]
+      optional :user, String, api_name: :User
+
+      # @!attribute working_dir
+      #   The working directory for the exec process inside the container.
+      #
+      #   @return [String, nil]
+      optional :working_dir, String, api_name: :WorkingDir
+
+      # @!method initialize(attach_stderr: nil, attach_stdin: nil, attach_stdout: nil, cmd: nil, console_size: nil, detach_keys: nil, env: nil, privileged: nil, tty: nil, user: nil, working_dir: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::ContainerExecParams} for more details.
+      #
+      #   @param attach_stderr [Boolean] Attach to `stderr` of the exec command.
+      #
+      #   @param attach_stdin [Boolean] Attach to `stdin` of the exec command.
+      #
+      #   @param attach_stdout [Boolean] Attach to `stdout` of the exec command.
+      #
+      #   @param cmd [Array<String>] Command to run, as a string or array of strings.
+      #
+      #   @param console_size [Array<Integer>, nil] Initial console size, as an `[height, width]` array.
+      #
+      #   @param detach_keys [String] Override the key sequence for detaching a container. Format is
+      #
+      #   @param env [Array<String>] A list of environment variables in the form `["VAR=value", ...]`.
+      #
+      #   @param privileged [Boolean] Runs the exec process with extended privileges.
+      #
+      #   @param tty [Boolean] Allocate a pseudo-TTY.
+      #
+      #   @param user [String] The user, and optionally, group to run the exec process inside
+      #
+      #   @param working_dir [String] The working directory for the exec process inside the container.
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/container_exec_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Containers#exec_
+    class ContainerExecResponse < DockerEngine::Internal::Type::BaseModel
+      # @!attribute id
+      #   The id of the newly created object.
+      #
+      #   @return [String]
+      required :id, String, api_name: :Id
+
+      # @!method initialize(id:)
+      #   Response to an API call that returns just an Id
+      #
+      #   @param id [String] The id of the newly created object.
+    end
+  end
+end

data/lib/docker_engine/models/container_export_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Containers#export
+    class ContainerExportParams < 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/container_pause_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Containers#pause
+    class ContainerPauseParams < 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/container_prune_params.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Containers#prune
+    class ContainerPruneParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute filters
+      #   Filters to process on the prune list, encoded as JSON (a `map[string][]string`).
+      #
+      #   Available filters:
+      #
+      #   - `until=<timestamp>` Prune containers created before this timestamp. The
+      #     `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go
+      #     duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon
+      #     machine’s time.
+      #   - `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or
+      #     `label!=<key>=<value>`) Prune containers with (or without, in case
+      #     `label!=...` is used) the specified labels.
+      #
+      #   @return [String, nil]
+      optional :filters, String
+
+      # @!method initialize(filters: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::ContainerPruneParams} for more details.
+      #
+      #   @param filters [String] Filters to process on the prune list, encoded as JSON (a `map[string][]string`).
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/container_prune_response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Containers#prune
+    class ContainerPruneResponse < DockerEngine::Internal::Type::BaseModel
+      # @!attribute containers_deleted
+      #   Container IDs that were deleted
+      #
+      #   @return [Array<String>, nil]
+      optional :containers_deleted,
+               DockerEngine::Internal::Type::ArrayOf[String],
+               api_name: :ContainersDeleted
+
+      # @!attribute space_reclaimed
+      #   Disk space reclaimed in bytes
+      #
+      #   @return [Integer, nil]
+      optional :space_reclaimed, Integer, api_name: :SpaceReclaimed
+
+      # @!method initialize(containers_deleted: nil, space_reclaimed: nil)
+      #   @param containers_deleted [Array<String>] Container IDs that were deleted
+      #
+      #   @param space_reclaimed [Integer] Disk space reclaimed in bytes
+    end
+  end
+end

data/lib/docker_engine/models/container_rename_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Containers#rename
+    class ContainerRenameParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute name
+      #   New name for the container
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!method initialize(name:, request_options: {})
+      #   @param name [String] New name for the container
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/container_resize_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Containers#resize
+    class ContainerResizeParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute h
+      #   Height of the TTY session in characters
+      #
+      #   @return [Integer]
+      required :h, Integer
+
+      # @!attribute w
+      #   Width of the TTY session in characters
+      #
+      #   @return [Integer]
+      required :w, Integer
+
+      # @!method initialize(h:, w:, request_options: {})
+      #   @param h [Integer] Height of the TTY session in characters
+      #
+      #   @param w [Integer] Width of the TTY session in characters
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/container_restart_params.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Containers#restart
+    class ContainerRestartParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute signal
+      #   Signal to send to the container as an integer or string (e.g. `SIGINT`).
+      #
+      #   @return [String, nil]
+      optional :signal, String
+
+      # @!attribute t
+      #   Number of seconds to wait before killing the container
+      #
+      #   @return [Integer, nil]
+      optional :t, Integer
+
+      # @!method initialize(signal: nil, t: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::ContainerRestartParams} for more details.
+      #
+      #   @param signal [String] Signal to send to the container as an integer or string (e.g. `SIGINT`).
+      #
+      #   @param t [Integer] Number of seconds to wait before killing the container
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/container_stats_params.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Containers#stats
+    class ContainerStatsParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute one_shot
+      #   Only get a single stat instead of waiting for 2 cycles. Must be used with
+      #   `stream=false`.
+      #
+      #   @return [Boolean, nil]
+      optional :one_shot, DockerEngine::Internal::Type::Boolean
+
+      # @!attribute stream
+      #   Stream the output. If false, the stats will be output once and then it will
+      #   disconnect.
+      #
+      #   @return [Boolean, nil]
+      optional :stream, DockerEngine::Internal::Type::Boolean
+
+      # @!method initialize(one_shot: nil, stream: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::ContainerStatsParams} for more details.
+      #
+      #   @param one_shot [Boolean] Only get a single stat instead of waiting for 2 cycles. Must be used
+      #
+      #   @param stream [Boolean] Stream the output. If false, the stats will be output once and then
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/container_top_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Containers#top
+    class ContainerTopParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute ps_args
+      #   The arguments to pass to `ps`. For example, `aux`
+      #
+      #   @return [String, nil]
+      optional :ps_args, String
+
+      # @!method initialize(ps_args: nil, request_options: {})
+      #   @param ps_args [String] The arguments to pass to `ps`. For example, `aux`
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/container_unpause_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Containers#unpause
+    class ContainerUnpauseParams < 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