docker-engine-api 0.2.1

data/lib/docker_engine_api/models/network_create_params.rb

@@ -0,0 +1,210 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Networks#create
+    class NetworkCreateParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      # @!attribute name
+      #   The network's name.
+      #
+      #   @return [String]
+      required :name, String, api_name: :Name
+
+      # @!attribute attachable
+      #   Globally scoped network is manually attachable by regular containers from
+      #   workers in swarm mode.
+      #
+      #   @return [Boolean, nil]
+      optional :attachable, DockerEngineAPI::Internal::Type::Boolean, api_name: :Attachable
+
+      # @!attribute config_from
+      #   The config-only network source to provide the configuration for this network.
+      #
+      #   @return [DockerEngineAPI::Models::NetworkCreateParams::ConfigFrom, nil]
+      optional :config_from, -> { DockerEngineAPI::NetworkCreateParams::ConfigFrom }, api_name: :ConfigFrom
+
+      # @!attribute config_only
+      #   Creates 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 [Boolean, nil]
+      optional :config_only, DockerEngineAPI::Internal::Type::Boolean, api_name: :ConfigOnly
+
+      # @!attribute driver
+      #   Name of the network driver plugin to use.
+      #
+      #   @return [String, nil]
+      optional :driver, String, api_name: :Driver
+
+      # @!attribute enable_i_pv4
+      #   Enable IPv4 on the network.
+      #
+      #   @return [Boolean, nil]
+      optional :enable_i_pv4, DockerEngineAPI::Internal::Type::Boolean, api_name: :EnableIPv4
+
+      # @!attribute enable_i_pv6
+      #   Enable IPv6 on the network.
+      #
+      #   @return [Boolean, nil]
+      optional :enable_i_pv6, DockerEngineAPI::Internal::Type::Boolean, api_name: :EnableIPv6
+
+      # @!attribute ingress
+      #   Ingress network is the network which provides the routing-mesh in swarm mode.
+      #
+      #   @return [Boolean, nil]
+      optional :ingress, DockerEngineAPI::Internal::Type::Boolean, api_name: :Ingress
+
+      # @!attribute internal
+      #   Restrict external access to the network.
+      #
+      #   @return [Boolean, nil]
+      optional :internal, DockerEngineAPI::Internal::Type::Boolean, api_name: :Internal
+
+      # @!attribute ipam
+      #
+      #   @return [DockerEngineAPI::Models::NetworkCreateParams::Ipam, nil]
+      optional :ipam, -> { DockerEngineAPI::NetworkCreateParams::Ipam }, api_name: :IPAM
+
+      # @!attribute labels
+      #   User-defined key/value metadata.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :labels, DockerEngineAPI::Internal::Type::HashOf[String], api_name: :Labels
+
+      # @!attribute options
+      #   Network specific options to be used by the drivers.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :options, DockerEngineAPI::Internal::Type::HashOf[String], api_name: :Options
+
+      # @!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(name:, attachable: nil, config_from: nil, config_only: nil, driver: nil, enable_i_pv4: nil, enable_i_pv6: nil, ingress: nil, internal: nil, ipam: nil, labels: nil, options: nil, scope: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngineAPI::Models::NetworkCreateParams} for more details.
+      #
+      #   @param name [String] The network's name.
+      #
+      #   @param attachable [Boolean] Globally scoped network is manually attachable by regular
+      #
+      #   @param config_from [DockerEngineAPI::Models::NetworkCreateParams::ConfigFrom] The config-only network source to provide the configuration for
+      #
+      #   @param config_only [Boolean] Creates a config-only network. Config-only networks are placeholder
+      #
+      #   @param driver [String] Name of the network driver plugin to use.
+      #
+      #   @param enable_i_pv4 [Boolean] Enable IPv4 on the network.
+      #
+      #   @param enable_i_pv6 [Boolean] Enable IPv6 on the network.
+      #
+      #   @param ingress [Boolean] Ingress network is the network which provides the routing-mesh
+      #
+      #   @param internal [Boolean] Restrict external access to the network.
+      #
+      #   @param ipam [DockerEngineAPI::Models::NetworkCreateParams::Ipam]
+      #
+      #   @param labels [Hash{Symbol=>String}] User-defined key/value metadata.
+      #
+      #   @param options [Hash{Symbol=>String}] Network specific options to be used by the drivers.
+      #
+      #   @param scope [String] The level at which the network exists (e.g. `swarm` for cluster-wide
+      #
+      #   @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
+
+      class ConfigFrom < DockerEngineAPI::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 :network, String, api_name: :Network
+
+        # @!method initialize(network: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {DockerEngineAPI::Models::NetworkCreateParams::ConfigFrom} for more details.
+        #
+        #   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
+
+      class Ipam < DockerEngineAPI::Internal::Type::BaseModel
+        # @!attribute config
+        #   List of IPAM configuration options, specified as a map:
+        #
+        #   ```
+        #   {"Subnet": <CIDR>, "IPRange": <CIDR>, "Gateway": <IP address>, "AuxAddress": <device_name:IP address>}
+        #   ```
+        #
+        #   @return [Array<DockerEngineAPI::Models::NetworkCreateParams::Ipam::Config>, nil]
+        optional :config,
+                 -> {
+                   DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::NetworkCreateParams::Ipam::Config]
+                 },
+                 api_name: :Config
+
+        # @!attribute driver
+        #   Name of the IPAM driver to use.
+        #
+        #   @return [String, nil]
+        optional :driver, String, api_name: :Driver
+
+        # @!attribute options
+        #   Driver-specific options, specified as a map.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :options, DockerEngineAPI::Internal::Type::HashOf[String], api_name: :Options
+
+        # @!method initialize(config: nil, driver: nil, options: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {DockerEngineAPI::Models::NetworkCreateParams::Ipam} for more details.
+        #
+        #   @param config [Array<DockerEngineAPI::Models::NetworkCreateParams::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 < DockerEngineAPI::Internal::Type::BaseModel
+          # @!attribute auxiliary_addresses
+          #
+          #   @return [Hash{Symbol=>String}, nil]
+          optional :auxiliary_addresses,
+                   DockerEngineAPI::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
+    end
+  end
+end

data/lib/docker_engine_api/models/network_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Networks#delete
+    class NetworkDeleteParams < 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/network_disconnect_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Networks#disconnect
+    class NetworkDisconnectParams < DockerEngineAPI::Models::DisconnectRequest
+      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/network_inspect_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Networks#inspect_
+    class NetworkInspectParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      # @!attribute scope
+      #   Filter the network by scope (swarm, global, or local)
+      #
+      #   @return [String, nil]
+      optional :scope, String
+
+      # @!attribute verbose
+      #   Detailed inspect output for troubleshooting
+      #
+      #   @return [Boolean, nil]
+      optional :verbose, DockerEngineAPI::Internal::Type::Boolean
+
+      # @!method initialize(scope: nil, verbose: nil, request_options: {})
+      #   @param scope [String] Filter the network by scope (swarm, global, or local)
+      #
+      #   @param verbose [Boolean] Detailed inspect output for troubleshooting
+      #
+      #   @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine_api/models/network_inspect_response.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Networks#inspect_
+    class NetworkInspectResponse < DockerEngineAPI::Models::Network
+      # @!attribute containers
+      #   Contains endpoints attached to the network.
+      #
+      #   @return [Hash{Symbol=>DockerEngineAPI::Models::NetworkInspectResponse::Container}, nil]
+      optional :containers,
+               -> { DockerEngineAPI::Internal::Type::HashOf[DockerEngineAPI::Models::NetworkInspectResponse::Container] },
+               api_name: :Containers
+
+      # @!attribute services
+      #   List of services using the network. This field is only present for swarm scope
+      #   networks, and omitted for local scope networks.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :services,
+               DockerEngineAPI::Internal::Type::HashOf[DockerEngineAPI::Internal::Type::Unknown],
+               api_name: :Services
+
+      # @!attribute status
+      #   provides runtime information about the network such as the number of allocated
+      #   IPs.
+      #
+      #   @return [DockerEngineAPI::Models::NetworkInspectResponse::Status, nil]
+      optional :status, -> { DockerEngineAPI::Models::NetworkInspectResponse::Status }, api_name: :Status
+
+      # @!method initialize(containers: nil, services: nil, status: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngineAPI::Models::NetworkInspectResponse} for more details.
+      #
+      #   The body of the "get network" http response message.
+      #
+      #   @param containers [Hash{Symbol=>DockerEngineAPI::Models::NetworkInspectResponse::Container}] Contains endpoints attached to the network.
+      #
+      #   @param services [Hash{Symbol=>Object}] List of services using the network. This field is only present for
+      #
+      #   @param status [DockerEngineAPI::Models::NetworkInspectResponse::Status] provides runtime information about the network such as the number of allocated I
+
+      class Container < DockerEngineAPI::Internal::Type::BaseModel
+        # @!attribute endpoint_id
+        #
+        #   @return [String, nil]
+        optional :endpoint_id, String, api_name: :EndpointID
+
+        # @!attribute i_pv4_address
+        #
+        #   @return [String, nil]
+        optional :i_pv4_address, String, api_name: :IPv4Address
+
+        # @!attribute i_pv6_address
+        #
+        #   @return [String, nil]
+        optional :i_pv6_address, String, api_name: :IPv6Address
+
+        # @!attribute mac_address
+        #
+        #   @return [String, nil]
+        optional :mac_address, String, api_name: :MacAddress
+
+        # @!attribute name
+        #
+        #   @return [String, nil]
+        optional :name, String, api_name: :Name
+
+        # @!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.
+        #
+        #   @param endpoint_id [String]
+        #   @param i_pv4_address [String]
+        #   @param i_pv6_address [String]
+        #   @param mac_address [String]
+        #   @param name [String]
+      end
+
+      class Status < DockerEngineAPI::Internal::Type::BaseModel
+        # @!attribute ipam
+        #
+        #   @return [DockerEngineAPI::Models::NetworkInspectResponse::Status::Ipam, nil]
+        optional :ipam, -> { DockerEngineAPI::Models::NetworkInspectResponse::Status::Ipam }, api_name: :IPAM
+
+        # @!method initialize(ipam: nil)
+        #   provides runtime information about the network such as the number of allocated
+        #   IPs.
+        #
+        #   @param ipam [DockerEngineAPI::Models::NetworkInspectResponse::Status::Ipam]
+
+        # @see DockerEngineAPI::Models::NetworkInspectResponse::Status#ipam
+        class Ipam < DockerEngineAPI::Internal::Type::BaseModel
+          # @!attribute subnets
+          #
+          #   @return [Hash{Symbol=>DockerEngineAPI::Models::NetworkInspectResponse::Status::Ipam::Subnet}, nil]
+          optional :subnets,
+                   -> { DockerEngineAPI::Internal::Type::HashOf[DockerEngineAPI::Models::NetworkInspectResponse::Status::Ipam::Subnet] },
+                   api_name: :Subnets
+
+          # @!method initialize(subnets: nil)
+          #   @param subnets [Hash{Symbol=>DockerEngineAPI::Models::NetworkInspectResponse::Status::Ipam::Subnet}]
+
+          class Subnet < DockerEngineAPI::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
+            #   {DockerEngineAPI::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
+      end
+    end
+  end
+end

data/lib/docker_engine_api/models/network_list_params.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Networks#list
+    class NetworkListParams < 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
+      #   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
+      #   {DockerEngineAPI::Models::NetworkListParams} for more details.
+      #
+      #   @param filters [String] JSON encoded value of the filters (a `map[string][]string`) to process
+      #
+      #   @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine_api/models/network_list_response.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @type [DockerEngineAPI::Internal::Type::Converter]
+    NetworkListResponse = DockerEngineAPI::Internal::Type::ArrayOf[-> { DockerEngineAPI::Summary }]
+  end
+end

data/lib/docker_engine_api/models/network_prune_params.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Networks#prune
+    class NetworkPruneParams < 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:
+      #
+      #   - `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
+      #   {DockerEngineAPI::Models::NetworkPruneParams} 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/network_prune_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Models
+    # @see DockerEngineAPI::Resources::Networks#prune
+    class NetworkPruneResponse < DockerEngineAPI::Internal::Type::BaseModel
+      # @!attribute networks_deleted
+      #   Networks that were deleted
+      #
+      #   @return [Array<String>, nil]
+      optional :networks_deleted, DockerEngineAPI::Internal::Type::ArrayOf[String], api_name: :NetworksDeleted
+
+      # @!method initialize(networks_deleted: nil)
+      #   @param networks_deleted [Array<String>] Networks that were deleted
+    end
+  end
+end