docker-engine-api 0.2.1

data/sig/docker_engine_api/models/create_request.rbs

@@ -0,0 +1,255 @@
+module DockerEngineAPI
+  module Models
+    type create_request =
+      {
+        cluster_volume_spec: DockerEngineAPI::CreateRequest::ClusterVolumeSpec,
+        driver: String,
+        driver_opts: ::Hash[Symbol, String],
+        labels: ::Hash[Symbol, String],
+        name: String
+      }
+
+    class CreateRequest < DockerEngineAPI::Internal::Type::BaseModel
+      attr_reader cluster_volume_spec: DockerEngineAPI::CreateRequest::ClusterVolumeSpec?
+
+      def cluster_volume_spec=: (
+        DockerEngineAPI::CreateRequest::ClusterVolumeSpec
+      ) -> DockerEngineAPI::CreateRequest::ClusterVolumeSpec
+
+      attr_reader driver: String?
+
+      def driver=: (String) -> String
+
+      attr_reader driver_opts: ::Hash[Symbol, String]?
+
+      def driver_opts=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
+
+      attr_reader labels: ::Hash[Symbol, String]?
+
+      def labels=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
+
+      attr_reader name: String?
+
+      def name=: (String) -> String
+
+      def initialize: (
+        ?cluster_volume_spec: DockerEngineAPI::CreateRequest::ClusterVolumeSpec,
+        ?driver: String,
+        ?driver_opts: ::Hash[Symbol, String],
+        ?labels: ::Hash[Symbol, String],
+        ?name: String
+      ) -> void
+
+      def to_hash: -> {
+        cluster_volume_spec: DockerEngineAPI::CreateRequest::ClusterVolumeSpec,
+        driver: String,
+        driver_opts: ::Hash[Symbol, String],
+        labels: ::Hash[Symbol, String],
+        name: String
+      }
+
+      type cluster_volume_spec =
+        {
+          access_mode: DockerEngineAPI::CreateRequest::ClusterVolumeSpec::AccessMode,
+          group: String
+        }
+
+      class ClusterVolumeSpec < DockerEngineAPI::Internal::Type::BaseModel
+        attr_reader access_mode: DockerEngineAPI::CreateRequest::ClusterVolumeSpec::AccessMode?
+
+        def access_mode=: (
+          DockerEngineAPI::CreateRequest::ClusterVolumeSpec::AccessMode
+        ) -> DockerEngineAPI::CreateRequest::ClusterVolumeSpec::AccessMode
+
+        attr_reader group: String?
+
+        def group=: (String) -> String
+
+        def initialize: (
+          ?access_mode: DockerEngineAPI::CreateRequest::ClusterVolumeSpec::AccessMode,
+          ?group: String
+        ) -> void
+
+        def to_hash: -> {
+          access_mode: DockerEngineAPI::CreateRequest::ClusterVolumeSpec::AccessMode,
+          group: String
+        }
+
+        type access_mode =
+          {
+            accessibility_requirements: DockerEngineAPI::CreateRequest::ClusterVolumeSpec::AccessMode::AccessibilityRequirements,
+            availability: DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::availability,
+            capacity_range: DockerEngineAPI::CreateRequest::ClusterVolumeSpec::AccessMode::CapacityRange,
+            mount_volume: top,
+            scope: DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::scope,
+            secrets: ::Array[DockerEngineAPI::CreateRequest::ClusterVolumeSpec::AccessMode::Secret],
+            sharing: DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::sharing
+          }
+
+        class AccessMode < DockerEngineAPI::Internal::Type::BaseModel
+          attr_reader accessibility_requirements: DockerEngineAPI::CreateRequest::ClusterVolumeSpec::AccessMode::AccessibilityRequirements?
+
+          def accessibility_requirements=: (
+            DockerEngineAPI::CreateRequest::ClusterVolumeSpec::AccessMode::AccessibilityRequirements
+          ) -> DockerEngineAPI::CreateRequest::ClusterVolumeSpec::AccessMode::AccessibilityRequirements
+
+          attr_reader availability: DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::availability?
+
+          def availability=: (
+            DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::availability
+          ) -> DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::availability
+
+          attr_reader capacity_range: DockerEngineAPI::CreateRequest::ClusterVolumeSpec::AccessMode::CapacityRange?
+
+          def capacity_range=: (
+            DockerEngineAPI::CreateRequest::ClusterVolumeSpec::AccessMode::CapacityRange
+          ) -> DockerEngineAPI::CreateRequest::ClusterVolumeSpec::AccessMode::CapacityRange
+
+          attr_reader mount_volume: top?
+
+          def mount_volume=: (top) -> top
+
+          attr_reader scope: DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::scope?
+
+          def scope=: (
+            DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::scope
+          ) -> DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::scope
+
+          attr_reader secrets: ::Array[DockerEngineAPI::CreateRequest::ClusterVolumeSpec::AccessMode::Secret]?
+
+          def secrets=: (
+            ::Array[DockerEngineAPI::CreateRequest::ClusterVolumeSpec::AccessMode::Secret]
+          ) -> ::Array[DockerEngineAPI::CreateRequest::ClusterVolumeSpec::AccessMode::Secret]
+
+          attr_reader sharing: DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::sharing?
+
+          def sharing=: (
+            DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::sharing
+          ) -> DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::sharing
+
+          def initialize: (
+            ?accessibility_requirements: DockerEngineAPI::CreateRequest::ClusterVolumeSpec::AccessMode::AccessibilityRequirements,
+            ?availability: DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::availability,
+            ?capacity_range: DockerEngineAPI::CreateRequest::ClusterVolumeSpec::AccessMode::CapacityRange,
+            ?mount_volume: top,
+            ?scope: DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::scope,
+            ?secrets: ::Array[DockerEngineAPI::CreateRequest::ClusterVolumeSpec::AccessMode::Secret],
+            ?sharing: DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::sharing
+          ) -> void
+
+          def to_hash: -> {
+            accessibility_requirements: DockerEngineAPI::CreateRequest::ClusterVolumeSpec::AccessMode::AccessibilityRequirements,
+            availability: DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::availability,
+            capacity_range: DockerEngineAPI::CreateRequest::ClusterVolumeSpec::AccessMode::CapacityRange,
+            mount_volume: top,
+            scope: DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::scope,
+            secrets: ::Array[DockerEngineAPI::CreateRequest::ClusterVolumeSpec::AccessMode::Secret],
+            sharing: DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::sharing
+          }
+
+          type accessibility_requirements =
+            {
+              preferred: ::Array[::Hash[Symbol, String]],
+              requisite: ::Array[::Hash[Symbol, String]]
+            }
+
+          class AccessibilityRequirements < DockerEngineAPI::Internal::Type::BaseModel
+            attr_reader preferred: ::Array[::Hash[Symbol, String]]?
+
+            def preferred=: (
+              ::Array[::Hash[Symbol, String]]
+            ) -> ::Array[::Hash[Symbol, String]]
+
+            attr_reader requisite: ::Array[::Hash[Symbol, String]]?
+
+            def requisite=: (
+              ::Array[::Hash[Symbol, String]]
+            ) -> ::Array[::Hash[Symbol, String]]
+
+            def initialize: (
+              ?preferred: ::Array[::Hash[Symbol, String]],
+              ?requisite: ::Array[::Hash[Symbol, String]]
+            ) -> void
+
+            def to_hash: -> {
+              preferred: ::Array[::Hash[Symbol, String]],
+              requisite: ::Array[::Hash[Symbol, String]]
+            }
+          end
+
+          type availability = :active | :pause | :drain
+
+          module Availability
+            extend DockerEngineAPI::Internal::Type::Enum
+
+            ACTIVE: :active
+            PAUSE: :pause
+            DRAIN: :drain
+
+            def self?.values: -> ::Array[DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::availability]
+          end
+
+          type capacity_range =
+            { limit_bytes: Integer, required_bytes: Integer }
+
+          class CapacityRange < DockerEngineAPI::Internal::Type::BaseModel
+            attr_reader limit_bytes: Integer?
+
+            def limit_bytes=: (Integer) -> Integer
+
+            attr_reader required_bytes: Integer?
+
+            def required_bytes=: (Integer) -> Integer
+
+            def initialize: (
+              ?limit_bytes: Integer,
+              ?required_bytes: Integer
+            ) -> void
+
+            def to_hash: -> { limit_bytes: Integer, required_bytes: Integer }
+          end
+
+          type scope = :single | :multi
+
+          module Scope
+            extend DockerEngineAPI::Internal::Type::Enum
+
+            SINGLE: :single
+            MULTI: :multi
+
+            def self?.values: -> ::Array[DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::scope]
+          end
+
+          type secret = { key: String, secret: String }
+
+          class Secret < DockerEngineAPI::Internal::Type::BaseModel
+            attr_reader key: String?
+
+            def key=: (String) -> String
+
+            attr_reader secret: String?
+
+            def secret=: (String) -> String
+
+            def initialize: (?key: String, ?secret: String) -> void
+
+            def to_hash: -> { key: String, secret: String }
+          end
+
+          type sharing = :none | :readonly | :onewriter | :all
+
+          module Sharing
+            extend DockerEngineAPI::Internal::Type::Enum
+
+            NONE: :none
+            READONLY: :readonly
+            ONEWRITER: :onewriter
+            ALL: :all
+
+            def self?.values: -> ::Array[DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::sharing]
+          end
+        end
+      end
+    end
+  end
+end

data/sig/docker_engine_api/models/create_response.rbs

@@ -0,0 +1,15 @@
+module DockerEngineAPI
+  module Models
+    type create_response = { id: String, warnings: ::Array[String] }
+
+    class CreateResponse < DockerEngineAPI::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor warnings: ::Array[String]
+
+      def initialize: (id: String, warnings: ::Array[String]) -> void
+
+      def to_hash: -> { id: String, warnings: ::Array[String] }
+    end
+  end
+end

data/sig/docker_engine_api/models/delete_item.rbs

@@ -0,0 +1,19 @@
+module DockerEngineAPI
+  module Models
+    type delete_item = { deleted: String, untagged: String }
+
+    class DeleteItem < DockerEngineAPI::Internal::Type::BaseModel
+      attr_reader deleted: String?
+
+      def deleted=: (String) -> String
+
+      attr_reader untagged: String?
+
+      def untagged=: (String) -> String
+
+      def initialize: (?deleted: String, ?untagged: String) -> void
+
+      def to_hash: -> { deleted: String, untagged: String }
+    end
+  end
+end

data/sig/docker_engine_api/models/disconnect_request.rbs

@@ -0,0 +1,17 @@
+module DockerEngineAPI
+  module Models
+    type disconnect_request = { container: String, force: bool }
+
+    class DisconnectRequest < DockerEngineAPI::Internal::Type::BaseModel
+      attr_accessor container: String
+
+      attr_reader force: bool?
+
+      def force=: (bool) -> bool
+
+      def initialize: (container: String, ?force: bool) -> void
+
+      def to_hash: -> { container: String, force: bool }
+    end
+  end
+end

data/sig/docker_engine_api/models/distribution_inspect_params.rbs

@@ -0,0 +1,15 @@
+module DockerEngineAPI
+  module Models
+    type distribution_inspect_params =
+      {  } & DockerEngineAPI::Internal::Type::request_parameters
+
+    class DistributionInspectParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: DockerEngineAPI::request_opts) -> void
+
+      def to_hash: -> { request_options: DockerEngineAPI::RequestOptions }
+    end
+  end
+end

data/sig/docker_engine_api/models/error.rbs

@@ -0,0 +1,13 @@
+module DockerEngineAPI
+  module Models
+    type error = { message: String }
+
+    class Error < DockerEngineAPI::Internal::Type::BaseModel
+      attr_accessor message: String
+
+      def initialize: (message: String) -> void
+
+      def to_hash: -> { message: String }
+    end
+  end
+end

data/sig/docker_engine_api/models/exec_inspect_params.rbs

@@ -0,0 +1,15 @@
+module DockerEngineAPI
+  module Models
+    type exec_inspect_params =
+      {  } & DockerEngineAPI::Internal::Type::request_parameters
+
+    class ExecInspectParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: DockerEngineAPI::request_opts) -> void
+
+      def to_hash: -> { request_options: DockerEngineAPI::RequestOptions }
+    end
+  end
+end

data/sig/docker_engine_api/models/exec_inspect_response.rbs

@@ -0,0 +1,94 @@
+module DockerEngineAPI
+  module Models
+    type exec_inspect_response =
+      {
+        can_remove: bool,
+        container_id: String,
+        detach_keys: String,
+        exit_code: Integer,
+        id: String,
+        open_stderr: bool,
+        open_stdin: bool,
+        open_stdout: bool,
+        pid: Integer,
+        process_config: DockerEngineAPI::InspectResponse,
+        running: bool
+      }
+
+    class ExecInspectResponse < DockerEngineAPI::Internal::Type::BaseModel
+      attr_reader can_remove: bool?
+
+      def can_remove=: (bool) -> bool
+
+      attr_reader container_id: String?
+
+      def container_id=: (String) -> String
+
+      attr_reader detach_keys: String?
+
+      def detach_keys=: (String) -> String
+
+      attr_reader exit_code: Integer?
+
+      def exit_code=: (Integer) -> Integer
+
+      attr_reader id: String?
+
+      def id=: (String) -> String
+
+      attr_reader open_stderr: bool?
+
+      def open_stderr=: (bool) -> bool
+
+      attr_reader open_stdin: bool?
+
+      def open_stdin=: (bool) -> bool
+
+      attr_reader open_stdout: bool?
+
+      def open_stdout=: (bool) -> bool
+
+      attr_reader pid: Integer?
+
+      def pid=: (Integer) -> Integer
+
+      attr_reader process_config: DockerEngineAPI::InspectResponse?
+
+      def process_config=: (
+        DockerEngineAPI::InspectResponse
+      ) -> DockerEngineAPI::InspectResponse
+
+      attr_reader running: bool?
+
+      def running=: (bool) -> bool
+
+      def initialize: (
+        ?can_remove: bool,
+        ?container_id: String,
+        ?detach_keys: String,
+        ?exit_code: Integer,
+        ?id: String,
+        ?open_stderr: bool,
+        ?open_stdin: bool,
+        ?open_stdout: bool,
+        ?pid: Integer,
+        ?process_config: DockerEngineAPI::InspectResponse,
+        ?running: bool
+      ) -> void
+
+      def to_hash: -> {
+        can_remove: bool,
+        container_id: String,
+        detach_keys: String,
+        exit_code: Integer,
+        id: String,
+        open_stderr: bool,
+        open_stdin: bool,
+        open_stdout: bool,
+        pid: Integer,
+        process_config: DockerEngineAPI::InspectResponse,
+        running: bool
+      }
+    end
+  end
+end

data/sig/docker_engine_api/models/exec_resize_params.rbs

@@ -0,0 +1,28 @@
+module DockerEngineAPI
+  module Models
+    type exec_resize_params =
+      { h: Integer, w: Integer }
+      & DockerEngineAPI::Internal::Type::request_parameters
+
+    class ExecResizeParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      attr_accessor h: Integer
+
+      attr_accessor w: Integer
+
+      def initialize: (
+        h: Integer,
+        w: Integer,
+        ?request_options: DockerEngineAPI::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        h: Integer,
+        w: Integer,
+        request_options: DockerEngineAPI::RequestOptions
+      }
+    end
+  end
+end

data/sig/docker_engine_api/models/exec_start_params.rbs

@@ -0,0 +1,36 @@
+module DockerEngineAPI
+  module Models
+    type exec_start_params =
+      { console_size: ::Array[Integer]?, detach: bool, tty: bool }
+      & DockerEngineAPI::Internal::Type::request_parameters
+
+    class ExecStartParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      attr_accessor console_size: ::Array[Integer]?
+
+      attr_reader detach: bool?
+
+      def detach=: (bool) -> bool
+
+      attr_reader tty: bool?
+
+      def tty=: (bool) -> bool
+
+      def initialize: (
+        ?console_size: ::Array[Integer]?,
+        ?detach: bool,
+        ?tty: bool,
+        ?request_options: DockerEngineAPI::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        console_size: ::Array[Integer]?,
+        detach: bool,
+        tty: bool,
+        request_options: DockerEngineAPI::RequestOptions
+      }
+    end
+  end
+end

data/sig/docker_engine_api/models/filesystem_change.rbs

@@ -0,0 +1,34 @@
+module DockerEngineAPI
+  module Models
+    type filesystem_change =
+      { kind: DockerEngineAPI::Models::FilesystemChange::kind, path: String }
+
+    class FilesystemChange < DockerEngineAPI::Internal::Type::BaseModel
+      attr_accessor kind: DockerEngineAPI::Models::FilesystemChange::kind
+
+      attr_accessor path: String
+
+      def initialize: (
+        kind: DockerEngineAPI::Models::FilesystemChange::kind,
+        path: String
+      ) -> void
+
+      def to_hash: -> {
+        kind: DockerEngineAPI::Models::FilesystemChange::kind,
+        path: String
+      }
+
+      type kind = 0 | 1 | 2
+
+      module Kind
+        extend DockerEngineAPI::Internal::Type::Enum
+
+        KIND_0: 0
+        KIND_1: 1
+        KIND_2: 2
+
+        def self?.values: -> ::Array[DockerEngineAPI::Models::FilesystemChange::kind]
+      end
+    end
+  end
+end

data/sig/docker_engine_api/models/history_item.rbs

@@ -0,0 +1,45 @@
+module DockerEngineAPI
+  module Models
+    type history_item =
+      {
+        comment: String,
+        created: Integer,
+        created_by: String,
+        id: String,
+        size: Integer,
+        tags: ::Array[String]
+      }
+
+    class HistoryItem < DockerEngineAPI::Internal::Type::BaseModel
+      attr_accessor comment: String
+
+      attr_accessor created: Integer
+
+      attr_accessor created_by: String
+
+      attr_accessor id: String
+
+      attr_accessor size: Integer
+
+      attr_accessor tags: ::Array[String]
+
+      def initialize: (
+        comment: String,
+        created: Integer,
+        created_by: String,
+        id: String,
+        size: Integer,
+        tags: ::Array[String]
+      ) -> void
+
+      def to_hash: -> {
+        comment: String,
+        created: Integer,
+        created_by: String,
+        id: String,
+        size: Integer,
+        tags: ::Array[String]
+      }
+    end
+  end
+end