docker-engine-api 0.2.1

data/lib/docker_engine_api/models/volume_delete_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Volumes#delete
+    class VolumeDeleteParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      # @!attribute force
+      #   Force the removal of the volume
+      #
+      #   @return [Boolean, nil]
+      optional :force, DockerEngineAPI::Internal::Type::Boolean
+
+      # @!method initialize(force: nil, request_options: {})
+      #   @param force [Boolean] Force the removal of the volume
+      #
+      #   @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine_api/models/volume_inspect_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Volumes#inspect_
+    class VolumeInspectParams < 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/volume_list_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Volumes#list
+    class VolumeListParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      # @!attribute filters
+      #   JSON encoded value of the filters (a `map[string][]string`) to process on the
+      #   volumes list. Available filters:
+      #
+      #   - `dangling=<boolean>` When set to `true` (or `1`), returns all volumes that are
+      #     not in use by a container. When set to `false` (or `0`), only volumes that are
+      #     in use by one or more containers are returned.
+      #   - `driver=<volume-driver-name>` Matches volumes based on their driver.
+      #   - `label=<key>` or `label=<key>:<value>` Matches volumes based on the presence
+      #     of a `label` alone or a `label` and a value.
+      #   - `name=<volume-name>` Matches all or part of a volume name.
+      #
+      #   @return [String, nil]
+      optional :filters, String
+
+      # @!method initialize(filters: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngineAPI::Models::VolumeListParams} for more details.
+      #
+      #   @param filters [String] JSON encoded value of the filters (a `map[string][]string`) to
+      #
+      #   @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine_api/models/volume_prune_params.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Volumes#prune
+    class VolumePruneParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      # @!attribute filters
+      #   Filters to process on the prune list, encoded as JSON (a `map[string][]string`).
+      #
+      #   Available filters:
+      #
+      #   - `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or
+      #     `label!=<key>=<value>`) Prune volumes with (or without, in case `label!=...`
+      #     is used) the specified labels.
+      #   - `all` (`all=true`) - Consider all (local) volumes for pruning and not just
+      #     anonymous volumes.
+      #
+      #   @return [String, nil]
+      optional :filters, String
+
+      # @!method initialize(filters: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngineAPI::Models::VolumePruneParams} for more details.
+      #
+      #   @param filters [String] Filters to process on the prune list, encoded as JSON (a `map[string][]string`).
+      #
+      #   @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine_api/models/volume_prune_response.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Volumes#prune
+    class VolumePruneResponse < DockerEngineAPI::Internal::Type::BaseModel
+      # @!attribute space_reclaimed
+      #   Disk space reclaimed in bytes
+      #
+      #   @return [Integer, nil]
+      optional :space_reclaimed, Integer, api_name: :SpaceReclaimed
+
+      # @!attribute volumes_deleted
+      #   Volumes that were deleted
+      #
+      #   @return [Array<String>, nil]
+      optional :volumes_deleted, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :VolumesDeleted
+
+      # @!method initialize(space_reclaimed: nil, volumes_deleted: nil)
+      #   @param space_reclaimed [Integer] Disk space reclaimed in bytes
+      #
+      #   @param volumes_deleted [Array<String>] Volumes that were deleted
+    end
+  end
+end

data/lib/docker_engine_api/models/volume_update_params.rb

@@ -0,0 +1,325 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Volumes#update
+    class VolumeUpdateParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      # @!attribute version
+      #   The version number of the volume being updated. This is required to avoid
+      #   conflicting writes. Found in the volume's `ClusterVolume` field.
+      #
+      #   @return [Integer]
+      required :version, Integer
+
+      # @!attribute spec
+      #   Cluster-specific options used to create the volume.
+      #
+      #   @return [DockerEngineAPI::Models::VolumeUpdateParams::Spec, nil]
+      optional :spec, -> { DockerEngineAPI::VolumeUpdateParams::Spec }, api_name: :Spec
+
+      # @!method initialize(version:, spec: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngineAPI::Models::VolumeUpdateParams} for more details.
+      #
+      #   @param version [Integer] The version number of the volume being updated. This is required to
+      #
+      #   @param spec [DockerEngineAPI::Models::VolumeUpdateParams::Spec] Cluster-specific options used to create the volume.
+      #
+      #   @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
+
+      class Spec < DockerEngineAPI::Internal::Type::BaseModel
+        # @!attribute access_mode
+        #   Defines how the volume is used by tasks.
+        #
+        #   @return [DockerEngineAPI::Models::VolumeUpdateParams::Spec::AccessMode, nil]
+        optional :access_mode,
+                 -> {
+                   DockerEngineAPI::VolumeUpdateParams::Spec::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::VolumeUpdateParams::Spec} for more details.
+        #
+        #   Cluster-specific options used to create the volume.
+        #
+        #   @param access_mode [DockerEngineAPI::Models::VolumeUpdateParams::Spec::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::VolumeUpdateParams::Spec#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::VolumeUpdateParams::Spec::AccessMode::AccessibilityRequirements, nil]
+          optional :accessibility_requirements,
+                   -> { DockerEngineAPI::VolumeUpdateParams::Spec::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::VolumeUpdateParams::Spec::AccessMode::Availability, nil]
+          optional :availability,
+                   enum: -> { DockerEngineAPI::VolumeUpdateParams::Spec::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::VolumeUpdateParams::Spec::AccessMode::CapacityRange, nil]
+          optional :capacity_range,
+                   -> { DockerEngineAPI::VolumeUpdateParams::Spec::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::VolumeUpdateParams::Spec::AccessMode::Scope, nil]
+          optional :scope,
+                   enum: -> { DockerEngineAPI::VolumeUpdateParams::Spec::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::VolumeUpdateParams::Spec::AccessMode::Secret>, nil]
+          optional :secrets,
+                   -> {
+                     DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::VolumeUpdateParams::Spec::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::VolumeUpdateParams::Spec::AccessMode::Sharing, nil]
+          optional :sharing,
+                   enum: -> { DockerEngineAPI::VolumeUpdateParams::Spec::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::VolumeUpdateParams::Spec::AccessMode} for more
+          #   details.
+          #
+          #   Defines how the volume is used by tasks.
+          #
+          #   @param accessibility_requirements [DockerEngineAPI::Models::VolumeUpdateParams::Spec::AccessMode::AccessibilityRequirements] Requirements for the accessible topology of the volume. These
+          #
+          #   @param availability [Symbol, DockerEngineAPI::Models::VolumeUpdateParams::Spec::AccessMode::Availability] The availability of the volume for use in tasks.
+          #
+          #   @param capacity_range [DockerEngineAPI::Models::VolumeUpdateParams::Spec::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::VolumeUpdateParams::Spec::AccessMode::Scope] The set of nodes this volume can be used on at one time.
+          #
+          #   @param secrets [Array<DockerEngineAPI::Models::VolumeUpdateParams::Spec::AccessMode::Secret>] Swarm Secrets that are passed to the CSI storage plugin when
+          #
+          #   @param sharing [Symbol, DockerEngineAPI::Models::VolumeUpdateParams::Spec::AccessMode::Sharing] The number and way that different tasks can use this volume
+
+          # @see DockerEngineAPI::Models::VolumeUpdateParams::Spec::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::VolumeUpdateParams::Spec::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::VolumeUpdateParams::Spec::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::VolumeUpdateParams::Spec::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::VolumeUpdateParams::Spec::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::VolumeUpdateParams::Spec::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::VolumeUpdateParams::Spec::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::VolumeUpdateParams::Spec::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/wait_response.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Containers#wait
+    class WaitResponse < DockerEngineAPI::Internal::Type::BaseModel
+      # @!attribute status_code
+      #   Exit code of the container
+      #
+      #   @return [Integer]
+      required :status_code, Integer, api_name: :StatusCode
+
+      # @!attribute error
+      #   container waiting error, if any
+      #
+      #   @return [DockerEngineAPI::Models::WaitResponse::Error, nil]
+      optional :error, -> { DockerEngineAPI::WaitResponse::Error }, api_name: :Error
+
+      # @!method initialize(status_code:, error: nil)
+      #   OK response to ContainerWait operation
+      #
+      #   @param status_code [Integer] Exit code of the container
+      #
+      #   @param error [DockerEngineAPI::Models::WaitResponse::Error] container waiting error, if any
+
+      # @see DockerEngineAPI::Models::WaitResponse#error
+      class Error < DockerEngineAPI::Internal::Type::BaseModel
+        # @!attribute message
+        #   Details of an error
+        #
+        #   @return [String, nil]
+        optional :message, String, api_name: :Message
+
+        # @!method initialize(message: nil)
+        #   container waiting error, if any
+        #
+        #   @param message [String] Details of an error
+      end
+    end
+  end
+end