docker-engine-ruby 0.2.2 → 0.3.0

data/lib/docker_engine_ruby/models/stats_response.rb

@@ -20,13 +20,13 @@ module DockerEngineRuby
       #   This type is only populated on Linux and omitted for Windows containers.
       #
       #   @return [DockerEngineRuby::Models::StatsResponse::BlkioStats, nil]
-      optional :blkio_stats, -> { DockerEngineRuby::StatsResponse::BlkioStats }, nil?: true
+      optional :blkio_stats, -> { DockerEngineRuby::StatsResponse::BlkioStats }
 
       # @!attribute cpu_stats
       #   CPU related info of the container
       #
       #   @return [DockerEngineRuby::Models::StatsResponse::CPUStats, nil]
-      optional :cpu_stats, -> { DockerEngineRuby::StatsResponse::CPUStats }, nil?: true
+      optional :cpu_stats, -> { DockerEngineRuby::StatsResponse::CPUStats }
 
       # @!attribute memory_stats
       #   Aggregates all memory stats since container inception on Linux. Windows returns
@@ -46,8 +46,10 @@ module DockerEngineRuby
       #
       #   This field is omitted if the container has no networking enabled.
       #
-      #   @return [Object, nil]
-      optional :networks, DockerEngineRuby::Internal::Type::Unknown, nil?: true
+      #   @return [Hash{Symbol=>DockerEngineRuby::Models::StatsResponse::Network}, nil]
+      optional :networks,
+               -> { DockerEngineRuby::Internal::Type::HashOf[DockerEngineRuby::StatsResponse::Network] },
+               nil?: true
 
       # @!attribute num_procs
       #   The number of processors on the system.
@@ -70,13 +72,13 @@ module DockerEngineRuby
       #   This type is Linux-specific and omitted for Windows containers.
       #
       #   @return [DockerEngineRuby::Models::StatsResponse::PidsStats, nil]
-      optional :pids_stats, -> { DockerEngineRuby::StatsResponse::PidsStats }, nil?: true
+      optional :pids_stats, -> { DockerEngineRuby::StatsResponse::PidsStats }
 
       # @!attribute precpu_stats
       #   CPU related info of the container
       #
       #   @return [DockerEngineRuby::Models::StatsResponse::PrecpuStats, nil]
-      optional :precpu_stats, -> { DockerEngineRuby::StatsResponse::PrecpuStats }, nil?: true
+      optional :precpu_stats, -> { DockerEngineRuby::StatsResponse::PrecpuStats }
 
       # @!attribute preread
       #   Date and time at which this first sample was collected. This field is not
@@ -103,7 +105,7 @@ module DockerEngineRuby
       #   This type is Windows-specific and omitted for Linux containers.
       #
       #   @return [DockerEngineRuby::Models::StatsResponse::StorageStats, nil]
-      optional :storage_stats, -> { DockerEngineRuby::StatsResponse::StorageStats }, nil?: true
+      optional :storage_stats, -> { DockerEngineRuby::StatsResponse::StorageStats }
 
       # @!method initialize(id: nil, blkio_stats: nil, cpu_stats: nil, memory_stats: nil, name: nil, networks: nil, num_procs: nil, os_type: nil, pids_stats: nil, precpu_stats: nil, preread: nil, read: nil, storage_stats: nil)
       #   Some parameter documentations has been truncated, see
@@ -113,29 +115,29 @@ module DockerEngineRuby
       #
       #   @param id [String, nil] ID of the container for which the stats were collected.
       #
-      #   @param blkio_stats [DockerEngineRuby::Models::StatsResponse::BlkioStats, nil] BlkioStats stores all IO service stats for data read and write.
+      #   @param blkio_stats [DockerEngineRuby::Models::StatsResponse::BlkioStats] BlkioStats stores all IO service stats for data read and write.
       #
-      #   @param cpu_stats [DockerEngineRuby::Models::StatsResponse::CPUStats, nil] CPU related info of the container
+      #   @param cpu_stats [DockerEngineRuby::Models::StatsResponse::CPUStats] CPU related info of the container
       #
       #   @param memory_stats [DockerEngineRuby::Models::StatsResponse::MemoryStats] Aggregates all memory stats since container inception on Linux.
       #
       #   @param name [String, nil] Name of the container for which the stats were collected.
       #
-      #   @param networks [Object, nil] Network statistics for the container per interface.
+      #   @param networks [Hash{Symbol=>DockerEngineRuby::Models::StatsResponse::Network}, nil] Network statistics for the container per interface.
       #
       #   @param num_procs [Integer] The number of processors on the system.
       #
       #   @param os_type [String, nil] OSType is the OS of the container ("linux" or "windows") to allow
       #
-      #   @param pids_stats [DockerEngineRuby::Models::StatsResponse::PidsStats, nil] PidsStats contains Linux-specific stats of a container's process-IDs (PIDs).
+      #   @param pids_stats [DockerEngineRuby::Models::StatsResponse::PidsStats] PidsStats contains Linux-specific stats of a container's process-IDs (PIDs).
       #
-      #   @param precpu_stats [DockerEngineRuby::Models::StatsResponse::PrecpuStats, nil] CPU related info of the container
+      #   @param precpu_stats [DockerEngineRuby::Models::StatsResponse::PrecpuStats] CPU related info of the container
       #
       #   @param preread [Time] Date and time at which this first sample was collected. This field
       #
       #   @param read [Time] Date and time at which this sample was collected.
       #
-      #   @param storage_stats [DockerEngineRuby::Models::StatsResponse::StorageStats, nil] StorageStats is the disk I/O stats for read/write on Windows.
+      #   @param storage_stats [DockerEngineRuby::Models::StatsResponse::StorageStats] StorageStats is the disk I/O stats for read/write on Windows.
 
       # @see DockerEngineRuby::Models::StatsResponse#blkio_stats
       class BlkioStats < DockerEngineRuby::Internal::Type::BaseModel
@@ -143,11 +145,10 @@ module DockerEngineRuby
         #   This field is only available when using Linux containers with cgroups v1. It is
         #   omitted or `null` when using cgroups v2.
         #
-        #   @return [Array<DockerEngineRuby::Models::StatsResponse::BlkioStats::IoMergedRecursive, nil>, nil]
+        #   @return [Array<DockerEngineRuby::Models::StatsResponse::BlkioStats::IoMergedRecursive>, nil]
         optional :io_merged_recursive,
                  -> {
-                   DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::StatsResponse::BlkioStats::IoMergedRecursive,
-                                                             nil?: true]
+                   DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::StatsResponse::BlkioStats::IoMergedRecursive]
                  },
                  nil?: true
 
@@ -155,29 +156,27 @@ module DockerEngineRuby
         #   This field is only available when using Linux containers with cgroups v1. It is
         #   omitted or `null` when using cgroups v2.
         #
-        #   @return [Array<DockerEngineRuby::Models::StatsResponse::BlkioStats::IoQueueRecursive, nil>, nil]
+        #   @return [Array<DockerEngineRuby::Models::StatsResponse::BlkioStats::IoQueueRecursive>, nil]
         optional :io_queue_recursive,
                  -> {
-                   DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::StatsResponse::BlkioStats::IoQueueRecursive,
-                                                             nil?: true]
+                   DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::StatsResponse::BlkioStats::IoQueueRecursive]
                  },
                  nil?: true
 
         # @!attribute io_service_bytes_recursive
         #
-        #   @return [Array<DockerEngineRuby::Models::StatsResponse::BlkioStats::IoServiceBytesRecursive, nil>, nil]
+        #   @return [Array<DockerEngineRuby::Models::StatsResponse::BlkioStats::IoServiceBytesRecursive>, nil]
         optional :io_service_bytes_recursive,
-                 -> { DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::StatsResponse::BlkioStats::IoServiceBytesRecursive, nil?: true] }
+                 -> { DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::StatsResponse::BlkioStats::IoServiceBytesRecursive] }
 
         # @!attribute io_service_time_recursive
         #   This field is only available when using Linux containers with cgroups v1. It is
         #   omitted or `null` when using cgroups v2.
         #
-        #   @return [Array<DockerEngineRuby::Models::StatsResponse::BlkioStats::IoServiceTimeRecursive, nil>, nil]
+        #   @return [Array<DockerEngineRuby::Models::StatsResponse::BlkioStats::IoServiceTimeRecursive>, nil]
         optional :io_service_time_recursive,
                  -> {
-                   DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::StatsResponse::BlkioStats::IoServiceTimeRecursive,
-                                                             nil?: true]
+                   DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::StatsResponse::BlkioStats::IoServiceTimeRecursive]
                  },
                  nil?: true
 
@@ -185,11 +184,10 @@ module DockerEngineRuby
         #   This field is only available when using Linux containers with cgroups v1. It is
         #   omitted or `null` when using cgroups v2.
         #
-        #   @return [Array<DockerEngineRuby::Models::StatsResponse::BlkioStats::IoServicedRecursive, nil>, nil]
+        #   @return [Array<DockerEngineRuby::Models::StatsResponse::BlkioStats::IoServicedRecursive>, nil]
         optional :io_serviced_recursive,
                  -> {
-                   DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::StatsResponse::BlkioStats::IoServicedRecursive,
-                                                             nil?: true]
+                   DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::StatsResponse::BlkioStats::IoServicedRecursive]
                  },
                  nil?: true
 
@@ -197,11 +195,10 @@ module DockerEngineRuby
         #   This field is only available when using Linux containers with cgroups v1. It is
         #   omitted or `null` when using cgroups v2.
         #
-        #   @return [Array<DockerEngineRuby::Models::StatsResponse::BlkioStats::IoTimeRecursive, nil>, nil]
+        #   @return [Array<DockerEngineRuby::Models::StatsResponse::BlkioStats::IoTimeRecursive>, nil]
         optional :io_time_recursive,
                  -> {
-                   DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::StatsResponse::BlkioStats::IoTimeRecursive,
-                                                             nil?: true]
+                   DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::StatsResponse::BlkioStats::IoTimeRecursive]
                  },
                  nil?: true
 
@@ -209,11 +206,10 @@ module DockerEngineRuby
         #   This field is only available when using Linux containers with cgroups v1. It is
         #   omitted or `null` when using cgroups v2.
         #
-        #   @return [Array<DockerEngineRuby::Models::StatsResponse::BlkioStats::IoWaitTimeRecursive, nil>, nil]
+        #   @return [Array<DockerEngineRuby::Models::StatsResponse::BlkioStats::IoWaitTimeRecursive>, nil]
         optional :io_wait_time_recursive,
                  -> {
-                   DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::StatsResponse::BlkioStats::IoWaitTimeRecursive,
-                                                             nil?: true]
+                   DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::StatsResponse::BlkioStats::IoWaitTimeRecursive]
                  },
                  nil?: true
 
@@ -221,11 +217,10 @@ module DockerEngineRuby
         #   This field is only available when using Linux containers with cgroups v1. It is
         #   omitted or `null` when using cgroups v2.
         #
-        #   @return [Array<DockerEngineRuby::Models::StatsResponse::BlkioStats::SectorsRecursive, nil>, nil]
+        #   @return [Array<DockerEngineRuby::Models::StatsResponse::BlkioStats::SectorsRecursive>, nil]
         optional :sectors_recursive,
                  -> {
-                   DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::StatsResponse::BlkioStats::SectorsRecursive,
-                                                             nil?: true]
+                   DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::StatsResponse::BlkioStats::SectorsRecursive]
                  },
                  nil?: true
 
@@ -241,21 +236,21 @@ module DockerEngineRuby
         #
         #   This type is only populated on Linux and omitted for Windows containers.
         #
-        #   @param io_merged_recursive [Array<DockerEngineRuby::Models::StatsResponse::BlkioStats::IoMergedRecursive, nil>, nil] This field is only available when using Linux containers with
+        #   @param io_merged_recursive [Array<DockerEngineRuby::Models::StatsResponse::BlkioStats::IoMergedRecursive>, nil] This field is only available when using Linux containers with
         #
-        #   @param io_queue_recursive [Array<DockerEngineRuby::Models::StatsResponse::BlkioStats::IoQueueRecursive, nil>, nil] This field is only available when using Linux containers with
+        #   @param io_queue_recursive [Array<DockerEngineRuby::Models::StatsResponse::BlkioStats::IoQueueRecursive>, nil] This field is only available when using Linux containers with
         #
-        #   @param io_service_bytes_recursive [Array<DockerEngineRuby::Models::StatsResponse::BlkioStats::IoServiceBytesRecursive, nil>]
+        #   @param io_service_bytes_recursive [Array<DockerEngineRuby::Models::StatsResponse::BlkioStats::IoServiceBytesRecursive>]
         #
-        #   @param io_service_time_recursive [Array<DockerEngineRuby::Models::StatsResponse::BlkioStats::IoServiceTimeRecursive, nil>, nil] This field is only available when using Linux containers with
+        #   @param io_service_time_recursive [Array<DockerEngineRuby::Models::StatsResponse::BlkioStats::IoServiceTimeRecursive>, nil] This field is only available when using Linux containers with
         #
-        #   @param io_serviced_recursive [Array<DockerEngineRuby::Models::StatsResponse::BlkioStats::IoServicedRecursive, nil>, nil] This field is only available when using Linux containers with
+        #   @param io_serviced_recursive [Array<DockerEngineRuby::Models::StatsResponse::BlkioStats::IoServicedRecursive>, nil] This field is only available when using Linux containers with
         #
-        #   @param io_time_recursive [Array<DockerEngineRuby::Models::StatsResponse::BlkioStats::IoTimeRecursive, nil>, nil] This field is only available when using Linux containers with
+        #   @param io_time_recursive [Array<DockerEngineRuby::Models::StatsResponse::BlkioStats::IoTimeRecursive>, nil] This field is only available when using Linux containers with
         #
-        #   @param io_wait_time_recursive [Array<DockerEngineRuby::Models::StatsResponse::BlkioStats::IoWaitTimeRecursive, nil>, nil] This field is only available when using Linux containers with
+        #   @param io_wait_time_recursive [Array<DockerEngineRuby::Models::StatsResponse::BlkioStats::IoWaitTimeRecursive>, nil] This field is only available when using Linux containers with
         #
-        #   @param sectors_recursive [Array<DockerEngineRuby::Models::StatsResponse::BlkioStats::SectorsRecursive, nil>, nil] This field is only available when using Linux containers with
+        #   @param sectors_recursive [Array<DockerEngineRuby::Models::StatsResponse::BlkioStats::SectorsRecursive>, nil] This field is only available when using Linux containers with
 
         class IoMergedRecursive < DockerEngineRuby::Internal::Type::BaseModel
           # @!attribute major
@@ -520,7 +515,7 @@ module DockerEngineRuby
         #   All CPU stats aggregated since container inception.
         #
         #   @return [DockerEngineRuby::Models::StatsResponse::CPUStats::CPUUsage, nil]
-        optional :cpu_usage, -> { DockerEngineRuby::StatsResponse::CPUStats::CPUUsage }, nil?: true
+        optional :cpu_usage, -> { DockerEngineRuby::StatsResponse::CPUStats::CPUUsage }
 
         # @!attribute online_cpus
         #   Number of online CPUs.
@@ -544,11 +539,7 @@ module DockerEngineRuby
         #   This type is Linux-specific and omitted for Windows containers.
         #
         #   @return [DockerEngineRuby::Models::StatsResponse::CPUStats::ThrottlingData, nil]
-        optional :throttling_data,
-                 -> {
-                   DockerEngineRuby::StatsResponse::CPUStats::ThrottlingData
-                 },
-                 nil?: true
+        optional :throttling_data, -> { DockerEngineRuby::StatsResponse::CPUStats::ThrottlingData }
 
         # @!method initialize(cpu_usage: nil, online_cpus: nil, system_cpu_usage: nil, throttling_data: nil)
         #   Some parameter documentations has been truncated, see
@@ -556,13 +547,13 @@ module DockerEngineRuby
         #
         #   CPU related info of the container
         #
-        #   @param cpu_usage [DockerEngineRuby::Models::StatsResponse::CPUStats::CPUUsage, nil] All CPU stats aggregated since container inception.
+        #   @param cpu_usage [DockerEngineRuby::Models::StatsResponse::CPUStats::CPUUsage] All CPU stats aggregated since container inception.
         #
         #   @param online_cpus [Integer, nil] Number of online CPUs.
         #
         #   @param system_cpu_usage [Integer, nil] System Usage.
         #
-        #   @param throttling_data [DockerEngineRuby::Models::StatsResponse::CPUStats::ThrottlingData, nil] CPU throttling stats of the container.
+        #   @param throttling_data [DockerEngineRuby::Models::StatsResponse::CPUStats::ThrottlingData] CPU throttling stats of the container.
 
         # @see DockerEngineRuby::Models::StatsResponse::CPUStats#cpu_usage
         class CPUUsage < DockerEngineRuby::Internal::Type::BaseModel
@@ -638,10 +629,6 @@ module DockerEngineRuby
           optional :throttled_time, Integer
 
           # @!method initialize(periods: nil, throttled_periods: nil, throttled_time: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {DockerEngineRuby::Models::StatsResponse::CPUStats::ThrottlingData} for more
-          #   details.
-          #
           #   CPU throttling stats of the container.
           #
           #   This type is Linux-specific and omitted for Windows containers.
@@ -748,6 +735,102 @@ module DockerEngineRuby
         #   @param usage [Integer, nil] Current `res_counter` usage for memory.
       end
 
+      class Network < DockerEngineRuby::Internal::Type::BaseModel
+        # @!attribute endpoint_id
+        #   Endpoint ID. Not used on Linux.
+        #
+        #   This field is Windows-specific and omitted for Linux containers.
+        #
+        #   @return [String, nil]
+        optional :endpoint_id, String, nil?: true
+
+        # @!attribute instance_id
+        #   Instance ID. Not used on Linux.
+        #
+        #   This field is Windows-specific and omitted for Linux containers.
+        #
+        #   @return [String, nil]
+        optional :instance_id, String, nil?: true
+
+        # @!attribute rx_bytes
+        #   Bytes received. Windows and Linux.
+        #
+        #   @return [Integer, nil]
+        optional :rx_bytes, Integer
+
+        # @!attribute rx_dropped
+        #   Incoming packets dropped. Windows and Linux.
+        #
+        #   @return [Integer, nil]
+        optional :rx_dropped, Integer
+
+        # @!attribute rx_errors
+        #   Received errors. Not used on Windows.
+        #
+        #   This field is Linux-specific and always zero for Windows containers.
+        #
+        #   @return [Integer, nil]
+        optional :rx_errors, Integer
+
+        # @!attribute rx_packets
+        #   Packets received. Windows and Linux.
+        #
+        #   @return [Integer, nil]
+        optional :rx_packets, Integer
+
+        # @!attribute tx_bytes
+        #   Bytes sent. Windows and Linux.
+        #
+        #   @return [Integer, nil]
+        optional :tx_bytes, Integer
+
+        # @!attribute tx_dropped
+        #   Outgoing packets dropped. Windows and Linux.
+        #
+        #   @return [Integer, nil]
+        optional :tx_dropped, Integer
+
+        # @!attribute tx_errors
+        #   Sent errors. Not used on Windows.
+        #
+        #   This field is Linux-specific and always zero for Windows containers.
+        #
+        #   @return [Integer, nil]
+        optional :tx_errors, Integer
+
+        # @!attribute tx_packets
+        #   Packets sent. Windows and Linux.
+        #
+        #   @return [Integer, nil]
+        optional :tx_packets, Integer
+
+        # @!method initialize(endpoint_id: nil, instance_id: nil, rx_bytes: nil, rx_dropped: nil, rx_errors: nil, rx_packets: nil, tx_bytes: nil, tx_dropped: nil, tx_errors: nil, tx_packets: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {DockerEngineRuby::Models::StatsResponse::Network} for more details.
+        #
+        #   Aggregates the network stats of one container
+        #
+        #   @param endpoint_id [String, nil] Endpoint ID. Not used on Linux.
+        #
+        #   @param instance_id [String, nil] Instance ID. Not used on Linux.
+        #
+        #   @param rx_bytes [Integer] Bytes received. Windows and Linux.
+        #
+        #   @param rx_dropped [Integer] Incoming packets dropped. Windows and Linux.
+        #
+        #   @param rx_errors [Integer] Received errors. Not used on Windows.
+        #
+        #   @param rx_packets [Integer] Packets received. Windows and Linux.
+        #
+        #   @param tx_bytes [Integer] Bytes sent. Windows and Linux.
+        #
+        #   @param tx_dropped [Integer] Outgoing packets dropped. Windows and Linux.
+        #
+        #   @param tx_errors [Integer] Sent errors. Not used on Windows.
+        #
+        #   @param tx_packets [Integer] Packets sent. Windows and Linux.
+      end
+
       # @see DockerEngineRuby::Models::StatsResponse#pids_stats
       class PidsStats < DockerEngineRuby::Internal::Type::BaseModel
         # @!attribute current
@@ -782,7 +865,7 @@ module DockerEngineRuby
         #   All CPU stats aggregated since container inception.
         #
         #   @return [DockerEngineRuby::Models::StatsResponse::PrecpuStats::CPUUsage, nil]
-        optional :cpu_usage, -> { DockerEngineRuby::StatsResponse::PrecpuStats::CPUUsage }, nil?: true
+        optional :cpu_usage, -> { DockerEngineRuby::StatsResponse::PrecpuStats::CPUUsage }
 
         # @!attribute online_cpus
         #   Number of online CPUs.
@@ -806,11 +889,7 @@ module DockerEngineRuby
         #   This type is Linux-specific and omitted for Windows containers.
         #
         #   @return [DockerEngineRuby::Models::StatsResponse::PrecpuStats::ThrottlingData, nil]
-        optional :throttling_data,
-                 -> {
-                   DockerEngineRuby::StatsResponse::PrecpuStats::ThrottlingData
-                 },
-                 nil?: true
+        optional :throttling_data, -> { DockerEngineRuby::StatsResponse::PrecpuStats::ThrottlingData }
 
         # @!method initialize(cpu_usage: nil, online_cpus: nil, system_cpu_usage: nil, throttling_data: nil)
         #   Some parameter documentations has been truncated, see
@@ -818,13 +897,13 @@ module DockerEngineRuby
         #
         #   CPU related info of the container
         #
-        #   @param cpu_usage [DockerEngineRuby::Models::StatsResponse::PrecpuStats::CPUUsage, nil] All CPU stats aggregated since container inception.
+        #   @param cpu_usage [DockerEngineRuby::Models::StatsResponse::PrecpuStats::CPUUsage] All CPU stats aggregated since container inception.
         #
         #   @param online_cpus [Integer, nil] Number of online CPUs.
         #
         #   @param system_cpu_usage [Integer, nil] System Usage.
         #
-        #   @param throttling_data [DockerEngineRuby::Models::StatsResponse::PrecpuStats::ThrottlingData, nil] CPU throttling stats of the container.
+        #   @param throttling_data [DockerEngineRuby::Models::StatsResponse::PrecpuStats::ThrottlingData] CPU throttling stats of the container.
 
         # @see DockerEngineRuby::Models::StatsResponse::PrecpuStats#cpu_usage
         class CPUUsage < DockerEngineRuby::Internal::Type::BaseModel
@@ -901,10 +980,6 @@ module DockerEngineRuby
           optional :throttled_time, Integer
 
           # @!method initialize(periods: nil, throttled_periods: nil, throttled_time: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {DockerEngineRuby::Models::StatsResponse::PrecpuStats::ThrottlingData} for more
-          #   details.
-          #
           #   CPU throttling stats of the container.
           #
           #   This type is Linux-specific and omitted for Windows containers.

data/lib/docker_engine_ruby/models/summary.rb

@@ -72,7 +72,8 @@ module DockerEngineRuby
       #   @return [DockerEngineRuby::Models::Summary::ImageManifestDescriptor, nil]
       optional :image_manifest_descriptor,
                -> { DockerEngineRuby::Summary::ImageManifestDescriptor },
-               api_name: :ImageManifestDescriptor
+               api_name: :ImageManifestDescriptor,
+               nil?: true
 
       # @!attribute labels
       #   User-defined key/value metadata.
@@ -164,7 +165,7 @@ module DockerEngineRuby
       #
       #   @param image_id [String] The ID (digest) of the image that this container was created from.
       #
-      #   @param image_manifest_descriptor [DockerEngineRuby::Models::Summary::ImageManifestDescriptor] A descriptor struct containing digest, media type, and size, as defined in
+      #   @param image_manifest_descriptor [DockerEngineRuby::Models::Summary::ImageManifestDescriptor, nil] A descriptor struct containing digest, media type, and size, as defined in
       #
       #   @param labels [Hash{Symbol=>String}] User-defined key/value metadata.
       #
@@ -187,13 +188,11 @@ module DockerEngineRuby
       # @see DockerEngineRuby::Models::Summary#health
       class Health < DockerEngineRuby::Internal::Type::BaseModel
         # @!attribute failing_streak
-        #   FailingStreak is the number of consecutive failures
         #
         #   @return [Integer, nil]
         optional :failing_streak, Integer, api_name: :FailingStreak
 
         # @!attribute status
-        #   the health status of the container
         #
         #   @return [Symbol, DockerEngineRuby::Models::Summary::Health::Status, nil]
         optional :status, enum: -> { DockerEngineRuby::Summary::Health::Status }, api_name: :Status
@@ -205,12 +204,9 @@ module DockerEngineRuby
         #   After this attribute introduced, it includes containers with no health checks
         #   configured, or containers that are not running with none
         #
-        #   @param failing_streak [Integer] FailingStreak is the number of consecutive failures
-        #
-        #   @param status [Symbol, DockerEngineRuby::Models::Summary::Health::Status] the health status of the container
+        #   @param failing_streak [Integer]
+        #   @param status [Symbol, DockerEngineRuby::Models::Summary::Health::Status]
 
-        # the health status of the container
-        #
         # @see DockerEngineRuby::Models::Summary::Health#status
         module Status
           extend DockerEngineRuby::Internal::Type::Enum
@@ -228,7 +224,6 @@ module DockerEngineRuby
       # @see DockerEngineRuby::Models::Summary#host_config
       class HostConfig < DockerEngineRuby::Internal::Type::BaseModel
         # @!attribute annotations
-        #   Arbitrary key-value metadata attached to the container.
         #
         #   @return [Hash{Symbol=>String}, nil]
         optional :annotations,
@@ -237,27 +232,17 @@ module DockerEngineRuby
                  nil?: true
 
         # @!attribute network_mode
-        #   Networking mode (`host`, `none`, `container:<id>`) or name of the primary
-        #   network the container is using.
-        #
-        #   This field is primarily for backward compatibility. The container can be
-        #   connected to multiple networks for which information can be found in the
-        #   `NetworkSettings.Networks` field, which enumerates settings per network.
         #
         #   @return [String, nil]
         optional :network_mode, String, api_name: :NetworkMode
 
         # @!method initialize(annotations: nil, network_mode: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {DockerEngineRuby::Models::Summary::HostConfig} for more details.
-        #
         #   Summary of host-specific runtime information of the container. This is a reduced
         #   set of information in the container's "HostConfig" as available in the container
         #   "inspect" response.
         #
-        #   @param annotations [Hash{Symbol=>String}, nil] Arbitrary key-value metadata attached to the container.
-        #
-        #   @param network_mode [String] Networking mode (`host`, `none`, `container:<id>`) or name of the
+        #   @param annotations [Hash{Symbol=>String}, nil]
+        #   @param network_mode [String]
       end
 
       # @see DockerEngineRuby::Models::Summary#image_manifest_descriptor
@@ -300,7 +285,7 @@ module DockerEngineRuby
         #   [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
         #
         #   @return [DockerEngineRuby::Models::Summary::ImageManifestDescriptor::Platform, nil]
-        optional :platform, -> { DockerEngineRuby::Summary::ImageManifestDescriptor::Platform }, nil?: true
+        optional :platform, -> { DockerEngineRuby::Summary::ImageManifestDescriptor::Platform }
 
         # @!attribute size
         #   The size in bytes of the blob.
@@ -331,7 +316,7 @@ module DockerEngineRuby
         #
         #   @param media_type [String] The media type of the object this schema refers to.
         #
-        #   @param platform [DockerEngineRuby::Models::Summary::ImageManifestDescriptor::Platform, nil] Describes the platform which the image in the manifest runs on, as defined
+        #   @param platform [DockerEngineRuby::Models::Summary::ImageManifestDescriptor::Platform] Describes the platform which the image in the manifest runs on, as defined
         #
         #   @param size [Integer] The size in bytes of the blob.
         #
@@ -513,7 +498,6 @@ module DockerEngineRuby
       # @see DockerEngineRuby::Models::Summary#network_settings
       class NetworkSettings < DockerEngineRuby::Internal::Type::BaseModel
         # @!attribute networks
-        #   Summary of network-settings for each network the container is attached to.
         #
         #   @return [Hash{Symbol=>DockerEngineRuby::Models::Summary::NetworkSettings::Network}, nil]
         optional :networks,
@@ -523,12 +507,9 @@ module DockerEngineRuby
                  api_name: :Networks
 
         # @!method initialize(networks: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {DockerEngineRuby::Models::Summary::NetworkSettings} for more details.
-        #
         #   Summary of the container's network settings
         #
-        #   @param networks [Hash{Symbol=>DockerEngineRuby::Models::Summary::NetworkSettings::Network}] Summary of network-settings for each network the container is
+        #   @param networks [Hash{Symbol=>DockerEngineRuby::Models::Summary::NetworkSettings::Network}]
 
         class Network < DockerEngineRuby::Internal::Type::BaseModel
           # @!attribute aliases
@@ -603,8 +584,7 @@ module DockerEngineRuby
           #   @return [DockerEngineRuby::Models::Summary::NetworkSettings::Network::IpamConfig, nil]
           optional :ipam_config,
                    -> { DockerEngineRuby::Summary::NetworkSettings::Network::IpamConfig },
-                   api_name: :IPAMConfig,
-                   nil?: true
+                   api_name: :IPAMConfig
 
           # @!attribute ip_prefix_len
           #   Mask length of the IPv4 address.
@@ -660,7 +640,7 @@ module DockerEngineRuby
           #
           #   @param ip_address [String] IPv4 address.
           #
-          #   @param ipam_config [DockerEngineRuby::Models::Summary::NetworkSettings::Network::IpamConfig, nil] EndpointIPAMConfig represents an endpoint's IPAM configuration.
+          #   @param ipam_config [DockerEngineRuby::Models::Summary::NetworkSettings::Network::IpamConfig] EndpointIPAMConfig represents an endpoint's IPAM configuration.
           #
           #   @param ip_prefix_len [Integer] Mask length of the IPv4 address.
           #

data/lib/docker_engine_ruby/models/swarm.rb

@@ -8,8 +8,8 @@ module DockerEngineRuby
       #   Date and time at which the swarm was initialised in
       #   [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
       #
-      #   @return [String, nil]
-      optional :created_at, String, api_name: :CreatedAt
+      #   @return [Time, nil]
+      optional :created_at, Time, api_name: :CreatedAt
 
       # @!attribute data_path_port
       #   DataPathPort specifies the data path port number for data traffic. Acceptable
@@ -71,8 +71,8 @@ module DockerEngineRuby
       #   Date and time at which the swarm was last updated in
       #   [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
       #
-      #   @return [String, nil]
-      optional :updated_at, String, api_name: :UpdatedAt
+      #   @return [Time, nil]
+      optional :updated_at, Time, api_name: :UpdatedAt
 
       # @!attribute version
       #   The version number of the object such as node, service, etc. This is needed to
@@ -92,7 +92,7 @@ module DockerEngineRuby
       #   Some parameter documentations has been truncated, see
       #   {DockerEngineRuby::Models::SwarmAPI} for more details.
       #
-      #   @param created_at [String] Date and time at which the swarm was initialised in
+      #   @param created_at [Time] Date and time at which the swarm was initialised in
       #
       #   @param data_path_port [Integer] DataPathPort specifies the data path port number for data traffic.
       #
@@ -110,7 +110,7 @@ module DockerEngineRuby
       #
       #   @param tls_info [DockerEngineRuby::Models::SwarmAPI::TlsInfo] Information about the issuer of leaf TLS certificates and the trusted root
       #
-      #   @param updated_at [String] Date and time at which the swarm was last updated in
+      #   @param updated_at [Time] Date and time at which the swarm was last updated in
       #
       #   @param version [DockerEngineRuby::Models::SwarmAPI::Version] The version number of the object such as node, service, etc. This is needed
 
@@ -129,9 +129,6 @@ module DockerEngineRuby
         optional :worker, String, api_name: :Worker
 
         # @!method initialize(manager: nil, worker: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {DockerEngineRuby::Models::SwarmAPI::JoinTokens} for more details.
-        #
         #   JoinTokens contains the tokens workers and managers need to join the swarm.
         #
         #   @param manager [String] The token managers can use to join the swarm.