docker-engine-ruby 0.2.2 → 0.4.0

data/lib/docker_engine_ruby/models/network_inspect_response.rb

@@ -3,128 +3,258 @@
 module DockerEngineRuby
   module Models
     # @see DockerEngineRuby::Resources::Networks#inspect_
-    class NetworkInspectResponse < DockerEngineRuby::Models::Network
-      # @!attribute containers
-      #   Contains endpoints attached to the network.
+    class NetworkInspectResponse < DockerEngineRuby::Internal::Type::BaseModel
+      # @!attribute attachable
+      #   Whether a global / swarm scope network is manually attachable by regular
+      #   containers from workers in swarm mode.
       #
-      #   @return [Hash{Symbol=>DockerEngineRuby::Models::NetworkInspectResponse::Container}, nil]
-      optional :containers,
-               -> { DockerEngineRuby::Internal::Type::HashOf[DockerEngineRuby::Models::NetworkInspectResponse::Container] },
-               api_name: :Containers
+      #   @return [Boolean, nil]
+      optional :attachable, DockerEngineRuby::Internal::Type::Boolean, api_name: :Attachable
 
-      # @!attribute services
-      #   List of services using the network. This field is only present for swarm scope
-      #   networks, and omitted for local scope networks.
+      # @!attribute config_from
+      #   The config-only network source to provide the configuration for this network.
       #
-      #   @return [Hash{Symbol=>Object}, nil]
-      optional :services,
-               DockerEngineRuby::Internal::Type::HashOf[DockerEngineRuby::Internal::Type::Unknown],
-               api_name: :Services
+      #   @return [DockerEngineRuby::Models::NetworkInspectResponse::ConfigFrom, nil]
+      optional :config_from,
+               -> { DockerEngineRuby::Models::NetworkInspectResponse::ConfigFrom },
+               api_name: :ConfigFrom
 
-      # @!attribute status
-      #   provides runtime information about the network such as the number of allocated
-      #   IPs.
+      # @!attribute config_only
+      #   Whether the network is a config-only network. Config-only networks are
+      #   placeholder networks for network configurations to be used by other networks.
+      #   Config-only networks cannot be used directly to run containers or services.
       #
-      #   @return [DockerEngineRuby::Models::NetworkInspectResponse::Status, nil]
-      optional :status, -> { DockerEngineRuby::Models::NetworkInspectResponse::Status }, api_name: :Status
+      #   @return [Boolean, nil]
+      optional :config_only, DockerEngineRuby::Internal::Type::Boolean, api_name: :ConfigOnly
 
-      # @!method initialize(containers: nil, services: nil, status: nil)
+      # @!attribute created
+      #   Date and time at which the network was created in
+      #   [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
+      #
+      #   @return [Time, nil]
+      optional :created, Time, api_name: :Created
+
+      # @!attribute driver
+      #   The name of the driver used to create the network (e.g. `bridge`, `overlay`).
+      #
+      #   @return [String, nil]
+      optional :driver, String, api_name: :Driver
+
+      # @!attribute enable_i_pv4
+      #   Whether the network was created with IPv4 enabled.
+      #
+      #   @return [Boolean, nil]
+      optional :enable_i_pv4, DockerEngineRuby::Internal::Type::Boolean, api_name: :EnableIPv4
+
+      # @!attribute enable_i_pv6
+      #   Whether the network was created with IPv6 enabled.
+      #
+      #   @return [Boolean, nil]
+      optional :enable_i_pv6, DockerEngineRuby::Internal::Type::Boolean, api_name: :EnableIPv6
+
+      # @!attribute id
+      #   ID that uniquely identifies a network on a single machine.
+      #
+      #   @return [String, nil]
+      optional :id, String, api_name: :Id
+
+      # @!attribute ingress
+      #   Whether the network is providing the routing-mesh for the swarm cluster.
+      #
+      #   @return [Boolean, nil]
+      optional :ingress, DockerEngineRuby::Internal::Type::Boolean, api_name: :Ingress
+
+      # @!attribute internal
+      #   Whether the network is created to only allow internal networking connectivity.
+      #
+      #   @return [Boolean, nil]
+      optional :internal, DockerEngineRuby::Internal::Type::Boolean, api_name: :Internal
+
+      # @!attribute ipam
+      #   The network's IP Address Management.
+      #
+      #   @return [DockerEngineRuby::Models::NetworkInspectResponse::Ipam, nil]
+      optional :ipam, -> { DockerEngineRuby::Models::NetworkInspectResponse::Ipam }, api_name: :IPAM
+
+      # @!attribute labels
+      #   Metadata specific to the network being created.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :labels, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Labels
+
+      # @!attribute name
+      #   Name of the network.
+      #
+      #   @return [String, nil]
+      optional :name, String, api_name: :Name
+
+      # @!attribute options
+      #   Network-specific options uses when creating the network.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :options, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Options
+
+      # @!attribute peers
+      #   List of peer nodes for an overlay network. This field is only present for
+      #   overlay networks, and omitted for other network types.
+      #
+      #   @return [Array<DockerEngineRuby::Models::NetworkInspectResponse::Peer>, nil]
+      optional :peers,
+               -> { DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Models::NetworkInspectResponse::Peer] },
+               api_name: :Peers
+
+      # @!attribute scope
+      #   The level at which the network exists (e.g. `swarm` for cluster-wide or `local`
+      #   for machine level)
+      #
+      #   @return [String, nil]
+      optional :scope, String, api_name: :Scope
+
+      # @!method initialize(attachable: nil, config_from: nil, config_only: nil, created: nil, driver: nil, enable_i_pv4: nil, enable_i_pv6: nil, id: nil, ingress: nil, internal: nil, ipam: nil, labels: nil, name: nil, options: nil, peers: nil, scope: nil)
       #   Some parameter documentations has been truncated, see
       #   {DockerEngineRuby::Models::NetworkInspectResponse} for more details.
       #
       #   The body of the "get network" http response message.
       #
-      #   @param containers [Hash{Symbol=>DockerEngineRuby::Models::NetworkInspectResponse::Container}] Contains endpoints attached to the network.
+      #   @param attachable [Boolean] Whether a global / swarm scope network is manually attachable by regular
+      #
+      #   @param config_from [DockerEngineRuby::Models::NetworkInspectResponse::ConfigFrom] The config-only network source to provide the configuration for
+      #
+      #   @param config_only [Boolean] Whether the network is a config-only network. Config-only networks are
+      #
+      #   @param created [Time] Date and time at which the network was created in
+      #
+      #   @param driver [String] The name of the driver used to create the network (e.g. `bridge`,
+      #
+      #   @param enable_i_pv4 [Boolean] Whether the network was created with IPv4 enabled.
+      #
+      #   @param enable_i_pv6 [Boolean] Whether the network was created with IPv6 enabled.
+      #
+      #   @param id [String] ID that uniquely identifies a network on a single machine.
+      #
+      #   @param ingress [Boolean] Whether the network is providing the routing-mesh for the swarm cluster.
       #
-      #   @param services [Hash{Symbol=>Object}] List of services using the network. This field is only present for
+      #   @param internal [Boolean] Whether the network is created to only allow internal networking
       #
-      #   @param status [DockerEngineRuby::Models::NetworkInspectResponse::Status] provides runtime information about the network such as the number of allocated I
+      #   @param ipam [DockerEngineRuby::Models::NetworkInspectResponse::Ipam] The network's IP Address Management.
+      #
+      #   @param labels [Hash{Symbol=>String}] Metadata specific to the network being created.
+      #
+      #   @param name [String] Name of the network.
+      #
+      #   @param options [Hash{Symbol=>String}] Network-specific options uses when creating the network.
+      #
+      #   @param peers [Array<DockerEngineRuby::Models::NetworkInspectResponse::Peer>] List of peer nodes for an overlay network. This field is only present
+      #
+      #   @param scope [String] The level at which the network exists (e.g. `swarm` for cluster-wide
 
-      class Container < DockerEngineRuby::Internal::Type::BaseModel
-        # @!attribute endpoint_id
+      # @see DockerEngineRuby::Models::NetworkInspectResponse#config_from
+      class ConfigFrom < DockerEngineRuby::Internal::Type::BaseModel
+        # @!attribute network
+        #   The name of the config-only network that provides the network's configuration.
+        #   The specified network must be an existing config-only network. Only network
+        #   names are allowed, not network IDs.
         #
         #   @return [String, nil]
-        optional :endpoint_id, String, api_name: :EndpointID
+        optional :network, String, api_name: :Network
 
-        # @!attribute i_pv4_address
+        # @!method initialize(network: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {DockerEngineRuby::Models::NetworkInspectResponse::ConfigFrom} for more details.
         #
-        #   @return [String, nil]
-        optional :i_pv4_address, String, api_name: :IPv4Address
+        #   The config-only network source to provide the configuration for this network.
+        #
+        #   @param network [String] The name of the config-only network that provides the network's
+      end
 
-        # @!attribute i_pv6_address
+      # @see DockerEngineRuby::Models::NetworkInspectResponse#ipam
+      class Ipam < DockerEngineRuby::Internal::Type::BaseModel
+        # @!attribute config
+        #   List of IPAM configuration options, specified as a map:
         #
-        #   @return [String, nil]
-        optional :i_pv6_address, String, api_name: :IPv6Address
+        #   ```
+        #   {"Subnet": <CIDR>, "IPRange": <CIDR>, "Gateway": <IP address>, "AuxAddress": <device_name:IP address>}
+        #   ```
+        #
+        #   @return [Array<DockerEngineRuby::Models::NetworkInspectResponse::Ipam::Config>, nil]
+        optional :config,
+                 -> { DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Models::NetworkInspectResponse::Ipam::Config] },
+                 api_name: :Config
 
-        # @!attribute mac_address
+        # @!attribute driver
+        #   Name of the IPAM driver to use.
         #
         #   @return [String, nil]
-        optional :mac_address, String, api_name: :MacAddress
+        optional :driver, String, api_name: :Driver
 
-        # @!attribute name
+        # @!attribute options
+        #   Driver-specific options, specified as a map.
         #
-        #   @return [String, nil]
-        optional :name, String, api_name: :Name
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :options, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Options
 
-        # @!method initialize(endpoint_id: nil, i_pv4_address: nil, i_pv6_address: nil, mac_address: nil, name: nil)
-        #   contains network resources allocated and used for a container in a network.
+        # @!method initialize(config: nil, driver: nil, options: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {DockerEngineRuby::Models::NetworkInspectResponse::Ipam} for more details.
         #
-        #   @param endpoint_id [String]
-        #   @param i_pv4_address [String]
-        #   @param i_pv6_address [String]
-        #   @param mac_address [String]
-        #   @param name [String]
+        #   The network's IP Address Management.
+        #
+        #   @param config [Array<DockerEngineRuby::Models::NetworkInspectResponse::Ipam::Config>] List of IPAM configuration options, specified as a map:
+        #
+        #   @param driver [String] Name of the IPAM driver to use.
+        #
+        #   @param options [Hash{Symbol=>String}] Driver-specific options, specified as a map.
+
+        class Config < DockerEngineRuby::Internal::Type::BaseModel
+          # @!attribute auxiliary_addresses
+          #
+          #   @return [Hash{Symbol=>String}, nil]
+          optional :auxiliary_addresses,
+                   DockerEngineRuby::Internal::Type::HashOf[String],
+                   api_name: :AuxiliaryAddresses
+
+          # @!attribute gateway
+          #
+          #   @return [String, nil]
+          optional :gateway, String, api_name: :Gateway
+
+          # @!attribute ip_range
+          #
+          #   @return [String, nil]
+          optional :ip_range, String, api_name: :IPRange
+
+          # @!attribute subnet
+          #
+          #   @return [String, nil]
+          optional :subnet, String, api_name: :Subnet
+
+          # @!method initialize(auxiliary_addresses: nil, gateway: nil, ip_range: nil, subnet: nil)
+          #   @param auxiliary_addresses [Hash{Symbol=>String}]
+          #   @param gateway [String]
+          #   @param ip_range [String]
+          #   @param subnet [String]
+        end
       end
 
-      class Status < DockerEngineRuby::Internal::Type::BaseModel
-        # @!attribute ipam
+      class Peer < DockerEngineRuby::Internal::Type::BaseModel
+        # @!attribute ip
+        #   IP-address of the peer-node in the Swarm cluster.
         #
-        #   @return [DockerEngineRuby::Models::NetworkInspectResponse::Status::Ipam, nil]
-        optional :ipam, -> { DockerEngineRuby::Models::NetworkInspectResponse::Status::Ipam }, api_name: :IPAM
+        #   @return [String, nil]
+        optional :ip, String, api_name: :IP
 
-        # @!method initialize(ipam: nil)
-        #   provides runtime information about the network such as the number of allocated
-        #   IPs.
+        # @!attribute name
+        #   ID of the peer-node in the Swarm cluster.
         #
-        #   @param ipam [DockerEngineRuby::Models::NetworkInspectResponse::Status::Ipam]
+        #   @return [String, nil]
+        optional :name, String, api_name: :Name
 
-        # @see DockerEngineRuby::Models::NetworkInspectResponse::Status#ipam
-        class Ipam < DockerEngineRuby::Internal::Type::BaseModel
-          # @!attribute subnets
-          #
-          #   @return [Hash{Symbol=>DockerEngineRuby::Models::NetworkInspectResponse::Status::Ipam::Subnet}, nil]
-          optional :subnets,
-                   -> { DockerEngineRuby::Internal::Type::HashOf[DockerEngineRuby::Models::NetworkInspectResponse::Status::Ipam::Subnet] },
-                   api_name: :Subnets
-
-          # @!method initialize(subnets: nil)
-          #   @param subnets [Hash{Symbol=>DockerEngineRuby::Models::NetworkInspectResponse::Status::Ipam::Subnet}]
-
-          class Subnet < DockerEngineRuby::Internal::Type::BaseModel
-            # @!attribute dynamic_ips_available
-            #   Number of IP addresses within the network's IPRange for the subnet that are
-            #   available for allocation, saturating at 2<sup>64</sup> - 1.
-            #
-            #   @return [Integer, nil]
-            optional :dynamic_ips_available, Integer, api_name: :DynamicIPsAvailable
-
-            # @!attribute ips_in_use
-            #   Number of IP addresses in the subnet that are in use or reserved and are
-            #   therefore unavailable for allocation, saturating at 2<sup>64</sup> - 1.
-            #
-            #   @return [Integer, nil]
-            optional :ips_in_use, Integer, api_name: :IPsInUse
-
-            # @!method initialize(dynamic_ips_available: nil, ips_in_use: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {DockerEngineRuby::Models::NetworkInspectResponse::Status::Ipam::Subnet} for
-            #   more details.
-            #
-            #   @param dynamic_ips_available [Integer] Number of IP addresses within the network's IPRange for the subnet that are avai
-            #
-            #   @param ips_in_use [Integer] Number of IP addresses in the subnet that are in use or reserved and are therefo
-          end
-        end
+        # @!method initialize(ip: nil, name: nil)
+        #   represents one peer of an overlay network.
+        #
+        #   @param ip [String] IP-address of the peer-node in the Swarm cluster.
+        #
+        #   @param name [String] ID of the peer-node in the Swarm cluster.
       end
     end
   end

data/lib/docker_engine_ruby/models/network_list_params.rb

@@ -8,32 +8,12 @@ module DockerEngineRuby
       include DockerEngineRuby::Internal::Type::RequestParameters
 
       # @!attribute filters
-      #   JSON encoded value of the filters (a `map[string][]string`) to process on the
-      #   networks list.
-      #
-      #   Available filters:
-      #
-      #   - `dangling=<boolean>` When set to `true` (or `1`), returns all networks that
-      #     are not in use by a container. When set to `false` (or `0`), only networks
-      #     that are in use by one or more containers are returned.
-      #   - `driver=<driver-name>` Matches a network's driver.
-      #   - `id=<network-id>` Matches all or part of a network ID.
-      #   - `label=<key>` or `label=<key>=<value>` of a network label.
-      #   - `name=<network-name>` Matches all or part of a network name.
-      #   - `scope=["swarm"|"global"|"local"]` Filters networks by scope (`swarm`,
-      #     `global`, or `local`).
-      #   - `type=["custom"|"builtin"]` Filters networks by type. The `custom` keyword
-      #     returns all user-defined networks.
       #
       #   @return [String, nil]
       optional :filters, String
 
       # @!method initialize(filters: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {DockerEngineRuby::Models::NetworkListParams} for more details.
-      #
-      #   @param filters [String] JSON encoded value of the filters (a `map[string][]string`) to process
-      #
+      #   @param filters [String]
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/docker_engine_ruby/models/network_list_response.rb

@@ -3,6 +3,6 @@
 module DockerEngineRuby
   module Models
     # @type [DockerEngineRuby::Internal::Type::Converter]
-    NetworkListResponse = DockerEngineRuby::Internal::Type::ArrayOf[-> { DockerEngineRuby::Summary }]
+    NetworkListResponse = DockerEngineRuby::Internal::Type::ArrayOf[-> { DockerEngineRuby::NetworkSummary }]
   end
 end

data/lib/docker_engine_ruby/models/network_prune_params.rb

@@ -8,27 +8,12 @@ module DockerEngineRuby
       include DockerEngineRuby::Internal::Type::RequestParameters
 
       # @!attribute filters
-      #   Filters to process on the prune list, encoded as JSON (a `map[string][]string`).
-      #
-      #   Available filters:
-      #
-      #   - `until=<timestamp>` Prune networks created before this timestamp. The
-      #     `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go
-      #     duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon
-      #     machine’s time.
-      #   - `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or
-      #     `label!=<key>=<value>`) Prune networks with (or without, in case `label!=...`
-      #     is used) the specified labels.
       #
       #   @return [String, nil]
       optional :filters, String
 
       # @!method initialize(filters: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {DockerEngineRuby::Models::NetworkPruneParams} for more details.
-      #
-      #   @param filters [String] Filters to process on the prune list, encoded as JSON (a `map[string][]string`).
-      #
+      #   @param filters [String]
       #   @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/docker_engine_ruby/models/network_prune_response.rb

@@ -5,7 +5,6 @@ module DockerEngineRuby
     # @see DockerEngineRuby::Resources::Networks#prune
     class NetworkPruneResponse < DockerEngineRuby::Internal::Type::BaseModel
       # @!attribute networks_deleted
-      #   Networks that were deleted
       #
       #   @return [Array<String>, nil]
       optional :networks_deleted,
@@ -13,7 +12,7 @@ module DockerEngineRuby
                api_name: :NetworksDeleted
 
       # @!method initialize(networks_deleted: nil)
-      #   @param networks_deleted [Array<String>] Networks that were deleted
+      #   @param networks_deleted [Array<String>]
     end
   end
 end