docker-engine-ruby 0.2.2 → 0.4.0

data/rbi/docker_engine_ruby/models/container_update_params.rbi

@@ -342,25 +342,6 @@ module DockerEngineRuby
       sig { returns(T.nilable(Integer)) }
       attr_accessor :pids_limit
 
-      # The behavior to apply when the container exits. The default is not to restart.
-      #
-      # An ever increasing delay (double the previous delay, starting at 100ms) is added
-      # before each restart to prevent flooding the server.
-      sig do
-        returns(
-          T.nilable(DockerEngineRuby::ContainerUpdateParams::RestartPolicy)
-        )
-      end
-      attr_reader :restart_policy
-
-      sig do
-        params(
-          restart_policy:
-            DockerEngineRuby::ContainerUpdateParams::RestartPolicy::OrHash
-        ).void
-      end
-      attr_writer :restart_policy
-
       # A list of resource limits to set in the container. For example:
       #
       # ```
@@ -431,8 +412,6 @@ module DockerEngineRuby
           nano_cpus: Integer,
           oom_kill_disable: T::Boolean,
           pids_limit: T.nilable(Integer),
-          restart_policy:
-            DockerEngineRuby::ContainerUpdateParams::RestartPolicy::OrHash,
           ulimits:
             T::Array[DockerEngineRuby::ContainerUpdateParams::Ulimit::OrHash],
           request_options: DockerEngineRuby::RequestOptions::OrHash
@@ -535,11 +514,6 @@ module DockerEngineRuby
         # Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not
         # change.
         pids_limit: nil,
-        # The behavior to apply when the container exits. The default is not to restart.
-        #
-        # An ever increasing delay (double the previous delay, starting at 100ms) is added
-        # before each restart to prevent flooding the server.
-        restart_policy: nil,
         # A list of resource limits to set in the container. For example:
         #
         # ```
@@ -598,8 +572,6 @@ module DockerEngineRuby
             nano_cpus: Integer,
             oom_kill_disable: T::Boolean,
             pids_limit: T.nilable(Integer),
-            restart_policy:
-              DockerEngineRuby::ContainerUpdateParams::RestartPolicy,
             ulimits: T::Array[DockerEngineRuby::ContainerUpdateParams::Ulimit],
             request_options: DockerEngineRuby::RequestOptions
           }
@@ -940,137 +912,6 @@ module DockerEngineRuby
         end
       end
 
-      class RestartPolicy < DockerEngineRuby::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              DockerEngineRuby::ContainerUpdateParams::RestartPolicy,
-              DockerEngineRuby::Internal::AnyHash
-            )
-          end
-
-        # If `on-failure` is used, the number of times to retry before giving up.
-        sig { returns(T.nilable(Integer)) }
-        attr_reader :maximum_retry_count
-
-        sig { params(maximum_retry_count: Integer).void }
-        attr_writer :maximum_retry_count
-
-        # - Empty string means not to restart
-        # - `no` Do not automatically restart
-        # - `always` Always restart
-        # - `unless-stopped` Restart always except when the user has manually stopped the
-        #   container
-        # - `on-failure` Restart only when the container exit code is non-zero
-        sig do
-          returns(
-            T.nilable(
-              DockerEngineRuby::ContainerUpdateParams::RestartPolicy::Name::OrSymbol
-            )
-          )
-        end
-        attr_reader :name
-
-        sig do
-          params(
-            name:
-              DockerEngineRuby::ContainerUpdateParams::RestartPolicy::Name::OrSymbol
-          ).void
-        end
-        attr_writer :name
-
-        # The behavior to apply when the container exits. The default is not to restart.
-        #
-        # An ever increasing delay (double the previous delay, starting at 100ms) is added
-        # before each restart to prevent flooding the server.
-        sig do
-          params(
-            maximum_retry_count: Integer,
-            name:
-              DockerEngineRuby::ContainerUpdateParams::RestartPolicy::Name::OrSymbol
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # If `on-failure` is used, the number of times to retry before giving up.
-          maximum_retry_count: nil,
-          # - Empty string means not to restart
-          # - `no` Do not automatically restart
-          # - `always` Always restart
-          # - `unless-stopped` Restart always except when the user has manually stopped the
-          #   container
-          # - `on-failure` Restart only when the container exit code is non-zero
-          name: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              maximum_retry_count: Integer,
-              name:
-                DockerEngineRuby::ContainerUpdateParams::RestartPolicy::Name::OrSymbol
-            }
-          )
-        end
-        def to_hash
-        end
-
-        # - Empty string means not to restart
-        # - `no` Do not automatically restart
-        # - `always` Always restart
-        # - `unless-stopped` Restart always except when the user has manually stopped the
-        #   container
-        # - `on-failure` Restart only when the container exit code is non-zero
-        module Name
-          extend DockerEngineRuby::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                DockerEngineRuby::ContainerUpdateParams::RestartPolicy::Name
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          EMPTY =
-            T.let(
-              :"",
-              DockerEngineRuby::ContainerUpdateParams::RestartPolicy::Name::TaggedSymbol
-            )
-          NO =
-            T.let(
-              :no,
-              DockerEngineRuby::ContainerUpdateParams::RestartPolicy::Name::TaggedSymbol
-            )
-          ALWAYS =
-            T.let(
-              :always,
-              DockerEngineRuby::ContainerUpdateParams::RestartPolicy::Name::TaggedSymbol
-            )
-          UNLESS_STOPPED =
-            T.let(
-              :"unless-stopped",
-              DockerEngineRuby::ContainerUpdateParams::RestartPolicy::Name::TaggedSymbol
-            )
-          ON_FAILURE =
-            T.let(
-              :"on-failure",
-              DockerEngineRuby::ContainerUpdateParams::RestartPolicy::Name::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                DockerEngineRuby::ContainerUpdateParams::RestartPolicy::Name::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
-
       class Ulimit < DockerEngineRuby::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
@@ -1080,21 +921,18 @@ module DockerEngineRuby
             )
           end
 
-        # Hard limit
         sig { returns(T.nilable(Integer)) }
         attr_reader :hard
 
         sig { params(hard: Integer).void }
         attr_writer :hard
 
-        # Name of ulimit
         sig { returns(T.nilable(String)) }
         attr_reader :name
 
         sig { params(name: String).void }
         attr_writer :name
 
-        # Soft limit
         sig { returns(T.nilable(Integer)) }
         attr_reader :soft
 
@@ -1106,14 +944,7 @@ module DockerEngineRuby
             T.attached_class
           )
         end
-        def self.new(
-          # Hard limit
-          hard: nil,
-          # Name of ulimit
-          name: nil,
-          # Soft limit
-          soft: nil
-        )
+        def self.new(hard: nil, name: nil, soft: nil)
         end
 
         sig { override.returns({ hard: Integer, name: String, soft: Integer }) }

data/rbi/docker_engine_ruby/models/container_wait_params.rbi

@@ -14,9 +14,6 @@ module DockerEngineRuby
           )
         end
 
-      # Wait until a container state reaches the given condition.
-      #
-      # Defaults to `not-running` if omitted or empty.
       sig do
         returns(
           T.nilable(DockerEngineRuby::ContainerWaitParams::Condition::OrSymbol)
@@ -37,13 +34,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(
-        # Wait until a container state reaches the given condition.
-        #
-        # Defaults to `not-running` if omitted or empty.
-        condition: nil,
-        request_options: {}
-      )
+      def self.new(condition: nil, request_options: {})
       end
 
       sig do
@@ -58,9 +49,6 @@ module DockerEngineRuby
       def to_hash
       end
 
-      # Wait until a container state reaches the given condition.
-      #
-      # Defaults to `not-running` if omitted or empty.
       module Condition
         extend DockerEngineRuby::Internal::Type::Enum
 

data/rbi/docker_engine_ruby/models/create_request.rbi

@@ -174,9 +174,6 @@ module DockerEngineRuby
               )
             end
 
-          # Requirements for the accessible topology of the volume. These fields are
-          # optional. For an in-depth description of what these fields mean, see the CSI
-          # specification.
           sig do
             returns(
               T.nilable(
@@ -194,13 +191,6 @@ module DockerEngineRuby
           end
           attr_writer :accessibility_requirements
 
-          # The availability of the volume for use in tasks.
-          #
-          # - `active` The volume is fully available for scheduling on the cluster
-          # - `pause` No new workloads should use the volume, but existing workloads are not
-          #   stopped.
-          # - `drain` All workloads using this volume should be stopped and rescheduled, and
-          #   no new ones should be started.
           sig do
             returns(
               T.nilable(
@@ -218,8 +208,6 @@ module DockerEngineRuby
           end
           attr_writer :availability
 
-          # The desired capacity that the volume should be created with. If empty, the
-          # plugin will decide the capacity.
           sig do
             returns(
               T.nilable(
@@ -237,27 +225,12 @@ module DockerEngineRuby
           end
           attr_writer :capacity_range
 
-          # Options for using this volume as a Mount-type volume.
-          #
-          #     Either MountVolume or BlockVolume, but not both, must be
-          #     present.
-          #
-          # properties: FsType: type: "string" description: | Specifies the filesystem type
-          # for the mount volume. Optional. MountFlags: type: "array" description: | Flags
-          # to pass when mounting the volume. Optional. items: type: "string" BlockVolume:
-          # type: "object" description: | Options for using this volume as a Block-type
-          # volume. Intentionally empty.
-          sig { returns(T.nilable(T.anything)) }
+          sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
           attr_reader :mount_volume
 
-          sig { params(mount_volume: T.anything).void }
+          sig { params(mount_volume: T::Hash[Symbol, T.anything]).void }
           attr_writer :mount_volume
 
-          # The set of nodes this volume can be used on at one time.
-          #
-          # - `single` The volume may only be scheduled to one node at a time.
-          # - `multi` the volume may be scheduled to any supported number of nodes at a
-          #   time.
           sig do
             returns(
               T.nilable(
@@ -275,8 +248,6 @@ module DockerEngineRuby
           end
           attr_writer :scope
 
-          # Swarm Secrets that are passed to the CSI storage plugin when operating on this
-          # volume.
           sig do
             returns(
               T.nilable(
@@ -298,14 +269,6 @@ module DockerEngineRuby
           end
           attr_writer :secrets
 
-          # The number and way that different tasks can use this volume at one time.
-          #
-          # - `none` The volume may only be used by one task at a time.
-          # - `readonly` The volume may be used by any number of tasks, but they all must
-          #   mount the volume as readonly
-          # - `onewriter` The volume may be used by any number of tasks, but only one may
-          #   mount it as read/write.
-          # - `all` The volume may have any number of readers and writers.
           sig do
             returns(
               T.nilable(
@@ -332,7 +295,7 @@ module DockerEngineRuby
                 DockerEngineRuby::CreateRequest::ClusterVolumeSpec::AccessMode::Availability::OrSymbol,
               capacity_range:
                 DockerEngineRuby::CreateRequest::ClusterVolumeSpec::AccessMode::CapacityRange::OrHash,
-              mount_volume: T.anything,
+              mount_volume: T::Hash[Symbol, T.anything],
               scope:
                 DockerEngineRuby::CreateRequest::ClusterVolumeSpec::AccessMode::Scope::OrSymbol,
               secrets:
@@ -344,49 +307,12 @@ module DockerEngineRuby
             ).returns(T.attached_class)
           end
           def self.new(
-            # Requirements for the accessible topology of the volume. These fields are
-            # optional. For an in-depth description of what these fields mean, see the CSI
-            # specification.
             accessibility_requirements: nil,
-            # The availability of the volume for use in tasks.
-            #
-            # - `active` The volume is fully available for scheduling on the cluster
-            # - `pause` No new workloads should use the volume, but existing workloads are not
-            #   stopped.
-            # - `drain` All workloads using this volume should be stopped and rescheduled, and
-            #   no new ones should be started.
             availability: nil,
-            # The desired capacity that the volume should be created with. If empty, the
-            # plugin will decide the capacity.
             capacity_range: nil,
-            # Options for using this volume as a Mount-type volume.
-            #
-            #     Either MountVolume or BlockVolume, but not both, must be
-            #     present.
-            #
-            # properties: FsType: type: "string" description: | Specifies the filesystem type
-            # for the mount volume. Optional. MountFlags: type: "array" description: | Flags
-            # to pass when mounting the volume. Optional. items: type: "string" BlockVolume:
-            # type: "object" description: | Options for using this volume as a Block-type
-            # volume. Intentionally empty.
             mount_volume: nil,
-            # The set of nodes this volume can be used on at one time.
-            #
-            # - `single` The volume may only be scheduled to one node at a time.
-            # - `multi` the volume may be scheduled to any supported number of nodes at a
-            #   time.
             scope: nil,
-            # Swarm Secrets that are passed to the CSI storage plugin when operating on this
-            # volume.
             secrets: nil,
-            # The number and way that different tasks can use this volume at one time.
-            #
-            # - `none` The volume may only be used by one task at a time.
-            # - `readonly` The volume may be used by any number of tasks, but they all must
-            #   mount the volume as readonly
-            # - `onewriter` The volume may be used by any number of tasks, but only one may
-            #   mount it as read/write.
-            # - `all` The volume may have any number of readers and writers.
             sharing: nil
           )
           end
@@ -400,7 +326,7 @@ module DockerEngineRuby
                   DockerEngineRuby::CreateRequest::ClusterVolumeSpec::AccessMode::Availability::OrSymbol,
                 capacity_range:
                   DockerEngineRuby::CreateRequest::ClusterVolumeSpec::AccessMode::CapacityRange,
-                mount_volume: T.anything,
+                mount_volume: T::Hash[Symbol, T.anything],
                 scope:
                   DockerEngineRuby::CreateRequest::ClusterVolumeSpec::AccessMode::Scope::OrSymbol,
                 secrets:
@@ -424,37 +350,25 @@ module DockerEngineRuby
                 )
               end
 
-            # A list of topologies that the volume should attempt to be provisioned in.
             sig { returns(T.nilable(T::Array[T::Hash[Symbol, String]])) }
             attr_reader :preferred
 
             sig { params(preferred: T::Array[T::Hash[Symbol, String]]).void }
             attr_writer :preferred
 
-            # A list of required topologies, at least one of which the volume must be
-            # accessible from.
             sig { returns(T.nilable(T::Array[T::Hash[Symbol, String]])) }
             attr_reader :requisite
 
             sig { params(requisite: T::Array[T::Hash[Symbol, String]]).void }
             attr_writer :requisite
 
-            # Requirements for the accessible topology of the volume. These fields are
-            # optional. For an in-depth description of what these fields mean, see the CSI
-            # specification.
             sig do
               params(
                 preferred: T::Array[T::Hash[Symbol, String]],
                 requisite: T::Array[T::Hash[Symbol, String]]
               ).returns(T.attached_class)
             end
-            def self.new(
-              # A list of topologies that the volume should attempt to be provisioned in.
-              preferred: nil,
-              # A list of required topologies, at least one of which the volume must be
-              # accessible from.
-              requisite: nil
-            )
+            def self.new(preferred: nil, requisite: nil)
             end
 
             sig do
@@ -469,13 +383,6 @@ module DockerEngineRuby
             end
           end
 
-          # The availability of the volume for use in tasks.
-          #
-          # - `active` The volume is fully available for scheduling on the cluster
-          # - `pause` No new workloads should use the volume, but existing workloads are not
-          #   stopped.
-          # - `drain` All workloads using this volume should be stopped and rescheduled, and
-          #   no new ones should be started.
           module Availability
             extend DockerEngineRuby::Internal::Type::Enum
 
@@ -524,37 +431,24 @@ module DockerEngineRuby
                 )
               end
 
-            # The volume must not be bigger than this. The value of 0 indicates an unspecified
-            # maximum.
             sig { returns(T.nilable(Integer)) }
             attr_reader :limit_bytes
 
             sig { params(limit_bytes: Integer).void }
             attr_writer :limit_bytes
 
-            # The volume must be at least this big. The value of 0 indicates an unspecified
-            # minimum
             sig { returns(T.nilable(Integer)) }
             attr_reader :required_bytes
 
             sig { params(required_bytes: Integer).void }
             attr_writer :required_bytes
 
-            # The desired capacity that the volume should be created with. If empty, the
-            # plugin will decide the capacity.
             sig do
               params(limit_bytes: Integer, required_bytes: Integer).returns(
                 T.attached_class
               )
             end
-            def self.new(
-              # The volume must not be bigger than this. The value of 0 indicates an unspecified
-              # maximum.
-              limit_bytes: nil,
-              # The volume must be at least this big. The value of 0 indicates an unspecified
-              # minimum
-              required_bytes: nil
-            )
+            def self.new(limit_bytes: nil, required_bytes: nil)
             end
 
             sig do
@@ -566,11 +460,6 @@ module DockerEngineRuby
             end
           end
 
-          # The set of nodes this volume can be used on at one time.
-          #
-          # - `single` The volume may only be scheduled to one node at a time.
-          # - `multi` the volume may be scheduled to any supported number of nodes at a
-          #   time.
           module Scope
             extend DockerEngineRuby::Internal::Type::Enum
 
@@ -614,35 +503,22 @@ module DockerEngineRuby
                 )
               end
 
-            # Key is the name of the key of the key-value pair passed to the plugin.
             sig { returns(T.nilable(String)) }
             attr_reader :key
 
             sig { params(key: String).void }
             attr_writer :key
 
-            # Secret is the swarm Secret object from which to read data. This can be a Secret
-            # name or ID. The Secret data is retrieved by swarm and used as the value of the
-            # key-value pair passed to the plugin.
             sig { returns(T.nilable(String)) }
             attr_reader :secret
 
             sig { params(secret: String).void }
             attr_writer :secret
 
-            # One cluster volume secret entry. Defines a key-value pair that is passed to the
-            # plugin.
             sig do
               params(key: String, secret: String).returns(T.attached_class)
             end
-            def self.new(
-              # Key is the name of the key of the key-value pair passed to the plugin.
-              key: nil,
-              # Secret is the swarm Secret object from which to read data. This can be a Secret
-              # name or ID. The Secret data is retrieved by swarm and used as the value of the
-              # key-value pair passed to the plugin.
-              secret: nil
-            )
+            def self.new(key: nil, secret: nil)
             end
 
             sig { override.returns({ key: String, secret: String }) }
@@ -650,14 +526,6 @@ module DockerEngineRuby
             end
           end
 
-          # The number and way that different tasks can use this volume at one time.
-          #
-          # - `none` The volume may only be used by one task at a time.
-          # - `readonly` The volume may be used by any number of tasks, but they all must
-          #   mount the volume as readonly
-          # - `onewriter` The volume may be used by any number of tasks, but only one may
-          #   mount it as read/write.
-          # - `all` The volume may have any number of readers and writers.
           module Sharing
             extend DockerEngineRuby::Internal::Type::Enum
 

data/rbi/docker_engine_ruby/models/exec_inspect_response.rbi

@@ -59,7 +59,6 @@ module DockerEngineRuby
       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
 
@@ -104,7 +103,6 @@ module DockerEngineRuby
         open_stderr: nil,
         open_stdin: nil,
         open_stdout: nil,
-        # The system process ID for the exec process.
         pid: nil,
         process_config: nil,
         running: nil

data/rbi/docker_engine_ruby/models/exec_resize_params.rbi

@@ -14,11 +14,9 @@ module DockerEngineRuby
           )
         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
 
@@ -29,13 +27,7 @@ module DockerEngineRuby
           request_options: DockerEngineRuby::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: {}
-      )
+      def self.new(h:, w:, request_options: {})
       end
 
       sig do

data/rbi/docker_engine_ruby/models/exec_start_params.rbi

@@ -14,18 +14,15 @@ module DockerEngineRuby
           )
         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
 
@@ -41,11 +38,8 @@ module DockerEngineRuby
         ).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: {}
       )