View Source DockerAPI.Endpoints.Task (DockerAPI v0.4.0)
A task is a container running on a swarm. It is the atomic scheduling unit of swarm. Swarm mode must be enabled for these endpoints to work.
official-document
Official document
Link to this section Summary
Link to this section Types
@type id() :: String.t()
@type t() :: %DockerAPI.Endpoints.Task{connection: DockerAPI.Connection.t(), id: id()}
Link to this section Functions
@spec bang!(:ok) :: :ok
@spec bang!({:ok, term()}) :: term()
@spec bang!({:error, DockerAPI.Error.t()}) :: no_return()
@spec handle_json_response({:ok, binary()}) :: {:ok, term()}
@spec handle_json_response({:error, DockerAPI.Error.t()}) :: {:error, DockerAPI.Error.t()}
@spec handle_no_response({:ok, term()}) :: :ok
@spec handle_no_response({:error, DockerAPI.Error.t()}) :: {:error, DockerAPI.Error.t()}
@spec inspect!( task :: t(), params :: DockerAPI.Connection.params(), headers :: DockerAPI.Connection.headers() ) :: term()
@spec inspect( task :: t(), params :: DockerAPI.Connection.params(), headers :: DockerAPI.Connection.headers() ) :: {:ok, term()} | {:error, DockerAPI.Error.t()}
@spec list!( conn :: DockerAPI.Connection.t(), params :: DockerAPI.Connection.params(), headers :: DockerAPI.Connection.headers() ) :: [t(), ...]
@spec list( conn :: DockerAPI.Connection.t(), params :: DockerAPI.Connection.params(), headers :: DockerAPI.Connection.headers() ) :: {:ok, [t(), ...]} | {:error, DockerAPI.Error.t()}