docker-engine 0.1.1

data/rbi/docker_engine/models/container_delete_params.rbi

@@ -0,0 +1,71 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class ContainerDeleteParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngine::ContainerDeleteParams,
+            DockerEngine::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: DockerEngine::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: DockerEngine::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine/models/container_inspect_params.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class ContainerInspectParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngine::ContainerInspectParams,
+            DockerEngine::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: DockerEngine::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: DockerEngine::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine/models/container_kill_params.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class ContainerKillParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngine::ContainerKillParams,
+            DockerEngine::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: DockerEngine::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: DockerEngine::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine/models/container_list_params.rbi

@@ -0,0 +1,124 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class ContainerListParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngine::ContainerListParams,
+            DockerEngine::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: DockerEngine::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: DockerEngine::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine/models/container_list_response.rbi

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

data/rbi/docker_engine/models/container_logs_params.rbi

@@ -0,0 +1,117 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class ContainerLogsParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngine::ContainerLogsParams,
+            DockerEngine::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: DockerEngine::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: DockerEngine::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine/models/container_start_params.rbi

@@ -0,0 +1,50 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class ContainerStartParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngine::ContainerStartParams,
+            DockerEngine::Internal::AnyHash
+          )
+        end
+
+      # 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
+
+      sig do
+        params(
+          detach_keys: String,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # 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,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { detach_keys: String, request_options: DockerEngine::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine/models/container_stop_params.rbi

@@ -0,0 +1,60 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class ContainerStopParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngine::ContainerStopParams,
+            DockerEngine::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
+
+      # Number of seconds to wait before killing the container
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :t
+
+      sig { params(t: Integer).void }
+      attr_writer :t
+
+      sig do
+        params(
+          signal: String,
+          t: Integer,
+          request_options: DockerEngine::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,
+        # Number of seconds to wait before killing the container
+        t: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            signal: String,
+            t: Integer,
+            request_options: DockerEngine::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end