docker-engine 0.1.1 → 0.2.0

data/lib/docker_engine/models/task.rb

@@ -0,0 +1,469 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Tasks#inspect_
+    class Task < DockerEngine::Internal::Type::BaseModel
+      # @!attribute assigned_generic_resources
+      #   User-defined resources can be either Integer resources (e.g, `SSD=3`) or String
+      #   resources (e.g, `GPU=UUID1`).
+      #
+      #   @return [Array<DockerEngine::Models::Task::AssignedGenericResource>, nil]
+      optional :assigned_generic_resources,
+               -> { DockerEngine::Internal::Type::ArrayOf[DockerEngine::Task::AssignedGenericResource] },
+               api_name: :AssignedGenericResources
+
+      # @!attribute created_at
+      #
+      #   @return [String, nil]
+      optional :created_at, String, api_name: :CreatedAt
+
+      # @!attribute desired_state
+      #
+      #   @return [Symbol, DockerEngine::Models::Task::DesiredState, nil]
+      optional :desired_state, enum: -> { DockerEngine::Task::DesiredState }, api_name: :DesiredState
+
+      # @!attribute id
+      #   The ID of the task.
+      #
+      #   @return [String, nil]
+      optional :id, String, api_name: :ID
+
+      # @!attribute job_iteration
+      #   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::Task::JobIteration, nil]
+      optional :job_iteration, -> { DockerEngine::Task::JobIteration }, api_name: :JobIteration
+
+      # @!attribute labels
+      #   User-defined key/value metadata.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :labels, DockerEngine::Internal::Type::HashOf[String], api_name: :Labels
+
+      # @!attribute name
+      #   Name of the task.
+      #
+      #   @return [String, nil]
+      optional :name, String, api_name: :Name
+
+      # @!attribute node_id
+      #   The ID of the node that this task is on.
+      #
+      #   @return [String, nil]
+      optional :node_id, String, api_name: :NodeID
+
+      # @!attribute service_id
+      #   The ID of the service this task is part of.
+      #
+      #   @return [String, nil]
+      optional :service_id, String, api_name: :ServiceID
+
+      # @!attribute slot
+      #
+      #   @return [Integer, nil]
+      optional :slot, Integer, api_name: :Slot
+
+      # @!attribute spec
+      #   User modifiable task configuration.
+      #
+      #   @return [DockerEngine::Models::Spec, nil]
+      optional :spec, -> { DockerEngine::Spec }, api_name: :Spec
+
+      # @!attribute status
+      #   represents the status of a task.
+      #
+      #   @return [DockerEngine::Models::Task::Status, nil]
+      optional :status, -> { DockerEngine::Task::Status }, api_name: :Status
+
+      # @!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::Task::Version, nil]
+      optional :version, -> { DockerEngine::Task::Version }, api_name: :Version
+
+      # @!method initialize(assigned_generic_resources: nil, created_at: nil, desired_state: nil, id: nil, job_iteration: nil, labels: nil, name: nil, node_id: nil, service_id: nil, slot: nil, spec: nil, status: nil, updated_at: nil, version: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::Task} for more details.
+      #
+      #   @param assigned_generic_resources [Array<DockerEngine::Models::Task::AssignedGenericResource>] User-defined resources can be either Integer resources (e.g, `SSD=3`) or
+      #
+      #   @param created_at [String]
+      #
+      #   @param desired_state [Symbol, DockerEngine::Models::Task::DesiredState]
+      #
+      #   @param id [String] The ID of the task.
+      #
+      #   @param job_iteration [DockerEngine::Models::Task::JobIteration] The version number of the object such as node, service, etc. This is needed
+      #
+      #   @param labels [Hash{Symbol=>String}] User-defined key/value metadata.
+      #
+      #   @param name [String] Name of the task.
+      #
+      #   @param node_id [String] The ID of the node that this task is on.
+      #
+      #   @param service_id [String] The ID of the service this task is part of.
+      #
+      #   @param slot [Integer]
+      #
+      #   @param spec [DockerEngine::Models::Spec] User modifiable task configuration.
+      #
+      #   @param status [DockerEngine::Models::Task::Status] represents the status of a task.
+      #
+      #   @param updated_at [String]
+      #
+      #   @param version [DockerEngine::Models::Task::Version] The version number of the object such as node, service, etc. This is needed
+
+      class AssignedGenericResource < DockerEngine::Internal::Type::BaseModel
+        # @!attribute discrete_resource_spec
+        #
+        #   @return [DockerEngine::Models::Task::AssignedGenericResource::DiscreteResourceSpec, nil]
+        optional :discrete_resource_spec,
+                 -> { DockerEngine::Task::AssignedGenericResource::DiscreteResourceSpec },
+                 api_name: :DiscreteResourceSpec
+
+        # @!attribute named_resource_spec
+        #
+        #   @return [DockerEngine::Models::Task::AssignedGenericResource::NamedResourceSpec, nil]
+        optional :named_resource_spec,
+                 -> { DockerEngine::Task::AssignedGenericResource::NamedResourceSpec },
+                 api_name: :NamedResourceSpec
+
+        # @!method initialize(discrete_resource_spec: nil, named_resource_spec: nil)
+        #   @param discrete_resource_spec [DockerEngine::Models::Task::AssignedGenericResource::DiscreteResourceSpec]
+        #   @param named_resource_spec [DockerEngine::Models::Task::AssignedGenericResource::NamedResourceSpec]
+
+        # @see DockerEngine::Models::Task::AssignedGenericResource#discrete_resource_spec
+        class DiscreteResourceSpec < DockerEngine::Internal::Type::BaseModel
+          # @!attribute kind
+          #
+          #   @return [String, nil]
+          optional :kind, String, api_name: :Kind
+
+          # @!attribute value
+          #
+          #   @return [Integer, nil]
+          optional :value, Integer, api_name: :Value
+
+          # @!method initialize(kind: nil, value: nil)
+          #   @param kind [String]
+          #   @param value [Integer]
+        end
+
+        # @see DockerEngine::Models::Task::AssignedGenericResource#named_resource_spec
+        class NamedResourceSpec < DockerEngine::Internal::Type::BaseModel
+          # @!attribute kind
+          #
+          #   @return [String, nil]
+          optional :kind, String, api_name: :Kind
+
+          # @!attribute value
+          #
+          #   @return [String, nil]
+          optional :value, String, api_name: :Value
+
+          # @!method initialize(kind: nil, value: nil)
+          #   @param kind [String]
+          #   @param value [String]
+        end
+      end
+
+      # @see DockerEngine::Models::Task#desired_state
+      module DesiredState
+        extend DockerEngine::Internal::Type::Enum
+
+        NEW = :new
+        ALLOCATED = :allocated
+        PENDING = :pending
+        ASSIGNED = :assigned
+        ACCEPTED = :accepted
+        PREPARING = :preparing
+        READY = :ready
+        STARTING = :starting
+        RUNNING = :running
+        COMPLETE = :complete
+        SHUTDOWN = :shutdown
+        FAILED = :failed
+        REJECTED = :rejected
+        REMOVE = :remove
+        ORPHANED = :orphaned
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see DockerEngine::Models::Task#job_iteration
+      class JobIteration < 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
+
+      # @see DockerEngine::Models::Task#status
+      class Status < DockerEngine::Internal::Type::BaseModel
+        # @!attribute container_status
+        #   represents the status of a container.
+        #
+        #   @return [DockerEngine::Models::Task::Status::ContainerStatus, nil]
+        optional :container_status,
+                 -> {
+                   DockerEngine::Task::Status::ContainerStatus
+                 },
+                 api_name: :ContainerStatus
+
+        # @!attribute err
+        #
+        #   @return [String, nil]
+        optional :err, String, api_name: :Err
+
+        # @!attribute message
+        #
+        #   @return [String, nil]
+        optional :message, String, api_name: :Message
+
+        # @!attribute port_status
+        #   represents the port status of a task's host ports whose service has published
+        #   host ports
+        #
+        #   @return [DockerEngine::Models::Task::Status::PortStatus, nil]
+        optional :port_status, -> { DockerEngine::Task::Status::PortStatus }, api_name: :PortStatus
+
+        # @!attribute state
+        #
+        #   @return [Symbol, DockerEngine::Models::Task::Status::State, nil]
+        optional :state, enum: -> { DockerEngine::Task::Status::State }, api_name: :State
+
+        # @!attribute timestamp
+        #
+        #   @return [String, nil]
+        optional :timestamp, String, api_name: :Timestamp
+
+        # @!method initialize(container_status: nil, err: nil, message: nil, port_status: nil, state: nil, timestamp: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {DockerEngine::Models::Task::Status} for more details.
+        #
+        #   represents the status of a task.
+        #
+        #   @param container_status [DockerEngine::Models::Task::Status::ContainerStatus] represents the status of a container.
+        #
+        #   @param err [String]
+        #
+        #   @param message [String]
+        #
+        #   @param port_status [DockerEngine::Models::Task::Status::PortStatus] represents the port status of a task's host ports whose service has published ho
+        #
+        #   @param state [Symbol, DockerEngine::Models::Task::Status::State]
+        #
+        #   @param timestamp [String]
+
+        # @see DockerEngine::Models::Task::Status#container_status
+        class ContainerStatus < DockerEngine::Internal::Type::BaseModel
+          # @!attribute container_id
+          #
+          #   @return [String, nil]
+          optional :container_id, String, api_name: :ContainerID
+
+          # @!attribute exit_code
+          #
+          #   @return [Integer, nil]
+          optional :exit_code, Integer, api_name: :ExitCode
+
+          # @!attribute pid
+          #
+          #   @return [Integer, nil]
+          optional :pid, Integer, api_name: :PID
+
+          # @!method initialize(container_id: nil, exit_code: nil, pid: nil)
+          #   represents the status of a container.
+          #
+          #   @param container_id [String]
+          #   @param exit_code [Integer]
+          #   @param pid [Integer]
+        end
+
+        # @see DockerEngine::Models::Task::Status#port_status
+        class PortStatus < DockerEngine::Internal::Type::BaseModel
+          # @!attribute ports
+          #
+          #   @return [Array<DockerEngine::Models::Task::Status::PortStatus::Port>, nil]
+          optional :ports,
+                   -> { DockerEngine::Internal::Type::ArrayOf[DockerEngine::Task::Status::PortStatus::Port] },
+                   api_name: :Ports
+
+          # @!method initialize(ports: nil)
+          #   represents the port status of a task's host ports whose service has published
+          #   host ports
+          #
+          #   @param ports [Array<DockerEngine::Models::Task::Status::PortStatus::Port>]
+
+          class Port < DockerEngine::Internal::Type::BaseModel
+            # @!attribute name
+            #
+            #   @return [String, nil]
+            optional :name, String, api_name: :Name
+
+            # @!attribute protocol
+            #
+            #   @return [Symbol, DockerEngine::Models::Task::Status::PortStatus::Port::Protocol, nil]
+            optional :protocol,
+                     enum: -> { DockerEngine::Task::Status::PortStatus::Port::Protocol },
+                     api_name: :Protocol
+
+            # @!attribute published_port
+            #   The port on the swarm hosts.
+            #
+            #   @return [Integer, nil]
+            optional :published_port, Integer, api_name: :PublishedPort
+
+            # @!attribute publish_mode
+            #   The mode in which port is published.
+            #
+            #   <p><br /></p>
+            #
+            #   - "ingress" makes the target port accessible on every node, regardless of
+            #     whether there is a task for the service running on that node or not.
+            #   - "host" bypasses the routing mesh and publish the port directly on the swarm
+            #     node where that service is running.
+            #
+            #   @return [Symbol, DockerEngine::Models::Task::Status::PortStatus::Port::PublishMode, nil]
+            optional :publish_mode,
+                     enum: -> { DockerEngine::Task::Status::PortStatus::Port::PublishMode },
+                     api_name: :PublishMode
+
+            # @!attribute target_port
+            #   The port inside the container.
+            #
+            #   @return [Integer, nil]
+            optional :target_port, Integer, api_name: :TargetPort
+
+            # @!method initialize(name: nil, protocol: nil, published_port: nil, publish_mode: nil, target_port: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {DockerEngine::Models::Task::Status::PortStatus::Port} for more details.
+            #
+            #   @param name [String]
+            #
+            #   @param protocol [Symbol, DockerEngine::Models::Task::Status::PortStatus::Port::Protocol]
+            #
+            #   @param published_port [Integer] The port on the swarm hosts.
+            #
+            #   @param publish_mode [Symbol, DockerEngine::Models::Task::Status::PortStatus::Port::PublishMode] The mode in which port is published.
+            #
+            #   @param target_port [Integer] The port inside the container.
+
+            # @see DockerEngine::Models::Task::Status::PortStatus::Port#protocol
+            module Protocol
+              extend DockerEngine::Internal::Type::Enum
+
+              TCP = :tcp
+              UDP = :udp
+              SCTP = :sctp
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # The mode in which port is published.
+            #
+            # <p><br /></p>
+            #
+            # - "ingress" makes the target port accessible on every node, regardless of
+            #   whether there is a task for the service running on that node or not.
+            # - "host" bypasses the routing mesh and publish the port directly on the swarm
+            #   node where that service is running.
+            #
+            # @see DockerEngine::Models::Task::Status::PortStatus::Port#publish_mode
+            module PublishMode
+              extend DockerEngine::Internal::Type::Enum
+
+              INGRESS = :ingress
+              HOST = :host
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+
+        # @see DockerEngine::Models::Task::Status#state
+        module State
+          extend DockerEngine::Internal::Type::Enum
+
+          NEW = :new
+          ALLOCATED = :allocated
+          PENDING = :pending
+          ASSIGNED = :assigned
+          ACCEPTED = :accepted
+          PREPARING = :preparing
+          READY = :ready
+          STARTING = :starting
+          RUNNING = :running
+          COMPLETE = :complete
+          SHUTDOWN = :shutdown
+          FAILED = :failed
+          REJECTED = :rejected
+          REMOVE = :remove
+          ORPHANED = :orphaned
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # @see DockerEngine::Models::Task#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/task_inspect_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Tasks#inspect_
+    class TaskInspectParams < 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/task_list_params.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Tasks#list
+    class TaskListParams < 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
+      #   tasks list.
+      #
+      #   Available filters:
+      #
+      #   - `desired-state=(running | shutdown | accepted)`
+      #   - `id=<task id>`
+      #   - `label=key` or `label="key=value"`
+      #   - `name=<task name>`
+      #   - `node=<node id or name>`
+      #   - `service=<service name>`
+      #
+      #   @return [String, nil]
+      optional :filters, String
+
+      # @!method initialize(filters: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::TaskListParams} 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/task_list_response.rb

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

data/lib/docker_engine/models/task_logs_params.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Tasks#logs
+    class TaskLogsParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute details
+      #   Show task 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::TaskLogsParams} for more details.
+      #
+      #   @param details [Boolean] Show task 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/top_response.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Containers#top
+    class TopResponse < DockerEngine::Internal::Type::BaseModel
+      # @!attribute processes
+      #   Each process running in the container, where each process is an array of values
+      #   corresponding to the titles.
+      #
+      #   @return [Array<Array<String>>, nil]
+      optional :processes,
+               DockerEngine::Internal::Type::ArrayOf[DockerEngine::Internal::Type::ArrayOf[String]],
+               api_name: :Processes
+
+      # @!attribute titles
+      #   The ps column titles
+      #
+      #   @return [Array<String>, nil]
+      optional :titles, DockerEngine::Internal::Type::ArrayOf[String], api_name: :Titles
+
+      # @!method initialize(processes: nil, titles: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::TopResponse} for more details.
+      #
+      #   Container "top" response.
+      #
+      #   @param processes [Array<Array<String>>] Each process running in the container, where each process
+      #
+      #   @param titles [Array<String>] The ps column titles
+    end
+  end
+end

data/lib/docker_engine/models/update_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Containers#update
+    class UpdateResponse < DockerEngine::Internal::Type::BaseModel
+      # @!attribute warnings
+      #   Warnings encountered when updating the container.
+      #
+      #   @return [Array<String>, nil]
+      optional :warnings, DockerEngine::Internal::Type::ArrayOf[String], api_name: :Warnings
+
+      # @!method initialize(warnings: nil)
+      #   Response for a successful container-update.
+      #
+      #   @param warnings [Array<String>] Warnings encountered when updating the container.
+    end
+  end
+end