docker-engine-api 0.2.1

data/lib/docker_engine_api/models/system_data_usage_response.rb

@@ -0,0 +1,260 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::System#data_usage
+    class SystemDataUsageResponse < DockerEngineAPI::Internal::Type::BaseModel
+      # @!attribute build_cache_disk_usage
+      #   represents system data usage for build cache resources.
+      #
+      #   @return [DockerEngineAPI::Models::SystemDataUsageResponse::BuildCacheDiskUsage, nil]
+      optional :build_cache_disk_usage,
+               -> { DockerEngineAPI::Models::SystemDataUsageResponse::BuildCacheDiskUsage },
+               api_name: :BuildCacheDiskUsage
+
+      # @!attribute containers_disk_usage
+      #   represents system data usage information for container resources.
+      #
+      #   @return [DockerEngineAPI::Models::SystemDataUsageResponse::ContainersDiskUsage, nil]
+      optional :containers_disk_usage,
+               -> { DockerEngineAPI::Models::SystemDataUsageResponse::ContainersDiskUsage },
+               api_name: :ContainersDiskUsage
+
+      # @!attribute images_disk_usage
+      #   represents system data usage for image resources.
+      #
+      #   @return [DockerEngineAPI::Models::SystemDataUsageResponse::ImagesDiskUsage, nil]
+      optional :images_disk_usage,
+               -> { DockerEngineAPI::Models::SystemDataUsageResponse::ImagesDiskUsage },
+               api_name: :ImagesDiskUsage
+
+      # @!attribute volumes_disk_usage
+      #   represents system data usage for volume resources.
+      #
+      #   @return [DockerEngineAPI::Models::SystemDataUsageResponse::VolumesDiskUsage, nil]
+      optional :volumes_disk_usage,
+               -> { DockerEngineAPI::Models::SystemDataUsageResponse::VolumesDiskUsage },
+               api_name: :VolumesDiskUsage
+
+      # @!method initialize(build_cache_disk_usage: nil, containers_disk_usage: nil, images_disk_usage: nil, volumes_disk_usage: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngineAPI::Models::SystemDataUsageResponse} for more details.
+      #
+      #   @param build_cache_disk_usage [DockerEngineAPI::Models::SystemDataUsageResponse::BuildCacheDiskUsage] represents system data usage for build cache resources.
+      #
+      #   @param containers_disk_usage [DockerEngineAPI::Models::SystemDataUsageResponse::ContainersDiskUsage] represents system data usage information for container resources.
+      #
+      #   @param images_disk_usage [DockerEngineAPI::Models::SystemDataUsageResponse::ImagesDiskUsage] represents system data usage for image resources.
+      #
+      #   @param volumes_disk_usage [DockerEngineAPI::Models::SystemDataUsageResponse::VolumesDiskUsage] represents system data usage for volume resources.
+
+      # @see DockerEngineAPI::Models::SystemDataUsageResponse#build_cache_disk_usage
+      class BuildCacheDiskUsage < DockerEngineAPI::Internal::Type::BaseModel
+        # @!attribute active_count
+        #   Count of active build cache records.
+        #
+        #   @return [Integer, nil]
+        optional :active_count, Integer, api_name: :ActiveCount
+
+        # @!attribute items
+        #   List of build cache records.
+        #
+        #   @return [Array<Object>, nil]
+        optional :items,
+                 DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Internal::Type::Unknown],
+                 api_name: :Items
+
+        # @!attribute reclaimable
+        #   Disk space that can be reclaimed by removing inactive build cache records.
+        #
+        #   @return [Integer, nil]
+        optional :reclaimable, Integer, api_name: :Reclaimable
+
+        # @!attribute total_count
+        #   Count of all build cache records.
+        #
+        #   @return [Integer, nil]
+        optional :total_count, Integer, api_name: :TotalCount
+
+        # @!attribute total_size
+        #   Disk space in use by build cache records.
+        #
+        #   @return [Integer, nil]
+        optional :total_size, Integer, api_name: :TotalSize
+
+        # @!method initialize(active_count: nil, items: nil, reclaimable: nil, total_count: nil, total_size: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {DockerEngineAPI::Models::SystemDataUsageResponse::BuildCacheDiskUsage} for more
+        #   details.
+        #
+        #   represents system data usage for build cache resources.
+        #
+        #   @param active_count [Integer] Count of active build cache records.
+        #
+        #   @param items [Array<Object>] List of build cache records.
+        #
+        #   @param reclaimable [Integer] Disk space that can be reclaimed by removing inactive build cache records.
+        #
+        #   @param total_count [Integer] Count of all build cache records.
+        #
+        #   @param total_size [Integer] Disk space in use by build cache records.
+      end
+
+      # @see DockerEngineAPI::Models::SystemDataUsageResponse#containers_disk_usage
+      class ContainersDiskUsage < DockerEngineAPI::Internal::Type::BaseModel
+        # @!attribute active_count
+        #   Count of active containers.
+        #
+        #   @return [Integer, nil]
+        optional :active_count, Integer, api_name: :ActiveCount
+
+        # @!attribute items
+        #   List of container summaries.
+        #
+        #   @return [Array<Object>, nil]
+        optional :items,
+                 DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Internal::Type::Unknown],
+                 api_name: :Items
+
+        # @!attribute reclaimable
+        #   Disk space that can be reclaimed by removing inactive containers.
+        #
+        #   @return [Integer, nil]
+        optional :reclaimable, Integer, api_name: :Reclaimable
+
+        # @!attribute total_count
+        #   Count of all containers.
+        #
+        #   @return [Integer, nil]
+        optional :total_count, Integer, api_name: :TotalCount
+
+        # @!attribute total_size
+        #   Disk space in use by containers.
+        #
+        #   @return [Integer, nil]
+        optional :total_size, Integer, api_name: :TotalSize
+
+        # @!method initialize(active_count: nil, items: nil, reclaimable: nil, total_count: nil, total_size: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {DockerEngineAPI::Models::SystemDataUsageResponse::ContainersDiskUsage} for more
+        #   details.
+        #
+        #   represents system data usage information for container resources.
+        #
+        #   @param active_count [Integer] Count of active containers.
+        #
+        #   @param items [Array<Object>] List of container summaries.
+        #
+        #   @param reclaimable [Integer] Disk space that can be reclaimed by removing inactive containers.
+        #
+        #   @param total_count [Integer] Count of all containers.
+        #
+        #   @param total_size [Integer] Disk space in use by containers.
+      end
+
+      # @see DockerEngineAPI::Models::SystemDataUsageResponse#images_disk_usage
+      class ImagesDiskUsage < DockerEngineAPI::Internal::Type::BaseModel
+        # @!attribute active_count
+        #   Count of active images.
+        #
+        #   @return [Integer, nil]
+        optional :active_count, Integer, api_name: :ActiveCount
+
+        # @!attribute items
+        #   List of image summaries.
+        #
+        #   @return [Array<Object>, nil]
+        optional :items,
+                 DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Internal::Type::Unknown],
+                 api_name: :Items
+
+        # @!attribute reclaimable
+        #   Disk space that can be reclaimed by removing unused images.
+        #
+        #   @return [Integer, nil]
+        optional :reclaimable, Integer, api_name: :Reclaimable
+
+        # @!attribute total_count
+        #   Count of all images.
+        #
+        #   @return [Integer, nil]
+        optional :total_count, Integer, api_name: :TotalCount
+
+        # @!attribute total_size
+        #   Disk space in use by images.
+        #
+        #   @return [Integer, nil]
+        optional :total_size, Integer, api_name: :TotalSize
+
+        # @!method initialize(active_count: nil, items: nil, reclaimable: nil, total_count: nil, total_size: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {DockerEngineAPI::Models::SystemDataUsageResponse::ImagesDiskUsage} for more
+        #   details.
+        #
+        #   represents system data usage for image resources.
+        #
+        #   @param active_count [Integer] Count of active images.
+        #
+        #   @param items [Array<Object>] List of image summaries.
+        #
+        #   @param reclaimable [Integer] Disk space that can be reclaimed by removing unused images.
+        #
+        #   @param total_count [Integer] Count of all images.
+        #
+        #   @param total_size [Integer] Disk space in use by images.
+      end
+
+      # @see DockerEngineAPI::Models::SystemDataUsageResponse#volumes_disk_usage
+      class VolumesDiskUsage < DockerEngineAPI::Internal::Type::BaseModel
+        # @!attribute active_count
+        #   Count of active volumes.
+        #
+        #   @return [Integer, nil]
+        optional :active_count, Integer, api_name: :ActiveCount
+
+        # @!attribute items
+        #   List of volumes.
+        #
+        #   @return [Array<Object>, nil]
+        optional :items,
+                 DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Internal::Type::Unknown],
+                 api_name: :Items
+
+        # @!attribute reclaimable
+        #   Disk space that can be reclaimed by removing inactive volumes.
+        #
+        #   @return [Integer, nil]
+        optional :reclaimable, Integer, api_name: :Reclaimable
+
+        # @!attribute total_count
+        #   Count of all volumes.
+        #
+        #   @return [Integer, nil]
+        optional :total_count, Integer, api_name: :TotalCount
+
+        # @!attribute total_size
+        #   Disk space in use by volumes.
+        #
+        #   @return [Integer, nil]
+        optional :total_size, Integer, api_name: :TotalSize
+
+        # @!method initialize(active_count: nil, items: nil, reclaimable: nil, total_count: nil, total_size: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {DockerEngineAPI::Models::SystemDataUsageResponse::VolumesDiskUsage} for more
+        #   details.
+        #
+        #   represents system data usage for volume resources.
+        #
+        #   @param active_count [Integer] Count of active volumes.
+        #
+        #   @param items [Array<Object>] List of volumes.
+        #
+        #   @param reclaimable [Integer] Disk space that can be reclaimed by removing inactive volumes.
+        #
+        #   @param total_count [Integer] Count of all volumes.
+        #
+        #   @param total_size [Integer] Disk space in use by volumes.
+      end
+    end
+  end
+end

data/lib/docker_engine_api/models/system_events_params.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::System#events
+    class SystemEventsParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      # @!attribute filters
+      #   A JSON encoded value of filters (a `map[string][]string`) to process on the
+      #   event list. Available filters:
+      #
+      #   - `config=<string>` config name or ID
+      #   - `container=<string>` container name or ID
+      #   - `daemon=<string>` daemon name or ID
+      #   - `event=<string>` event type
+      #   - `image=<string>` image name or ID
+      #   - `label=<string>` image or container label
+      #   - `network=<string>` network name or ID
+      #   - `node=<string>` node ID
+      #   - `plugin`=<string> plugin name or ID
+      #   - `scope`=<string> local or swarm
+      #   - `secret=<string>` secret name or ID
+      #   - `service=<string>` service name or ID
+      #   - `type=<string>` object to filter by, one of `container`, `image`, `volume`,
+      #     `network`, `daemon`, `plugin`, `node`, `service`, `secret` or `config`
+      #   - `volume=<string>` volume name
+      #
+      #   @return [String, nil]
+      optional :filters, String
+
+      # @!attribute since
+      #   Show events created since this timestamp then stream new events.
+      #
+      #   @return [String, nil]
+      optional :since, String
+
+      # @!attribute until_
+      #   Show events created until this timestamp then stop streaming.
+      #
+      #   @return [String, nil]
+      optional :until_, String
+
+      # @!method initialize(filters: nil, since: nil, until_: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngineAPI::Models::SystemEventsParams} for more details.
+      #
+      #   @param filters [String] A JSON encoded value of filters (a `map[string][]string`) to process on the even
+      #
+      #   @param since [String] Show events created since this timestamp then stream new events.
+      #
+      #   @param until_ [String] Show events created until this timestamp then stop streaming.
+      #
+      #   @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine_api/models/system_events_response.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::System#events
+    class SystemEventsResponse < DockerEngineAPI::Internal::Type::BaseModel
+      # @!attribute action
+      #   The type of event
+      #
+      #   @return [String, nil]
+      optional :action, String, api_name: :Action
+
+      # @!attribute actor
+      #   Actor describes something that generates events, like a container, network, or a
+      #   volume.
+      #
+      #   @return [DockerEngineAPI::Models::SystemEventsResponse::Actor, nil]
+      optional :actor, -> { DockerEngineAPI::Models::SystemEventsResponse::Actor }, api_name: :Actor
+
+      # @!attribute scope
+      #   Scope of the event. Engine events are `local` scope. Cluster (Swarm) events are
+      #   `swarm` scope.
+      #
+      #   @return [Symbol, DockerEngineAPI::Models::SystemEventsResponse::Scope, nil]
+      optional :scope, enum: -> { DockerEngineAPI::Models::SystemEventsResponse::Scope }
+
+      # @!attribute time
+      #   Timestamp of event
+      #
+      #   @return [Integer, nil]
+      optional :time, Integer
+
+      # @!attribute time_nano
+      #   Timestamp of event, with nanosecond accuracy
+      #
+      #   @return [Integer, nil]
+      optional :time_nano, Integer, api_name: :timeNano
+
+      # @!attribute type
+      #   The type of object emitting the event
+      #
+      #   @return [Symbol, DockerEngineAPI::Models::SystemEventsResponse::Type, nil]
+      optional :type, enum: -> { DockerEngineAPI::Models::SystemEventsResponse::Type }, api_name: :Type
+
+      # @!method initialize(action: nil, actor: nil, scope: nil, time: nil, time_nano: nil, type: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngineAPI::Models::SystemEventsResponse} for more details.
+      #
+      #   EventMessage represents the information an event contains.
+      #
+      #   @param action [String] The type of event
+      #
+      #   @param actor [DockerEngineAPI::Models::SystemEventsResponse::Actor] Actor describes something that generates events, like a container, network,
+      #
+      #   @param scope [Symbol, DockerEngineAPI::Models::SystemEventsResponse::Scope] Scope of the event. Engine events are `local` scope. Cluster (Swarm)
+      #
+      #   @param time [Integer] Timestamp of event
+      #
+      #   @param time_nano [Integer] Timestamp of event, with nanosecond accuracy
+      #
+      #   @param type [Symbol, DockerEngineAPI::Models::SystemEventsResponse::Type] The type of object emitting the event
+
+      # @see DockerEngineAPI::Models::SystemEventsResponse#actor
+      class Actor < DockerEngineAPI::Internal::Type::BaseModel
+        # @!attribute attributes
+        #   Various key/value attributes of the object, depending on its type.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :attributes, DockerEngineAPI::Internal::Type::HashOf[String], api_name: :Attributes
+
+        # @!attribute id
+        #   The ID of the object emitting the event
+        #
+        #   @return [String, nil]
+        optional :id, String, api_name: :ID
+
+        # @!method initialize(attributes: nil, id: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {DockerEngineAPI::Models::SystemEventsResponse::Actor} for more details.
+        #
+        #   Actor describes something that generates events, like a container, network, or a
+        #   volume.
+        #
+        #   @param attributes [Hash{Symbol=>String}] Various key/value attributes of the object, depending on its type.
+        #
+        #   @param id [String] The ID of the object emitting the event
+      end
+
+      # Scope of the event. Engine events are `local` scope. Cluster (Swarm) events are
+      # `swarm` scope.
+      #
+      # @see DockerEngineAPI::Models::SystemEventsResponse#scope
+      module Scope
+        extend DockerEngineAPI::Internal::Type::Enum
+
+        LOCAL = :local
+        SWARM = :swarm
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The type of object emitting the event
+      #
+      # @see DockerEngineAPI::Models::SystemEventsResponse#type
+      module Type
+        extend DockerEngineAPI::Internal::Type::Enum
+
+        BUILDER = :builder
+        CONFIG = :config
+        CONTAINER = :container
+        DAEMON = :daemon
+        IMAGE = :image
+        NETWORK = :network
+        NODE = :node
+        PLUGIN = :plugin
+        SECRET = :secret
+        SERVICE = :service
+        VOLUME = :volume
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/docker_engine_api/models/system_info_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::System#info
+    class SystemInfoParams < 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/system_ping_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::System#ping
+    class SystemPingParams < 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/system_ping_response.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    SystemPingResponse = String
+  end
+end

data/lib/docker_engine_api/models/system_version_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::System#version
+    class SystemVersionParams < 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