docker-engine-api 0.2.1

data/lib/docker_engine_api/models/create_request.rb

@@ -0,0 +1,348 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    class CreateRequest < DockerEngineAPI::Internal::Type::BaseModel
+      # @!attribute cluster_volume_spec
+      #   Cluster-specific options used to create the volume.
+      #
+      #   @return [DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec, nil]
+      optional :cluster_volume_spec,
+               -> { DockerEngineAPI::CreateRequest::ClusterVolumeSpec },
+               api_name: :ClusterVolumeSpec
+
+      # @!attribute driver
+      #   Name of the volume driver to use.
+      #
+      #   @return [String, nil]
+      optional :driver, String, api_name: :Driver
+
+      # @!attribute driver_opts
+      #   A mapping of driver options and values. These options are passed directly to the
+      #   driver and are driver specific.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :driver_opts, DockerEngineAPI::Internal::Type::HashOf[String], api_name: :DriverOpts
+
+      # @!attribute labels
+      #   User-defined key/value metadata.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :labels, DockerEngineAPI::Internal::Type::HashOf[String], api_name: :Labels
+
+      # @!attribute name
+      #   The new volume's name. If not specified, Docker generates a name.
+      #
+      #   @return [String, nil]
+      optional :name, String, api_name: :Name
+
+      # @!method initialize(cluster_volume_spec: nil, driver: nil, driver_opts: nil, labels: nil, name: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngineAPI::Models::CreateRequest} for more details.
+      #
+      #   Volume configuration
+      #
+      #   @param cluster_volume_spec [DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec] Cluster-specific options used to create the volume.
+      #
+      #   @param driver [String] Name of the volume driver to use.
+      #
+      #   @param driver_opts [Hash{Symbol=>String}] A mapping of driver options and values. These options are
+      #
+      #   @param labels [Hash{Symbol=>String}] User-defined key/value metadata.
+      #
+      #   @param name [String] The new volume's name. If not specified, Docker generates a name.
+
+      # @see DockerEngineAPI::Models::CreateRequest#cluster_volume_spec
+      class ClusterVolumeSpec < DockerEngineAPI::Internal::Type::BaseModel
+        # @!attribute access_mode
+        #   Defines how the volume is used by tasks.
+        #
+        #   @return [DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode, nil]
+        optional :access_mode,
+                 -> { DockerEngineAPI::CreateRequest::ClusterVolumeSpec::AccessMode },
+                 api_name: :AccessMode
+
+        # @!attribute group
+        #   Group defines the volume group of this volume. Volumes belonging to the same
+        #   group can be referred to by group name when creating Services. Referring to a
+        #   volume by group instructs Swarm to treat volumes in that group interchangeably
+        #   for the purpose of scheduling. Volumes with an empty string for a group
+        #   technically all belong to the same, emptystring group.
+        #
+        #   @return [String, nil]
+        optional :group, String, api_name: :Group
+
+        # @!method initialize(access_mode: nil, group: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec} for more details.
+        #
+        #   Cluster-specific options used to create the volume.
+        #
+        #   @param access_mode [DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode] Defines how the volume is used by tasks.
+        #
+        #   @param group [String] Group defines the volume group of this volume. Volumes belonging to
+
+        # @see DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec#access_mode
+        class AccessMode < DockerEngineAPI::Internal::Type::BaseModel
+          # @!attribute accessibility_requirements
+          #   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.
+          #
+          #   @return [DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::AccessibilityRequirements, nil]
+          optional :accessibility_requirements,
+                   -> {
+                     DockerEngineAPI::CreateRequest::ClusterVolumeSpec::AccessMode::AccessibilityRequirements
+                   },
+                   api_name: :AccessibilityRequirements
+
+          # @!attribute availability
+          #   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.
+          #
+          #   @return [Symbol, DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::Availability, nil]
+          optional :availability,
+                   enum: -> { DockerEngineAPI::CreateRequest::ClusterVolumeSpec::AccessMode::Availability },
+                   api_name: :Availability
+
+          # @!attribute capacity_range
+          #   The desired capacity that the volume should be created with. If empty, the
+          #   plugin will decide the capacity.
+          #
+          #   @return [DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::CapacityRange, nil]
+          optional :capacity_range,
+                   -> { DockerEngineAPI::CreateRequest::ClusterVolumeSpec::AccessMode::CapacityRange },
+                   api_name: :CapacityRange
+
+          # @!attribute mount_volume
+          #   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.
+          #
+          #   @return [Object, nil]
+          optional :mount_volume, DockerEngineAPI::Internal::Type::Unknown, api_name: :MountVolume
+
+          # @!attribute scope
+          #   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.
+          #
+          #   @return [Symbol, DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::Scope, nil]
+          optional :scope,
+                   enum: -> { DockerEngineAPI::CreateRequest::ClusterVolumeSpec::AccessMode::Scope },
+                   api_name: :Scope
+
+          # @!attribute secrets
+          #   Swarm Secrets that are passed to the CSI storage plugin when operating on this
+          #   volume.
+          #
+          #   @return [Array<DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::Secret>, nil]
+          optional :secrets,
+                   -> {
+                     DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::CreateRequest::ClusterVolumeSpec::AccessMode::Secret]
+                   },
+                   api_name: :Secrets
+
+          # @!attribute sharing
+          #   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.
+          #
+          #   @return [Symbol, DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::Sharing, nil]
+          optional :sharing,
+                   enum: -> { DockerEngineAPI::CreateRequest::ClusterVolumeSpec::AccessMode::Sharing },
+                   api_name: :Sharing
+
+          # @!method initialize(accessibility_requirements: nil, availability: nil, capacity_range: nil, mount_volume: nil, scope: nil, secrets: nil, sharing: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode} for more
+          #   details.
+          #
+          #   Defines how the volume is used by tasks.
+          #
+          #   @param accessibility_requirements [DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::AccessibilityRequirements] Requirements for the accessible topology of the volume. These
+          #
+          #   @param availability [Symbol, DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::Availability] The availability of the volume for use in tasks.
+          #
+          #   @param capacity_range [DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::CapacityRange] The desired capacity that the volume should be created with. If
+          #
+          #   @param mount_volume [Object] Options for using this volume as a Mount-type volume.
+          #
+          #   @param scope [Symbol, DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::Scope] The set of nodes this volume can be used on at one time.
+          #
+          #   @param secrets [Array<DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::Secret>] Swarm Secrets that are passed to the CSI storage plugin when
+          #
+          #   @param sharing [Symbol, DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::Sharing] The number and way that different tasks can use this volume
+
+          # @see DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode#accessibility_requirements
+          class AccessibilityRequirements < DockerEngineAPI::Internal::Type::BaseModel
+            # @!attribute preferred
+            #   A list of topologies that the volume should attempt to be provisioned in.
+            #
+            #   @return [Array<Hash{Symbol=>String}>, nil]
+            optional :preferred,
+                     DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Internal::Type::HashOf[String]],
+                     api_name: :Preferred
+
+            # @!attribute requisite
+            #   A list of required topologies, at least one of which the volume must be
+            #   accessible from.
+            #
+            #   @return [Array<Hash{Symbol=>String}>, nil]
+            optional :requisite,
+                     DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Internal::Type::HashOf[String]],
+                     api_name: :Requisite
+
+            # @!method initialize(preferred: nil, requisite: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::AccessibilityRequirements}
+            #   for more details.
+            #
+            #   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.
+            #
+            #   @param preferred [Array<Hash{Symbol=>String}>] A list of topologies that the volume should attempt to be
+            #
+            #   @param requisite [Array<Hash{Symbol=>String}>] A list of required topologies, at least one of which the
+          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.
+          #
+          # @see DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode#availability
+          module Availability
+            extend DockerEngineAPI::Internal::Type::Enum
+
+            ACTIVE = :active
+            PAUSE = :pause
+            DRAIN = :drain
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # @see DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode#capacity_range
+          class CapacityRange < DockerEngineAPI::Internal::Type::BaseModel
+            # @!attribute limit_bytes
+            #   The volume must not be bigger than this. The value of 0 indicates an unspecified
+            #   maximum.
+            #
+            #   @return [Integer, nil]
+            optional :limit_bytes, Integer, api_name: :LimitBytes
+
+            # @!attribute required_bytes
+            #   The volume must be at least this big. The value of 0 indicates an unspecified
+            #   minimum
+            #
+            #   @return [Integer, nil]
+            optional :required_bytes, Integer, api_name: :RequiredBytes
+
+            # @!method initialize(limit_bytes: nil, required_bytes: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::CapacityRange}
+            #   for more details.
+            #
+            #   The desired capacity that the volume should be created with. If empty, the
+            #   plugin will decide the capacity.
+            #
+            #   @param limit_bytes [Integer] The volume must not be bigger than this. The value of 0
+            #
+            #   @param required_bytes [Integer] The volume must be at least this big. The value of 0
+          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.
+          #
+          # @see DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode#scope
+          module Scope
+            extend DockerEngineAPI::Internal::Type::Enum
+
+            SINGLE = :single
+            MULTI = :multi
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          class Secret < DockerEngineAPI::Internal::Type::BaseModel
+            # @!attribute key
+            #   Key is the name of the key of the key-value pair passed to the plugin.
+            #
+            #   @return [String, nil]
+            optional :key, String, api_name: :Key
+
+            # @!attribute secret
+            #   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.
+            #
+            #   @return [String, nil]
+            optional :secret, String, api_name: :Secret
+
+            # @!method initialize(key: nil, secret: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode::Secret}
+            #   for more details.
+            #
+            #   One cluster volume secret entry. Defines a key-value pair that is passed to the
+            #   plugin.
+            #
+            #   @param key [String] Key is the name of the key of the key-value pair passed to
+            #
+            #   @param secret [String] Secret is the swarm Secret object from which to read data.
+          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.
+          #
+          # @see DockerEngineAPI::Models::CreateRequest::ClusterVolumeSpec::AccessMode#sharing
+          module Sharing
+            extend DockerEngineAPI::Internal::Type::Enum
+
+            NONE = :none
+            READONLY = :readonly
+            ONEWRITER = :onewriter
+            ALL = :all
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/docker_engine_api/models/create_response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Containers#create
+    class CreateResponse < DockerEngineAPI::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of the created container
+      #
+      #   @return [String]
+      required :id, String, api_name: :Id
+
+      # @!attribute warnings
+      #   Warnings encountered when creating the container
+      #
+      #   @return [Array<String>]
+      required :warnings, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :Warnings
+
+      # @!method initialize(id:, warnings:)
+      #   OK response to ContainerCreate operation
+      #
+      #   @param id [String] The ID of the created container
+      #
+      #   @param warnings [Array<String>] Warnings encountered when creating the container
+    end
+  end
+end

data/lib/docker_engine_api/models/delete_item.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    class DeleteItem < DockerEngineAPI::Internal::Type::BaseModel
+      # @!attribute deleted
+      #   The image ID of an image that was deleted
+      #
+      #   @return [String, nil]
+      optional :deleted, String, api_name: :Deleted
+
+      # @!attribute untagged
+      #   The image ID of an image that was untagged
+      #
+      #   @return [String, nil]
+      optional :untagged, String, api_name: :Untagged
+
+      # @!method initialize(deleted: nil, untagged: nil)
+      #   @param deleted [String] The image ID of an image that was deleted
+      #
+      #   @param untagged [String] The image ID of an image that was untagged
+    end
+  end
+end

data/lib/docker_engine_api/models/disconnect_request.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    class DisconnectRequest < DockerEngineAPI::Internal::Type::BaseModel
+      # @!attribute container
+      #   The ID or name of the container to disconnect from the network.
+      #
+      #   @return [String]
+      required :container, String, api_name: :Container
+
+      # @!attribute force
+      #   Force the container to disconnect from the network.
+      #
+      #   @return [Boolean, nil]
+      optional :force, DockerEngineAPI::Internal::Type::Boolean, api_name: :Force
+
+      # @!method initialize(container:, force: nil)
+      #   NetworkDisconnectRequest represents the data to be used to disconnect a
+      #   container from a network.
+      #
+      #   @param container [String] The ID or name of the container to disconnect from the network.
+      #
+      #   @param force [Boolean] Force the container to disconnect from the network.
+    end
+  end
+end

data/lib/docker_engine_api/models/distribution_inspect_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Distribution#inspect_
+    class DistributionInspectParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine_api/models/error.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    class Error < DockerEngineAPI::Internal::Type::BaseModel
+      # @!attribute message
+      #   The error message.
+      #
+      #   @return [String]
+      required :message, String
+
+      # @!method initialize(message:)
+      #   Represents an error.
+      #
+      #   @param message [String] The error message.
+    end
+  end
+end

data/lib/docker_engine_api/models/exec_inspect_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Exec#inspect_
+    class ExecInspectParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine_api/models/exec_inspect_response.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Exec#inspect_
+    class ExecInspectResponse < DockerEngineAPI::Internal::Type::BaseModel
+      # @!attribute can_remove
+      #
+      #   @return [Boolean, nil]
+      optional :can_remove, DockerEngineAPI::Internal::Type::Boolean, api_name: :CanRemove
+
+      # @!attribute container_id
+      #
+      #   @return [String, nil]
+      optional :container_id, String, api_name: :ContainerID
+
+      # @!attribute detach_keys
+      #
+      #   @return [String, nil]
+      optional :detach_keys, String, api_name: :DetachKeys
+
+      # @!attribute exit_code
+      #
+      #   @return [Integer, nil]
+      optional :exit_code, Integer, api_name: :ExitCode
+
+      # @!attribute id
+      #
+      #   @return [String, nil]
+      optional :id, String, api_name: :ID
+
+      # @!attribute open_stderr
+      #
+      #   @return [Boolean, nil]
+      optional :open_stderr, DockerEngineAPI::Internal::Type::Boolean, api_name: :OpenStderr
+
+      # @!attribute open_stdin
+      #
+      #   @return [Boolean, nil]
+      optional :open_stdin, DockerEngineAPI::Internal::Type::Boolean, api_name: :OpenStdin
+
+      # @!attribute open_stdout
+      #
+      #   @return [Boolean, nil]
+      optional :open_stdout, DockerEngineAPI::Internal::Type::Boolean, api_name: :OpenStdout
+
+      # @!attribute pid
+      #   The system process ID for the exec process.
+      #
+      #   @return [Integer, nil]
+      optional :pid, Integer, api_name: :Pid
+
+      # @!attribute process_config
+      #
+      #   @return [DockerEngineAPI::Models::InspectResponse, nil]
+      optional :process_config, -> { DockerEngineAPI::InspectResponse }, api_name: :ProcessConfig
+
+      # @!attribute running
+      #
+      #   @return [Boolean, nil]
+      optional :running, DockerEngineAPI::Internal::Type::Boolean, api_name: :Running
+
+      # @!method initialize(can_remove: nil, container_id: nil, detach_keys: nil, exit_code: nil, id: nil, open_stderr: nil, open_stdin: nil, open_stdout: nil, pid: nil, process_config: nil, running: nil)
+      #   @param can_remove [Boolean]
+      #
+      #   @param container_id [String]
+      #
+      #   @param detach_keys [String]
+      #
+      #   @param exit_code [Integer]
+      #
+      #   @param id [String]
+      #
+      #   @param open_stderr [Boolean]
+      #
+      #   @param open_stdin [Boolean]
+      #
+      #   @param open_stdout [Boolean]
+      #
+      #   @param pid [Integer] The system process ID for the exec process.
+      #
+      #   @param process_config [DockerEngineAPI::Models::InspectResponse]
+      #
+      #   @param running [Boolean]
+    end
+  end
+end

data/lib/docker_engine_api/models/exec_resize_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Exec#resize
+    class ExecResizeParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      # @!attribute h
+      #   Height of the TTY session in characters
+      #
+      #   @return [Integer]
+      required :h, Integer
+
+      # @!attribute w
+      #   Width of the TTY session in characters
+      #
+      #   @return [Integer]
+      required :w, Integer
+
+      # @!method initialize(h:, w:, request_options: {})
+      #   @param h [Integer] Height of the TTY session in characters
+      #
+      #   @param w [Integer] Width of the TTY session in characters
+      #
+      #   @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine_api/models/exec_start_params.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Exec#start
+    class ExecStartParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      # @!attribute console_size
+      #   Initial console size, as an `[height, width]` array.
+      #
+      #   @return [Array<Integer>, nil]
+      optional :console_size,
+               DockerEngineAPI::Internal::Type::ArrayOf[Integer],
+               api_name: :ConsoleSize,
+               nil?: true
+
+      # @!attribute detach
+      #   Detach from the command.
+      #
+      #   @return [Boolean, nil]
+      optional :detach, DockerEngineAPI::Internal::Type::Boolean, api_name: :Detach
+
+      # @!attribute tty
+      #   Allocate a pseudo-TTY.
+      #
+      #   @return [Boolean, nil]
+      optional :tty, DockerEngineAPI::Internal::Type::Boolean, api_name: :Tty
+
+      # @!method initialize(console_size: nil, detach: nil, tty: nil, request_options: {})
+      #   @param console_size [Array<Integer>, nil] Initial console size, as an `[height, width]` array.
+      #
+      #   @param detach [Boolean] Detach from the command.
+      #
+      #   @param tty [Boolean] Allocate a pseudo-TTY.
+      #
+      #   @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end