docker-engine 0.1.1 → 0.2.0

data/lib/docker_engine/models/plugin_privileges_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Plugins#privileges
+    class PluginPrivilegesParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute remote
+      #   The name of the plugin. The `:latest` tag is optional, and is the default if
+      #   omitted.
+      #
+      #   @return [String]
+      required :remote, String
+
+      # @!method initialize(remote:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::PluginPrivilegesParams} for more details.
+      #
+      #   @param remote [String] The name of the plugin. The `:latest` tag is optional, and is the
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/plugin_privileges_response.rb

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

data/lib/docker_engine/models/plugin_pull_params.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Plugins#pull
+    class PluginPullParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute remote
+      #   Remote reference for plugin to install.
+      #
+      #   The `:latest` tag is optional, and is used as the default if omitted.
+      #
+      #   @return [String]
+      required :remote, String
+
+      # @!attribute name
+      #   Local name for the pulled plugin.
+      #
+      #   The `:latest` tag is optional, and is used as the default if omitted.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute body
+      #
+      #   @return [Array<DockerEngine::Models::Privilege>, nil]
+      optional :body, -> { DockerEngine::Internal::Type::ArrayOf[DockerEngine::Privilege] }
+
+      # @!attribute x_registry_auth
+      #
+      #   @return [String, nil]
+      optional :x_registry_auth, String
+
+      # @!method initialize(remote:, name: nil, body: nil, x_registry_auth: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::PluginPullParams} for more details.
+      #
+      #   @param remote [String] Remote reference for plugin to install.
+      #
+      #   @param name [String] Local name for the pulled plugin.
+      #
+      #   @param body [Array<DockerEngine::Models::Privilege>]
+      #
+      #   @param x_registry_auth [String]
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/plugin_push_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Plugins#push
+    class PluginPushParams < DockerEngine::Internal::Type::BaseModel
+      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/plugin_set_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Plugins#set
+    class PluginSetParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute body
+      #
+      #   @return [Array<String>, nil]
+      optional :body, DockerEngine::Internal::Type::ArrayOf[String]
+
+      # @!method initialize(body: nil, request_options: {})
+      #   @param body [Array<String>]
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/plugin_upgrade_params.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Plugins#upgrade
+    class PluginUpgradeParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute remote
+      #   Remote reference to upgrade to.
+      #
+      #   The `:latest` tag is optional, and is used as the default if omitted.
+      #
+      #   @return [String]
+      required :remote, String
+
+      # @!attribute body
+      #
+      #   @return [Array<DockerEngine::Models::Privilege>, nil]
+      optional :body, -> { DockerEngine::Internal::Type::ArrayOf[DockerEngine::Privilege] }
+
+      # @!attribute x_registry_auth
+      #
+      #   @return [String, nil]
+      optional :x_registry_auth, String
+
+      # @!method initialize(remote:, body: nil, x_registry_auth: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::PluginUpgradeParams} for more details.
+      #
+      #   @param remote [String] Remote reference to upgrade to.
+      #
+      #   @param body [Array<DockerEngine::Models::Privilege>]
+      #
+      #   @param x_registry_auth [String]
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/privilege.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    class Privilege < DockerEngine::Internal::Type::BaseModel
+      # @!attribute description
+      #
+      #   @return [String, nil]
+      optional :description, String, api_name: :Description
+
+      # @!attribute name
+      #
+      #   @return [String, nil]
+      optional :name, String, api_name: :Name
+
+      # @!attribute value
+      #
+      #   @return [Array<String>, nil]
+      optional :value, DockerEngine::Internal::Type::ArrayOf[String], api_name: :Value
+
+      # @!method initialize(description: nil, name: nil, value: nil)
+      #   Describes a permission the user has to accept upon installing the plugin.
+      #
+      #   @param description [String]
+      #   @param name [String]
+      #   @param value [Array<String>]
+    end
+  end
+end

data/lib/docker_engine/models/secret.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Secrets#inspect_
+    class Secret < DockerEngine::Internal::Type::BaseModel
+      # @!attribute created_at
+      #
+      #   @return [String, nil]
+      optional :created_at, String, api_name: :CreatedAt
+
+      # @!attribute id
+      #
+      #   @return [String, nil]
+      optional :id, String, api_name: :ID
+
+      # @!attribute spec
+      #
+      #   @return [DockerEngine::Models::Spec, nil]
+      optional :spec, -> { DockerEngine::Spec }, api_name: :Spec
+
+      # @!attribute updated_at
+      #
+      #   @return [String, nil]
+      optional :updated_at, String, api_name: :UpdatedAt
+
+      # @!attribute version
+      #   The version number of the object such as node, service, etc. This is needed to
+      #   avoid conflicting writes. The client must send the version number along with the
+      #   modified specification when updating these objects.
+      #
+      #   This approach ensures safe concurrency and determinism in that the change on the
+      #   object may not be applied if the version number has changed from the last read.
+      #   In other words, if two update requests specify the same base version, only one
+      #   of the requests can succeed. As a result, two separate update requests that
+      #   happen at the same time will not unintentionally overwrite each other.
+      #
+      #   @return [DockerEngine::Models::Secret::Version, nil]
+      optional :version, -> { DockerEngine::Secret::Version }, api_name: :Version
+
+      # @!method initialize(created_at: nil, id: nil, spec: nil, updated_at: nil, version: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::Secret} for more details.
+      #
+      #   @param created_at [String]
+      #
+      #   @param id [String]
+      #
+      #   @param spec [DockerEngine::Models::Spec]
+      #
+      #   @param updated_at [String]
+      #
+      #   @param version [DockerEngine::Models::Secret::Version] The version number of the object such as node, service, etc. This is needed
+
+      # @see DockerEngine::Models::Secret#version
+      class Version < DockerEngine::Internal::Type::BaseModel
+        # @!attribute index
+        #
+        #   @return [Integer, nil]
+        optional :index, Integer, api_name: :Index
+
+        # @!method initialize(index: nil)
+        #   The version number of the object such as node, service, etc. This is needed to
+        #   avoid conflicting writes. The client must send the version number along with the
+        #   modified specification when updating these objects.
+        #
+        #   This approach ensures safe concurrency and determinism in that the change on the
+        #   object may not be applied if the version number has changed from the last read.
+        #   In other words, if two update requests specify the same base version, only one
+        #   of the requests can succeed. As a result, two separate update requests that
+        #   happen at the same time will not unintentionally overwrite each other.
+        #
+        #   @param index [Integer]
+      end
+    end
+  end
+end

data/lib/docker_engine/models/secret_create_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Secrets#create
+    class SecretCreateParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute spec
+      #
+      #   @return [DockerEngine::Models::SecretCreateParams::Spec, nil]
+      optional :spec, -> { DockerEngine::SecretCreateParams::Spec }
+
+      # @!method initialize(spec: nil, request_options: {})
+      #   @param spec [DockerEngine::Models::SecretCreateParams::Spec]
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+
+      class Spec < DockerEngine::Models::Spec
+        # @!method initialize
+      end
+    end
+  end
+end

data/lib/docker_engine/models/secret_create_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Secrets#create
+    class SecretCreateResponse < DockerEngine::Internal::Type::BaseModel
+      # @!attribute id
+      #   The id of the newly created object.
+      #
+      #   @return [String]
+      required :id, String, api_name: :Id
+
+      # @!method initialize(id:)
+      #   Response to an API call that returns just an Id
+      #
+      #   @param id [String] The id of the newly created object.
+    end
+  end
+end

data/lib/docker_engine/models/secret_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Secrets#delete
+    class SecretDeleteParams < DockerEngine::Internal::Type::BaseModel
+      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/secret_inspect_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Secrets#inspect_
+    class SecretInspectParams < DockerEngine::Internal::Type::BaseModel
+      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/secret_list_params.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Secrets#list
+    class SecretListParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute filters
+      #   A JSON encoded value of the filters (a `map[string][]string`) to process on the
+      #   secrets list.
+      #
+      #   Available filters:
+      #
+      #   - `id=<secret id>`
+      #   - `label=<key> or label=<key>=value`
+      #   - `name=<secret name>`
+      #   - `names=<secret name>`
+      #
+      #   @return [String, nil]
+      optional :filters, String
+
+      # @!method initialize(filters: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::SecretListParams} for more details.
+      #
+      #   @param filters [String] A JSON encoded value of the filters (a `map[string][]string`) to
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/secret_list_response.rb

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

data/lib/docker_engine/models/secret_update_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Secrets#update
+    class SecretUpdateParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute version
+      #   The version number of the secret object being updated. This is required to avoid
+      #   conflicting writes.
+      #
+      #   @return [Integer]
+      required :version, Integer
+
+      # @!method initialize(version:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::SecretUpdateParams} for more details.
+      #
+      #   @param version [Integer] The version number of the secret object being updated. This is
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/service_logs_params.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Services#logs
+    class ServiceLogsParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute details
+      #   Show service context and extra details provided to logs.
+      #
+      #   @return [Boolean, nil]
+      optional :details, DockerEngine::Internal::Type::Boolean
+
+      # @!attribute follow
+      #   Keep connection after returning logs.
+      #
+      #   @return [Boolean, nil]
+      optional :follow, DockerEngine::Internal::Type::Boolean
+
+      # @!attribute since
+      #   Only return logs since this time, as a UNIX timestamp
+      #
+      #   @return [Integer, nil]
+      optional :since, Integer
+
+      # @!attribute stderr
+      #   Return logs from `stderr`
+      #
+      #   @return [Boolean, nil]
+      optional :stderr, DockerEngine::Internal::Type::Boolean
+
+      # @!attribute stdout
+      #   Return logs from `stdout`
+      #
+      #   @return [Boolean, nil]
+      optional :stdout, DockerEngine::Internal::Type::Boolean
+
+      # @!attribute tail
+      #   Only return this number of log lines from the end of the logs. Specify as an
+      #   integer or `all` to output all log lines.
+      #
+      #   @return [String, nil]
+      optional :tail, String
+
+      # @!attribute timestamps
+      #   Add timestamps to every log line
+      #
+      #   @return [Boolean, nil]
+      optional :timestamps, DockerEngine::Internal::Type::Boolean
+
+      # @!method initialize(details: nil, follow: nil, since: nil, stderr: nil, stdout: nil, tail: nil, timestamps: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::ServiceLogsParams} for more details.
+      #
+      #   @param details [Boolean] Show service context and extra details provided to logs.
+      #
+      #   @param follow [Boolean] Keep connection after returning logs.
+      #
+      #   @param since [Integer] Only return logs since this time, as a UNIX timestamp
+      #
+      #   @param stderr [Boolean] Return logs from `stderr`
+      #
+      #   @param stdout [Boolean] Return logs from `stdout`
+      #
+      #   @param tail [String] Only return this number of log lines from the end of the logs.
+      #
+      #   @param timestamps [Boolean] Add timestamps to every log line
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/service_update_params.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Services#update
+    class ServiceUpdateParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute version
+      #   The version number of the service object being updated. This is required to
+      #   avoid conflicting writes. This version number should be the value as currently
+      #   set on the service _before_ the update. You can find the current version by
+      #   calling `GET /services/{id}`
+      #
+      #   @return [Integer]
+      required :version, Integer
+
+      # @!attribute spec
+      #   User modifiable configuration for a service.
+      #
+      #   @return [DockerEngine::Models::ServiceUpdateParams::Spec]
+      required :spec, -> { DockerEngine::ServiceUpdateParams::Spec }
+
+      # @!attribute registry_auth_from
+      #   If the `X-Registry-Auth` header is not specified, this parameter indicates where
+      #   to find registry authorization credentials.
+      #
+      #   @return [Symbol, DockerEngine::Models::ServiceUpdateParams::RegistryAuthFrom, nil]
+      optional :registry_auth_from, enum: -> { DockerEngine::ServiceUpdateParams::RegistryAuthFrom }
+
+      # @!attribute rollback
+      #   Set to this parameter to `previous` to cause a server-side rollback to the
+      #   previous service spec. The supplied spec will be ignored in this case.
+      #
+      #   @return [String, nil]
+      optional :rollback, String
+
+      # @!attribute x_registry_auth
+      #
+      #   @return [String, nil]
+      optional :x_registry_auth, String
+
+      # @!method initialize(version:, spec:, registry_auth_from: nil, rollback: nil, x_registry_auth: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::ServiceUpdateParams} for more details.
+      #
+      #   @param version [Integer] The version number of the service object being updated. This is
+      #
+      #   @param spec [DockerEngine::Models::ServiceUpdateParams::Spec] User modifiable configuration for a service.
+      #
+      #   @param registry_auth_from [Symbol, DockerEngine::Models::ServiceUpdateParams::RegistryAuthFrom] If the `X-Registry-Auth` header is not specified, this parameter
+      #
+      #   @param rollback [String] Set to this parameter to `previous` to cause a server-side rollback
+      #
+      #   @param x_registry_auth [String]
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+
+      class Spec < DockerEngine::Models::Spec
+        # @!method initialize
+        #   User modifiable configuration for a service.
+      end
+
+      # If the `X-Registry-Auth` header is not specified, this parameter indicates where
+      # to find registry authorization credentials.
+      module RegistryAuthFrom
+        extend DockerEngine::Internal::Type::Enum
+
+        SPEC = :spec
+        PREVIOUS_SPEC = :"previous-spec"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end