docker-engine-api 0.2.1

data/rbi/docker_engine_api/models/create_response.rbi

@@ -0,0 +1,39 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class CreateResponse < DockerEngineAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::CreateResponse,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      # The ID of the created container
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Warnings encountered when creating the container
+      sig { returns(T::Array[String]) }
+      attr_accessor :warnings
+
+      # OK response to ContainerCreate operation
+      sig do
+        params(id: String, warnings: T::Array[String]).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the created container
+        id:,
+        # Warnings encountered when creating the container
+        warnings:
+      )
+      end
+
+      sig { override.returns({ id: String, warnings: T::Array[String] }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/models/delete_item.rbi

@@ -0,0 +1,41 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class DeleteItem < DockerEngineAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(DockerEngineAPI::DeleteItem, DockerEngineAPI::Internal::AnyHash)
+        end
+
+      # The image ID of an image that was deleted
+      sig { returns(T.nilable(String)) }
+      attr_reader :deleted
+
+      sig { params(deleted: String).void }
+      attr_writer :deleted
+
+      # The image ID of an image that was untagged
+      sig { returns(T.nilable(String)) }
+      attr_reader :untagged
+
+      sig { params(untagged: String).void }
+      attr_writer :untagged
+
+      sig do
+        params(deleted: String, untagged: String).returns(T.attached_class)
+      end
+      def self.new(
+        # The image ID of an image that was deleted
+        deleted: nil,
+        # The image ID of an image that was untagged
+        untagged: nil
+      )
+      end
+
+      sig { override.returns({ deleted: String, untagged: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/models/disconnect_request.rbi

@@ -0,0 +1,43 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class DisconnectRequest < DockerEngineAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::DisconnectRequest,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      # The ID or name of the container to disconnect from the network.
+      sig { returns(String) }
+      attr_accessor :container
+
+      # Force the container to disconnect from the network.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :force
+
+      sig { params(force: T::Boolean).void }
+      attr_writer :force
+
+      # NetworkDisconnectRequest represents the data to be used to disconnect a
+      # container from a network.
+      sig do
+        params(container: String, force: T::Boolean).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID or name of the container to disconnect from the network.
+        container:,
+        # Force the container to disconnect from the network.
+        force: nil
+      )
+      end
+
+      sig { override.returns({ container: String, force: T::Boolean }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/models/distribution_inspect_params.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class DistributionInspectParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::DistributionInspectParams,
+            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/error.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class Error < DockerEngineAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(DockerEngineAPI::Error, DockerEngineAPI::Internal::AnyHash)
+        end
+
+      # The error message.
+      sig { returns(String) }
+      attr_accessor :message
+
+      # Represents an error.
+      sig { params(message: String).returns(T.attached_class) }
+      def self.new(
+        # The error message.
+        message:
+      )
+      end
+
+      sig { override.returns({ message: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/models/exec_inspect_params.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class ExecInspectParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::ExecInspectParams,
+            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/exec_inspect_response.rbi

@@ -0,0 +1,135 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class ExecInspectResponse < DockerEngineAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::Models::ExecInspectResponse,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :can_remove
+
+      sig { params(can_remove: T::Boolean).void }
+      attr_writer :can_remove
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :container_id
+
+      sig { params(container_id: String).void }
+      attr_writer :container_id
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :detach_keys
+
+      sig { params(detach_keys: String).void }
+      attr_writer :detach_keys
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :exit_code
+
+      sig { params(exit_code: Integer).void }
+      attr_writer :exit_code
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :open_stderr
+
+      sig { params(open_stderr: T::Boolean).void }
+      attr_writer :open_stderr
+
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :open_stdin
+
+      sig { params(open_stdin: T::Boolean).void }
+      attr_writer :open_stdin
+
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :open_stdout
+
+      sig { params(open_stdout: T::Boolean).void }
+      attr_writer :open_stdout
+
+      # The system process ID for the exec process.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :pid
+
+      sig { params(pid: Integer).void }
+      attr_writer :pid
+
+      sig { returns(T.nilable(DockerEngineAPI::InspectResponse)) }
+      attr_reader :process_config
+
+      sig do
+        params(process_config: DockerEngineAPI::InspectResponse::OrHash).void
+      end
+      attr_writer :process_config
+
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :running
+
+      sig { params(running: T::Boolean).void }
+      attr_writer :running
+
+      sig do
+        params(
+          can_remove: T::Boolean,
+          container_id: String,
+          detach_keys: String,
+          exit_code: Integer,
+          id: String,
+          open_stderr: T::Boolean,
+          open_stdin: T::Boolean,
+          open_stdout: T::Boolean,
+          pid: Integer,
+          process_config: DockerEngineAPI::InspectResponse::OrHash,
+          running: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        can_remove: nil,
+        container_id: nil,
+        detach_keys: nil,
+        exit_code: nil,
+        id: nil,
+        open_stderr: nil,
+        open_stdin: nil,
+        open_stdout: nil,
+        # The system process ID for the exec process.
+        pid: nil,
+        process_config: nil,
+        running: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            can_remove: T::Boolean,
+            container_id: String,
+            detach_keys: String,
+            exit_code: Integer,
+            id: String,
+            open_stderr: T::Boolean,
+            open_stdin: T::Boolean,
+            open_stdout: T::Boolean,
+            pid: Integer,
+            process_config: DockerEngineAPI::InspectResponse,
+            running: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/models/exec_resize_params.rbi

@@ -0,0 +1,54 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class ExecResizeParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::ExecResizeParams,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      # Height of the TTY session in characters
+      sig { returns(Integer) }
+      attr_accessor :h
+
+      # Width of the TTY session in characters
+      sig { returns(Integer) }
+      attr_accessor :w
+
+      sig do
+        params(
+          h: Integer,
+          w: Integer,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Height of the TTY session in characters
+        h:,
+        # Width of the TTY session in characters
+        w:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            h: Integer,
+            w: Integer,
+            request_options: DockerEngineAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/models/exec_start_params.rbi

@@ -0,0 +1,68 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class ExecStartParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::ExecStartParams,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      # Initial console size, as an `[height, width]` array.
+      sig { returns(T.nilable(T::Array[Integer])) }
+      attr_accessor :console_size
+
+      # Detach from the command.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :detach
+
+      sig { params(detach: T::Boolean).void }
+      attr_writer :detach
+
+      # Allocate a pseudo-TTY.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :tty
+
+      sig { params(tty: T::Boolean).void }
+      attr_writer :tty
+
+      sig do
+        params(
+          console_size: T.nilable(T::Array[Integer]),
+          detach: T::Boolean,
+          tty: T::Boolean,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Initial console size, as an `[height, width]` array.
+        console_size: nil,
+        # Detach from the command.
+        detach: nil,
+        # Allocate a pseudo-TTY.
+        tty: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            console_size: T.nilable(T::Array[Integer]),
+            detach: T::Boolean,
+            tty: T::Boolean,
+            request_options: DockerEngineAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/models/filesystem_change.rbi

@@ -0,0 +1,93 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class FilesystemChange < DockerEngineAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::FilesystemChange,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      # Kind of change
+      #
+      # Can be one of:
+      #
+      # - `0`: Modified ("C")
+      # - `1`: Added ("A")
+      # - `2`: Deleted ("D")
+      sig { returns(DockerEngineAPI::FilesystemChange::Kind::TaggedInteger) }
+      attr_accessor :kind
+
+      # Path to file or directory that has changed.
+      sig { returns(String) }
+      attr_accessor :path
+
+      # Change in the container's filesystem.
+      sig do
+        params(
+          kind: DockerEngineAPI::FilesystemChange::Kind::OrInteger,
+          path: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Kind of change
+        #
+        # Can be one of:
+        #
+        # - `0`: Modified ("C")
+        # - `1`: Added ("A")
+        # - `2`: Deleted ("D")
+        kind:,
+        # Path to file or directory that has changed.
+        path:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            kind: DockerEngineAPI::FilesystemChange::Kind::TaggedInteger,
+            path: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Kind of change
+      #
+      # Can be one of:
+      #
+      # - `0`: Modified ("C")
+      # - `1`: Added ("A")
+      # - `2`: Deleted ("D")
+      module Kind
+        extend DockerEngineAPI::Internal::Type::Enum
+
+        TaggedInteger =
+          T.type_alias do
+            T.all(Integer, DockerEngineAPI::FilesystemChange::Kind)
+          end
+        OrInteger = T.type_alias { Integer }
+
+        KIND_0 =
+          T.let(0, DockerEngineAPI::FilesystemChange::Kind::TaggedInteger)
+        KIND_1 =
+          T.let(1, DockerEngineAPI::FilesystemChange::Kind::TaggedInteger)
+        KIND_2 =
+          T.let(2, DockerEngineAPI::FilesystemChange::Kind::TaggedInteger)
+
+        sig do
+          override.returns(
+            T::Array[DockerEngineAPI::FilesystemChange::Kind::TaggedInteger]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/models/history_item.rbi

@@ -0,0 +1,62 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class HistoryItem < DockerEngineAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::HistoryItem,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :comment
+
+      sig { returns(Integer) }
+      attr_accessor :created
+
+      sig { returns(String) }
+      attr_accessor :created_by
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(Integer) }
+      attr_accessor :size
+
+      sig { returns(T::Array[String]) }
+      attr_accessor :tags
+
+      # individual image layer information in response to ImageHistory operation
+      sig do
+        params(
+          comment: String,
+          created: Integer,
+          created_by: String,
+          id: String,
+          size: Integer,
+          tags: T::Array[String]
+        ).returns(T.attached_class)
+      end
+      def self.new(comment:, created:, created_by:, id:, size:, tags:)
+      end
+
+      sig do
+        override.returns(
+          {
+            comment: String,
+            created: Integer,
+            created_by: String,
+            id: String,
+            size: Integer,
+            tags: T::Array[String]
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end