docker-engine-api 0.2.1

data/rbi/docker_engine_api/models/container_delete_params.rbi

@@ -0,0 +1,71 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class ContainerDeleteParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::ContainerDeleteParams,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      # If the container is running, kill it before removing it.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :force
+
+      sig { params(force: T::Boolean).void }
+      attr_writer :force
+
+      # Remove the specified link associated with the container.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :link
+
+      sig { params(link: T::Boolean).void }
+      attr_writer :link
+
+      # Remove anonymous volumes associated with the container.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :v
+
+      sig { params(v: T::Boolean).void }
+      attr_writer :v
+
+      sig do
+        params(
+          force: T::Boolean,
+          link: T::Boolean,
+          v: T::Boolean,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # If the container is running, kill it before removing it.
+        force: nil,
+        # Remove the specified link associated with the container.
+        link: nil,
+        # Remove anonymous volumes associated with the container.
+        v: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            force: T::Boolean,
+            link: T::Boolean,
+            v: T::Boolean,
+            request_options: DockerEngineAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/models/container_exec_params.rbi

@@ -0,0 +1,162 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class ContainerExecParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::ContainerExecParams,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      # Attach to `stderr` of the exec command.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :attach_stderr
+
+      sig { params(attach_stderr: T::Boolean).void }
+      attr_writer :attach_stderr
+
+      # Attach to `stdin` of the exec command.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :attach_stdin
+
+      sig { params(attach_stdin: T::Boolean).void }
+      attr_writer :attach_stdin
+
+      # Attach to `stdout` of the exec command.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :attach_stdout
+
+      sig { params(attach_stdout: T::Boolean).void }
+      attr_writer :attach_stdout
+
+      # Command to run, as a string or array of strings.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :cmd
+
+      sig { params(cmd: T::Array[String]).void }
+      attr_writer :cmd
+
+      # Initial console size, as an `[height, width]` array.
+      sig { returns(T.nilable(T::Array[Integer])) }
+      attr_accessor :console_size
+
+      # 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 `_`.
+      sig { returns(T.nilable(String)) }
+      attr_reader :detach_keys
+
+      sig { params(detach_keys: String).void }
+      attr_writer :detach_keys
+
+      # A list of environment variables in the form `["VAR=value", ...]`.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :env
+
+      sig { params(env: T::Array[String]).void }
+      attr_writer :env
+
+      # Runs the exec process with extended privileges.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :privileged
+
+      sig { params(privileged: T::Boolean).void }
+      attr_writer :privileged
+
+      # Allocate a pseudo-TTY.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :tty
+
+      sig { params(tty: T::Boolean).void }
+      attr_writer :tty
+
+      # The user, and optionally, group to run the exec process inside the container.
+      # Format is one of: `user`, `user:group`, `uid`, or `uid:gid`.
+      sig { returns(T.nilable(String)) }
+      attr_reader :user
+
+      sig { params(user: String).void }
+      attr_writer :user
+
+      # The working directory for the exec process inside the container.
+      sig { returns(T.nilable(String)) }
+      attr_reader :working_dir
+
+      sig { params(working_dir: String).void }
+      attr_writer :working_dir
+
+      sig do
+        params(
+          attach_stderr: T::Boolean,
+          attach_stdin: T::Boolean,
+          attach_stdout: T::Boolean,
+          cmd: T::Array[String],
+          console_size: T.nilable(T::Array[Integer]),
+          detach_keys: String,
+          env: T::Array[String],
+          privileged: T::Boolean,
+          tty: T::Boolean,
+          user: String,
+          working_dir: String,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Attach to `stderr` of the exec command.
+        attach_stderr: nil,
+        # Attach to `stdin` of the exec command.
+        attach_stdin: nil,
+        # Attach to `stdout` of the exec command.
+        attach_stdout: nil,
+        # Command to run, as a string or array of strings.
+        cmd: nil,
+        # Initial console size, as an `[height, width]` array.
+        console_size: nil,
+        # 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 `_`.
+        detach_keys: nil,
+        # A list of environment variables in the form `["VAR=value", ...]`.
+        env: nil,
+        # Runs the exec process with extended privileges.
+        privileged: nil,
+        # Allocate a pseudo-TTY.
+        tty: nil,
+        # The user, and optionally, group to run the exec process inside the container.
+        # Format is one of: `user`, `user:group`, `uid`, or `uid:gid`.
+        user: nil,
+        # The working directory for the exec process inside the container.
+        working_dir: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            attach_stderr: T::Boolean,
+            attach_stdin: T::Boolean,
+            attach_stdout: T::Boolean,
+            cmd: T::Array[String],
+            console_size: T.nilable(T::Array[Integer]),
+            detach_keys: String,
+            env: T::Array[String],
+            privileged: T::Boolean,
+            tty: T::Boolean,
+            user: String,
+            working_dir: String,
+            request_options: DockerEngineAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/models/container_exec_response.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class ContainerExecResponse < DockerEngineAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::Models::ContainerExecResponse,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      # The id of the newly created object.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Response to an API call that returns just an Id
+      sig { params(id: String).returns(T.attached_class) }
+      def self.new(
+        # The id of the newly created object.
+        id:
+      )
+      end
+
+      sig { override.returns({ id: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/models/container_export_params.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class ContainerExportParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::ContainerExportParams,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(request_options: {})
+      end
+
+      sig do
+        override.returns({ request_options: DockerEngineAPI::RequestOptions })
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/models/container_inspect_params.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class ContainerInspectParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::ContainerInspectParams,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      # Return the size of container as fields `SizeRw` and `SizeRootFs`
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :size
+
+      sig { params(size: T::Boolean).void }
+      attr_writer :size
+
+      sig do
+        params(
+          size: T::Boolean,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Return the size of container as fields `SizeRw` and `SizeRootFs`
+        size: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { size: T::Boolean, request_options: DockerEngineAPI::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/models/container_kill_params.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class ContainerKillParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::ContainerKillParams,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      # Signal to send to the container as an integer or string (e.g. `SIGINT`).
+      sig { returns(T.nilable(String)) }
+      attr_reader :signal
+
+      sig { params(signal: String).void }
+      attr_writer :signal
+
+      sig do
+        params(
+          signal: String,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Signal to send to the container as an integer or string (e.g. `SIGINT`).
+        signal: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { signal: String, request_options: DockerEngineAPI::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/models/container_list_params.rbi

@@ -0,0 +1,124 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class ContainerListParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::ContainerListParams,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      # Return all containers. By default, only running containers are shown.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :all
+
+      sig { params(all: T::Boolean).void }
+      attr_writer :all
+
+      # Filters to process on the container list, encoded as JSON (a
+      # `map[string][]string`). For example, `{"status": ["paused"]}` will only return
+      # paused containers.
+      #
+      # Available filters:
+      #
+      # - `ancestor`=(`<image-name>[:<tag>]`, `<image id>`, or `<image@digest>`)
+      # - `before`=(`<container id>` or `<container name>`)
+      # - `expose`=(`<port>[/<proto>]`|`<startport-endport>/[<proto>]`)
+      # - `exited=<int>` containers with exit code of `<int>`
+      # - `health`=(`starting`|`healthy`|`unhealthy`|`none`)
+      # - `id=<ID>` a container's ID
+      # - `isolation=`(`default`|`process`|`hyperv`) (Windows daemon only)
+      # - `is-task=`(`true`|`false`)
+      # - `label=key` or `label="key=value"` of a container label
+      # - `name=<name>` a container's name
+      # - `network`=(`<network id>` or `<network name>`)
+      # - `publish`=(`<port>[/<proto>]`|`<startport-endport>/[<proto>]`)
+      # - `since`=(`<container id>` or `<container name>`)
+      # - `status=`(`created`|`restarting`|`running`|`removing`|`paused`|`exited`|`dead`)
+      # - `volume`=(`<volume name>` or `<mount point destination>`)
+      sig { returns(T.nilable(String)) }
+      attr_reader :filters
+
+      sig { params(filters: String).void }
+      attr_writer :filters
+
+      # Return this number of most recently created containers, including non-running
+      # ones.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      # Return the size of container as fields `SizeRw` and `SizeRootFs`.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :size
+
+      sig { params(size: T::Boolean).void }
+      attr_writer :size
+
+      sig do
+        params(
+          all: T::Boolean,
+          filters: String,
+          limit: Integer,
+          size: T::Boolean,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Return all containers. By default, only running containers are shown.
+        all: nil,
+        # Filters to process on the container list, encoded as JSON (a
+        # `map[string][]string`). For example, `{"status": ["paused"]}` will only return
+        # paused containers.
+        #
+        # Available filters:
+        #
+        # - `ancestor`=(`<image-name>[:<tag>]`, `<image id>`, or `<image@digest>`)
+        # - `before`=(`<container id>` or `<container name>`)
+        # - `expose`=(`<port>[/<proto>]`|`<startport-endport>/[<proto>]`)
+        # - `exited=<int>` containers with exit code of `<int>`
+        # - `health`=(`starting`|`healthy`|`unhealthy`|`none`)
+        # - `id=<ID>` a container's ID
+        # - `isolation=`(`default`|`process`|`hyperv`) (Windows daemon only)
+        # - `is-task=`(`true`|`false`)
+        # - `label=key` or `label="key=value"` of a container label
+        # - `name=<name>` a container's name
+        # - `network`=(`<network id>` or `<network name>`)
+        # - `publish`=(`<port>[/<proto>]`|`<startport-endport>/[<proto>]`)
+        # - `since`=(`<container id>` or `<container name>`)
+        # - `status=`(`created`|`restarting`|`running`|`removing`|`paused`|`exited`|`dead`)
+        # - `volume`=(`<volume name>` or `<mount point destination>`)
+        filters: nil,
+        # Return this number of most recently created containers, including non-running
+        # ones.
+        limit: nil,
+        # Return the size of container as fields `SizeRw` and `SizeRootFs`.
+        size: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            all: T::Boolean,
+            filters: String,
+            limit: Integer,
+            size: T::Boolean,
+            request_options: DockerEngineAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/models/container_list_response.rbi

@@ -0,0 +1,11 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    ContainerListResponse =
+      T.let(
+        DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Summary],
+        DockerEngineAPI::Internal::Type::Converter
+      )
+  end
+end

data/rbi/docker_engine_api/models/container_logs_params.rbi

@@ -0,0 +1,117 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class ContainerLogsParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::ContainerLogsParams,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      # Keep connection after returning logs.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :follow
+
+      sig { params(follow: T::Boolean).void }
+      attr_writer :follow
+
+      # Only return logs since this time, as a UNIX timestamp
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :since
+
+      sig { params(since: Integer).void }
+      attr_writer :since
+
+      # Return logs from `stderr`
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :stderr
+
+      sig { params(stderr: T::Boolean).void }
+      attr_writer :stderr
+
+      # Return logs from `stdout`
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :stdout
+
+      sig { params(stdout: T::Boolean).void }
+      attr_writer :stdout
+
+      # Only return this number of log lines from the end of the logs. Specify as an
+      # integer or `all` to output all log lines.
+      sig { returns(T.nilable(String)) }
+      attr_reader :tail
+
+      sig { params(tail: String).void }
+      attr_writer :tail
+
+      # Add timestamps to every log line
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :timestamps
+
+      sig { params(timestamps: T::Boolean).void }
+      attr_writer :timestamps
+
+      # Only return logs before this time, as a UNIX timestamp
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :until_
+
+      sig { params(until_: Integer).void }
+      attr_writer :until_
+
+      sig do
+        params(
+          follow: T::Boolean,
+          since: Integer,
+          stderr: T::Boolean,
+          stdout: T::Boolean,
+          tail: String,
+          timestamps: T::Boolean,
+          until_: Integer,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Keep connection after returning logs.
+        follow: nil,
+        # Only return logs since this time, as a UNIX timestamp
+        since: nil,
+        # Return logs from `stderr`
+        stderr: nil,
+        # Return logs from `stdout`
+        stdout: nil,
+        # Only return this number of log lines from the end of the logs. Specify as an
+        # integer or `all` to output all log lines.
+        tail: nil,
+        # Add timestamps to every log line
+        timestamps: nil,
+        # Only return logs before this time, as a UNIX timestamp
+        until_: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            follow: T::Boolean,
+            since: Integer,
+            stderr: T::Boolean,
+            stdout: T::Boolean,
+            tail: String,
+            timestamps: T::Boolean,
+            until_: Integer,
+            request_options: DockerEngineAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/models/container_pause_params.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class ContainerPauseParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::ContainerPauseParams,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(request_options: {})
+      end
+
+      sig do
+        override.returns({ request_options: DockerEngineAPI::RequestOptions })
+      end
+      def to_hash
+      end
+    end
+  end
+end