docker-engine 0.1.1 → 0.2.0

data/lib/docker_engine/models/inspect.rb

@@ -0,0 +1,219 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Distribution#inspect_
+    class Inspect < DockerEngine::Internal::Type::BaseModel
+      # @!attribute descriptor
+      #   A descriptor struct containing digest, media type, and size, as defined in the
+      #   [OCI Content Descriptors Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/descriptor.md).
+      #
+      #   @return [DockerEngine::Models::Inspect::Descriptor]
+      required :descriptor, -> { DockerEngine::Inspect::Descriptor }, api_name: :Descriptor
+
+      # @!attribute platforms
+      #   An array containing all platforms supported by the image.
+      #
+      #   @return [Array<DockerEngine::Models::Inspect::Platform, nil>]
+      required :platforms,
+               -> { DockerEngine::Internal::Type::ArrayOf[DockerEngine::Inspect::Platform, nil?: true] },
+               api_name: :Platforms
+
+      # @!method initialize(descriptor:, platforms:)
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::Inspect} for more details.
+      #
+      #   Describes the result obtained from contacting the registry to retrieve image
+      #   metadata.
+      #
+      #   @param descriptor [DockerEngine::Models::Inspect::Descriptor] A descriptor struct containing digest, media type, and size, as defined in
+      #
+      #   @param platforms [Array<DockerEngine::Models::Inspect::Platform, nil>] An array containing all platforms supported by the image.
+
+      # @see DockerEngine::Models::Inspect#descriptor
+      class Descriptor < DockerEngine::Internal::Type::BaseModel
+        # @!attribute annotations
+        #   Arbitrary metadata relating to the targeted content.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :annotations, DockerEngine::Internal::Type::HashOf[String], nil?: true
+
+        # @!attribute artifact_type
+        #   ArtifactType is the IANA media type of this artifact.
+        #
+        #   @return [String, nil]
+        optional :artifact_type, String, api_name: :artifactType, nil?: true
+
+        # @!attribute data
+        #   Data is an embedding of the targeted content. This is encoded as a base64 string
+        #   when marshalled to JSON (automatically, by encoding/json). If present, Data can
+        #   be used directly to avoid fetching the targeted content.
+        #
+        #   @return [String, nil]
+        optional :data, String, nil?: true
+
+        # @!attribute digest
+        #   The digest of the targeted content.
+        #
+        #   @return [String, nil]
+        optional :digest, String
+
+        # @!attribute media_type
+        #   The media type of the object this schema refers to.
+        #
+        #   @return [String, nil]
+        optional :media_type, String, api_name: :mediaType
+
+        # @!attribute platform
+        #   Describes the platform which the image in the manifest runs on, as defined in
+        #   the
+        #   [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
+        #
+        #   @return [DockerEngine::Models::Inspect::Descriptor::Platform, nil]
+        optional :platform, -> { DockerEngine::Inspect::Descriptor::Platform }, nil?: true
+
+        # @!attribute size
+        #   The size in bytes of the blob.
+        #
+        #   @return [Integer, nil]
+        optional :size, Integer
+
+        # @!attribute urls
+        #   List of URLs from which this object MAY be downloaded.
+        #
+        #   @return [Array<String>, nil]
+        optional :urls, DockerEngine::Internal::Type::ArrayOf[String], nil?: true
+
+        # @!method initialize(annotations: nil, artifact_type: nil, data: nil, digest: nil, media_type: nil, platform: nil, size: nil, urls: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {DockerEngine::Models::Inspect::Descriptor} for more details.
+        #
+        #   A descriptor struct containing digest, media type, and size, as defined in the
+        #   [OCI Content Descriptors Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/descriptor.md).
+        #
+        #   @param annotations [Hash{Symbol=>String}, nil] Arbitrary metadata relating to the targeted content.
+        #
+        #   @param artifact_type [String, nil] ArtifactType is the IANA media type of this artifact.
+        #
+        #   @param data [String, nil] Data is an embedding of the targeted content. This is encoded as a base64
+        #
+        #   @param digest [String] The digest of the targeted content.
+        #
+        #   @param media_type [String] The media type of the object this schema refers to.
+        #
+        #   @param platform [DockerEngine::Models::Inspect::Descriptor::Platform, nil] Describes the platform which the image in the manifest runs on, as defined
+        #
+        #   @param size [Integer] The size in bytes of the blob.
+        #
+        #   @param urls [Array<String>, nil] List of URLs from which this object MAY be downloaded.
+
+        # @see DockerEngine::Models::Inspect::Descriptor#platform
+        class Platform < DockerEngine::Internal::Type::BaseModel
+          # @!attribute architecture
+          #   The CPU architecture, for example `amd64` or `ppc64`.
+          #
+          #   @return [String, nil]
+          optional :architecture, String
+
+          # @!attribute os
+          #   The operating system, for example `linux` or `windows`.
+          #
+          #   @return [String, nil]
+          optional :os, String
+
+          # @!attribute os_features
+          #   Optional field specifying an array of strings, each listing a required OS
+          #   feature (for example on Windows `win32k`).
+          #
+          #   @return [Array<String>, nil]
+          optional :os_features, DockerEngine::Internal::Type::ArrayOf[String], api_name: :"os.features"
+
+          # @!attribute os_version
+          #   Optional field specifying the operating system version, for example on Windows
+          #   `10.0.19041.1165`.
+          #
+          #   @return [String, nil]
+          optional :os_version, String, api_name: :"os.version"
+
+          # @!attribute variant
+          #   Optional field specifying a variant of the CPU, for example `v7` to specify
+          #   ARMv7 when architecture is `arm`.
+          #
+          #   @return [String, nil]
+          optional :variant, String
+
+          # @!method initialize(architecture: nil, os: nil, os_features: nil, os_version: nil, variant: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {DockerEngine::Models::Inspect::Descriptor::Platform} for more details.
+          #
+          #   Describes the platform which the image in the manifest runs on, as defined in
+          #   the
+          #   [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
+          #
+          #   @param architecture [String] The CPU architecture, for example `amd64` or `ppc64`.
+          #
+          #   @param os [String] The operating system, for example `linux` or `windows`.
+          #
+          #   @param os_features [Array<String>] Optional field specifying an array of strings, each listing a required
+          #
+          #   @param os_version [String] Optional field specifying the operating system version, for example on
+          #
+          #   @param variant [String] Optional field specifying a variant of the CPU, for example `v7` to
+        end
+      end
+
+      class Platform < DockerEngine::Internal::Type::BaseModel
+        # @!attribute architecture
+        #   The CPU architecture, for example `amd64` or `ppc64`.
+        #
+        #   @return [String, nil]
+        optional :architecture, String
+
+        # @!attribute os
+        #   The operating system, for example `linux` or `windows`.
+        #
+        #   @return [String, nil]
+        optional :os, String
+
+        # @!attribute os_features
+        #   Optional field specifying an array of strings, each listing a required OS
+        #   feature (for example on Windows `win32k`).
+        #
+        #   @return [Array<String>, nil]
+        optional :os_features, DockerEngine::Internal::Type::ArrayOf[String], api_name: :"os.features"
+
+        # @!attribute os_version
+        #   Optional field specifying the operating system version, for example on Windows
+        #   `10.0.19041.1165`.
+        #
+        #   @return [String, nil]
+        optional :os_version, String, api_name: :"os.version"
+
+        # @!attribute variant
+        #   Optional field specifying a variant of the CPU, for example `v7` to specify
+        #   ARMv7 when architecture is `arm`.
+        #
+        #   @return [String, nil]
+        optional :variant, String
+
+        # @!method initialize(architecture: nil, os: nil, os_features: nil, os_version: nil, variant: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {DockerEngine::Models::Inspect::Platform} for more details.
+        #
+        #   Describes the platform which the image in the manifest runs on, as defined in
+        #   the
+        #   [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
+        #
+        #   @param architecture [String] The CPU architecture, for example `amd64` or `ppc64`.
+        #
+        #   @param os [String] The operating system, for example `linux` or `windows`.
+        #
+        #   @param os_features [Array<String>] Optional field specifying an array of strings, each listing a required
+        #
+        #   @param os_version [String] Optional field specifying the operating system version, for example on
+        #
+        #   @param variant [String] Optional field specifying a variant of the CPU, for example `v7` to
+      end
+    end
+  end
+end

data/lib/docker_engine/models/inspect_response.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    class InspectResponse < DockerEngine::Internal::Type::BaseModel
+      # @!attribute arguments
+      #
+      #   @return [Array<String>, nil]
+      optional :arguments, DockerEngine::Internal::Type::ArrayOf[String]
+
+      # @!attribute entrypoint
+      #
+      #   @return [String, nil]
+      optional :entrypoint, String
+
+      # @!attribute privileged
+      #
+      #   @return [Boolean, nil]
+      optional :privileged, DockerEngine::Internal::Type::Boolean
+
+      # @!attribute tty
+      #
+      #   @return [Boolean, nil]
+      optional :tty, DockerEngine::Internal::Type::Boolean
+
+      # @!attribute user
+      #
+      #   @return [String, nil]
+      optional :user, String
+
+      # @!method initialize(arguments: nil, entrypoint: nil, privileged: nil, tty: nil, user: nil)
+      #   @param arguments [Array<String>]
+      #   @param entrypoint [String]
+      #   @param privileged [Boolean]
+      #   @param tty [Boolean]
+      #   @param user [String]
+    end
+  end
+end

data/lib/docker_engine/models/{volume_list_response.rb → list_response.rb}

@@ -3,7 +3,7 @@
 module DockerEngine
   module Models
     # @see DockerEngine::Resources::Volumes#list
-    class VolumeListResponse < DockerEngine::Internal::Type::BaseModel
+    class ListResponse < DockerEngine::Internal::Type::BaseModel
       # @!attribute volumes
       #   List of volumes
       #
@@ -22,7 +22,7 @@ module DockerEngine
 
       # @!method initialize(volumes: nil, warnings: nil)
       #   Some parameter documentations has been truncated, see
-      #   {DockerEngine::Models::VolumeListResponse} for more details.
+      #   {DockerEngine::Models::ListResponse} for more details.
       #
       #   Volume list response
       #

data/lib/docker_engine/models/network_connect_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Networks#connect
+    class NetworkConnectParams < DockerEngine::Models::ConnectRequest
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/network_disconnect_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Networks#disconnect
+    class NetworkDisconnectParams < DockerEngine::Models::DisconnectRequest
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/network_prune_params.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Networks#prune
+    class NetworkPruneParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::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
+      #   {DockerEngine::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 [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/network_prune_response.rb

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