DockerEngineAPI.Api.Task (ex_docker_api v1.48.1)

API calls for all endpoints tagged Task.

Summary

Functions

task_inspect(connection, id, opts \\ [])

Inspect a task

List tasks

Get task logs Get stdout and stderr logs from a task. See also /containers/{id}/logs. Note: This endpoint works only for services with the local, json-file or journald logging drivers.

Functions

task_inspect(connection, id, opts \\ [])

@spec task_inspect(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DockerEngineAPI.Model.Task.t()}
  | {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:error, Tesla.Env.t()}

Inspect a task

Parameters

connection (DockerEngineAPI.Connection): Connection to server
id (String.t): ID of the task
opts (keyword): Optional parameters

Returns

{:ok, DockerEngineAPI.Model.Task.t} on success
{:error, Tesla.Env.t} on failure

task_list(connection, opts \\ [])

@spec task_list(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, [DockerEngineAPI.Model.Task.t()]}
  | {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:error, Tesla.Env.t()}

List tasks

Parameters

connection (DockerEngineAPI.Connection): Connection to server
opts (keyword): Optional parameters
- :filters (String.t): 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>

Returns

{:ok, [%Task{}, ...]} on success
{:error, Tesla.Env.t} on failure

task_logs(connection, id, opts \\ [])

@spec task_logs(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:ok, String.t()}
  | {:error, Tesla.Env.t()}

Parameters

connection (DockerEngineAPI.Connection): Connection to server
id (String.t): ID of the task
opts (keyword): Optional parameters
- :details (boolean()): Show task context and extra details provided to logs.
- :follow (boolean()): Keep connection after returning logs.
- :stdout (boolean()): Return logs from stdout
- :stderr (boolean()): Return logs from stderr
- :since (integer()): Only return logs since this time, as a UNIX timestamp
- :timestamps (boolean()): Add timestamps to every log line
- :tail (String.t): Only return this number of log lines from the end of the logs. Specify as an integer or all to output all log lines.

Returns

{:ok, String.t} on success
{:error, Tesla.Env.t} on failure