docker-engine 0.1.1 → 0.2.0

data/rbi/docker_engine/models/plugin_create_params.rbi

@@ -0,0 +1,54 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class PluginCreateParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngine::PluginCreateParams,
+            DockerEngine::Internal::AnyHash
+          )
+        end
+
+      # The name of the plugin. The `:latest` tag is optional, and is the default if
+      # omitted.
+      sig { returns(String) }
+      attr_accessor :name
+
+      sig { returns(DockerEngine::Internal::FileInput) }
+      attr_accessor :body
+
+      sig do
+        params(
+          name: String,
+          body: DockerEngine::Internal::FileInput,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The name of the plugin. The `:latest` tag is optional, and is the default if
+        # omitted.
+        name:,
+        body:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            name: String,
+            body: DockerEngine::Internal::FileInput,
+            request_options: DockerEngine::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine/models/plugin_delete_params.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class PluginDeleteParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngine::PluginDeleteParams,
+            DockerEngine::Internal::AnyHash
+          )
+        end
+
+      # Disable the plugin before removing. This may result in issues if the plugin is
+      # in use by a container.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :force
+
+      sig { params(force: T::Boolean).void }
+      attr_writer :force
+
+      sig do
+        params(
+          force: T::Boolean,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Disable the plugin before removing. This may result in issues if the plugin is
+        # in use by a container.
+        force: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { force: T::Boolean, request_options: DockerEngine::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine/models/plugin_disable_params.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class PluginDisableParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngine::PluginDisableParams,
+            DockerEngine::Internal::AnyHash
+          )
+        end
+
+      # Force disable a plugin even if still in use.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :force
+
+      sig { params(force: T::Boolean).void }
+      attr_writer :force
+
+      sig do
+        params(
+          force: T::Boolean,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Force disable a plugin even if still in use.
+        force: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { force: T::Boolean, request_options: DockerEngine::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine/models/plugin_enable_params.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class PluginEnableParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngine::PluginEnableParams,
+            DockerEngine::Internal::AnyHash
+          )
+        end
+
+      # Set the HTTP client timeout (in seconds)
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :timeout
+
+      sig { params(timeout: Integer).void }
+      attr_writer :timeout
+
+      sig do
+        params(
+          timeout: Integer,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Set the HTTP client timeout (in seconds)
+        timeout: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { timeout: Integer, request_options: DockerEngine::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine/models/plugin_inspect_params.rbi

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

data/rbi/docker_engine/models/plugin_list_params.rbi

@@ -0,0 +1,55 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class PluginListParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(DockerEngine::PluginListParams, DockerEngine::Internal::AnyHash)
+        end
+
+      # A JSON encoded value of the filters (a `map[string][]string`) to process on the
+      # plugin list.
+      #
+      # Available filters:
+      #
+      # - `capability=<capability name>`
+      # - `enable=<true>|<false>`
+      sig { returns(T.nilable(String)) }
+      attr_reader :filters
+
+      sig { params(filters: String).void }
+      attr_writer :filters
+
+      sig do
+        params(
+          filters: String,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A JSON encoded value of the filters (a `map[string][]string`) to process on the
+        # plugin list.
+        #
+        # Available filters:
+        #
+        # - `capability=<capability name>`
+        # - `enable=<true>|<false>`
+        filters: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { filters: String, request_options: DockerEngine::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine/models/plugin_list_response.rbi

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

data/rbi/docker_engine/models/plugin_privileges_params.rbi

@@ -0,0 +1,45 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class PluginPrivilegesParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngine::PluginPrivilegesParams,
+            DockerEngine::Internal::AnyHash
+          )
+        end
+
+      # The name of the plugin. The `:latest` tag is optional, and is the default if
+      # omitted.
+      sig { returns(String) }
+      attr_accessor :remote
+
+      sig do
+        params(
+          remote: String,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The name of the plugin. The `:latest` tag is optional, and is the default if
+        # omitted.
+        remote:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { remote: String, request_options: DockerEngine::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine/models/plugin_privileges_response.rbi

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

data/rbi/docker_engine/models/plugin_pull_params.rbi

@@ -0,0 +1,80 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class PluginPullParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(DockerEngine::PluginPullParams, DockerEngine::Internal::AnyHash)
+        end
+
+      # Remote reference for plugin to install.
+      #
+      # The `:latest` tag is optional, and is used as the default if omitted.
+      sig { returns(String) }
+      attr_accessor :remote
+
+      # Local name for the pulled plugin.
+      #
+      # The `:latest` tag is optional, and is used as the default if omitted.
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      sig { returns(T.nilable(T::Array[DockerEngine::Privilege])) }
+      attr_reader :body
+
+      sig { params(body: T::Array[DockerEngine::Privilege::OrHash]).void }
+      attr_writer :body
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :x_registry_auth
+
+      sig { params(x_registry_auth: String).void }
+      attr_writer :x_registry_auth
+
+      sig do
+        params(
+          remote: String,
+          name: String,
+          body: T::Array[DockerEngine::Privilege::OrHash],
+          x_registry_auth: String,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Remote reference for plugin to install.
+        #
+        # The `:latest` tag is optional, and is used as the default if omitted.
+        remote:,
+        # Local name for the pulled plugin.
+        #
+        # The `:latest` tag is optional, and is used as the default if omitted.
+        name: nil,
+        body: nil,
+        x_registry_auth: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            remote: String,
+            name: String,
+            body: T::Array[DockerEngine::Privilege],
+            x_registry_auth: String,
+            request_options: DockerEngine::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine/models/plugin_push_params.rbi

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

data/rbi/docker_engine/models/plugin_set_params.rbi

@@ -0,0 +1,41 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class PluginSetParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(DockerEngine::PluginSetParams, DockerEngine::Internal::AnyHash)
+        end
+
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :body
+
+      sig { params(body: T::Array[String]).void }
+      attr_writer :body
+
+      sig do
+        params(
+          body: T::Array[String],
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(body: nil, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          {
+            body: T::Array[String],
+            request_options: DockerEngine::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine/models/plugin_upgrade_params.rbi

@@ -0,0 +1,68 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class PluginUpgradeParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngine::PluginUpgradeParams,
+            DockerEngine::Internal::AnyHash
+          )
+        end
+
+      # Remote reference to upgrade to.
+      #
+      # The `:latest` tag is optional, and is used as the default if omitted.
+      sig { returns(String) }
+      attr_accessor :remote
+
+      sig { returns(T.nilable(T::Array[DockerEngine::Privilege])) }
+      attr_reader :body
+
+      sig { params(body: T::Array[DockerEngine::Privilege::OrHash]).void }
+      attr_writer :body
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :x_registry_auth
+
+      sig { params(x_registry_auth: String).void }
+      attr_writer :x_registry_auth
+
+      sig do
+        params(
+          remote: String,
+          body: T::Array[DockerEngine::Privilege::OrHash],
+          x_registry_auth: String,
+          request_options: DockerEngine::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Remote reference to upgrade to.
+        #
+        # The `:latest` tag is optional, and is used as the default if omitted.
+        remote:,
+        body: nil,
+        x_registry_auth: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            remote: String,
+            body: T::Array[DockerEngine::Privilege],
+            x_registry_auth: String,
+            request_options: DockerEngine::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine/models/privilege.rbi

@@ -0,0 +1,49 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class Privilege < DockerEngine::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(DockerEngine::Privilege, DockerEngine::Internal::AnyHash)
+        end
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :description
+
+      sig { params(description: String).void }
+      attr_writer :description
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :value
+
+      sig { params(value: T::Array[String]).void }
+      attr_writer :value
+
+      # Describes a permission the user has to accept upon installing the plugin.
+      sig do
+        params(
+          description: String,
+          name: String,
+          value: T::Array[String]
+        ).returns(T.attached_class)
+      end
+      def self.new(description: nil, name: nil, value: nil)
+      end
+
+      sig do
+        override.returns(
+          { description: String, name: String, value: T::Array[String] }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end