DockerAPI v0.4.0

View Source DockerAPI.Endpoints.Container (DockerAPI v0.4.0)

Create and manage containers.

official-document

 Official document

Create and manage containers.

Link to this section Summary

Types

id()
t()

Functions

bang!(arg1)
changes!(container, params \\ %{}, headers \\ [])
create!(conn, params \\ %{}, body \\ nil, headers \\ [])
create(conn, params \\ %{}, body \\ nil, headers \\ [])
export!(container, params \\ %{}, headers \\ [])
export(container, params \\ %{}, headers \\ [])
get_archive_by_get!(container, params \\ %{}, headers \\ [])
get_archive_by_get(container, params \\ %{}, headers \\ [])
get_archive_by_head!(container, params \\ %{}, headers \\ [])
get_archive_by_head(container, params \\ %{}, headers \\ [])
handle_json_response(error)
handle_no_response(error)
inspect!(container, params \\ %{}, headers \\ [])
inspect(container, params \\ %{}, headers \\ [])
kill!(container, params \\ %{}, body \\ nil, headers \\ [])
kill(container, params \\ %{}, body \\ nil, headers \\ [])
list!(conn, params \\ %{}, headers \\ [])
list(conn, params \\ %{}, headers \\ [])
logs!(container, params, headers)
new(id, conn)
path_for()
path_for(path)
path_for(struct, path)
pause!(container, params \\ %{}, body \\ nil, headers \\ [])
pause(container, params \\ %{}, body \\ nil, headers \\ [])
prune!(conn, params \\ %{}, body \\ nil, headers \\ [])
prune(conn, params \\ %{}, body \\ nil, headers \\ [])
put_archive!(container, params \\ %{}, body \\ nil, headers \\ [])
put_archive(container, params \\ %{}, body \\ nil, headers \\ [])
remove!(container, params \\ %{}, headers \\ [])
remove(container, params \\ %{}, headers \\ [])
rename!(container, params \\ %{}, body \\ nil, headers \\ [])
rename(container, params \\ %{}, body \\ nil, headers \\ [])
resize!(container, params \\ %{}, body \\ nil, headers \\ [])
resize(container, params \\ %{}, body \\ nil, headers \\ [])
restart!(container, params \\ %{}, body \\ nil, headers \\ [])
restart(container, params \\ %{}, body \\ nil, headers \\ [])
start!(container, params \\ %{}, body \\ nil, headers \\ [])
start(container, params \\ %{}, body \\ nil, headers \\ [])
stats!(container, params \\ %{}, headers \\ [])
stats(container, params \\ %{}, headers \\ [])
stop!(container, params \\ %{}, body \\ nil, headers \\ [])
stop(container, params \\ %{}, body \\ nil, headers \\ [])
top!(container, params \\ %{}, headers \\ [])
top(container, params \\ %{}, headers \\ [])
unpause!(container, params \\ %{}, body \\ nil, headers \\ [])
unpause(container, params \\ %{}, body \\ nil, headers \\ [])
update!(container, params \\ %{}, body \\ nil, headers \\ [])
update(container, params \\ %{}, body \\ nil, headers \\ [])
wait!(container, params \\ %{}, body \\ nil, headers \\ [])
wait(container, params \\ %{}, body \\ nil, headers \\ [])

Link to this section Types

Link to this type

id()

View Source 
@type id() :: String.t()
Link to this type

t()

View Source 
@type t() :: %DockerAPI.Endpoints.Container{
  connection: DockerAPI.Connection.t(),
  id: id()
}

Link to this section Functions

Link to this function

bang!(arg1)

View Source 
@spec bang!(:ok) :: :ok
@spec bang!({:ok, term()}) :: term()
@spec bang!({:error, DockerAPI.Error.t()}) :: no_return()
Link to this function

changes!(container, params \\ %{}, headers \\ [])

View Source (since 0.4.0) 
@spec changes!(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  headers :: DockerAPI.Connection.headers()
) :: term()
Link to this function

create!(conn, params \\ %{}, body \\ nil, headers \\ [])

View Source (since 0.4.0) 
@spec create!(
  conn :: DockerAPI.Connection.t(),
  params :: DockerAPI.Connection.params(),
  body :: DockerAPI.Connection.body(),
  headers :: DockerAPI.Connection.headers()
) :: t()
Link to this function

create(conn, params \\ %{}, body \\ nil, headers \\ [])

View Source (since 0.4.0) 
@spec create(
  conn :: DockerAPI.Connection.t(),
  params :: DockerAPI.Connection.params(),
  body :: DockerAPI.Connection.body(),
  headers :: DockerAPI.Connection.headers()
) :: {:ok, t()} | {:error, DockerAPI.Error.t()}
Link to this function

export!(container, params \\ %{}, headers \\ [])

View Source (since 0.4.0) 
@spec export!(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  headers :: DockerAPI.Connection.headers()
) :: binary()
Link to this function

export(container, params \\ %{}, headers \\ [])

View Source (since 0.4.0) 
@spec export(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  headers :: DockerAPI.Connection.headers()
) :: {:ok, binary()} | {:error, DockerAPI.Error.t()}
Link to this function

get_archive_by_get!(container, params \\ %{}, headers \\ [])

View Source (since 0.4.0) 
@spec get_archive_by_get!(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  headers :: DockerAPI.Connection.headers()
) :: binary()
Link to this function

get_archive_by_get(container, params \\ %{}, headers \\ [])

View Source (since 0.4.0) 
@spec get_archive_by_get(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  headers :: DockerAPI.Connection.headers()
) :: {:ok, binary()} | {:error, DockerAPI.Error.t()}
Link to this function

get_archive_by_head!(container, params \\ %{}, headers \\ [])

View Source (since 0.4.0) 
@spec get_archive_by_head!(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  headers :: DockerAPI.Connection.headers()
) :: binary()
Link to this function

get_archive_by_head(container, params \\ %{}, headers \\ [])

View Source (since 0.4.0) 
@spec get_archive_by_head(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  headers :: DockerAPI.Connection.headers()
) :: {:ok, binary()} | {:error, DockerAPI.Error.t()}
Link to this function

handle_json_response(error)

View Source 
@spec handle_json_response({:ok, binary()}) :: {:ok, term()}
@spec handle_json_response({:error, DockerAPI.Error.t()}) ::
  {:error, DockerAPI.Error.t()}
Link to this function

handle_no_response(error)

View Source 
@spec handle_no_response({:ok, term()}) :: :ok
@spec handle_no_response({:error, DockerAPI.Error.t()}) ::
  {:error, DockerAPI.Error.t()}
Link to this function

inspect!(container, params \\ %{}, headers \\ [])

View Source (since 0.4.0) 
@spec inspect!(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  headers :: DockerAPI.Connection.headers()
) :: term()
Link to this function

inspect(container, params \\ %{}, headers \\ [])

View Source (since 0.4.0) 
@spec inspect(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  headers :: DockerAPI.Connection.headers()
) :: {:ok, term()} | {:error, DockerAPI.Error.t()}
Link to this function

kill!(container, params \\ %{}, body \\ nil, headers \\ [])

View Source (since 0.4.0) 
@spec kill!(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  body :: DockerAPI.Connection.body(),
  headers :: DockerAPI.Connection.headers()
) :: :ok
Link to this function

kill(container, params \\ %{}, body \\ nil, headers \\ [])

View Source (since 0.4.0) 
@spec kill(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  body :: DockerAPI.Connection.body(),
  headers :: DockerAPI.Connection.headers()
) :: :ok | {:error, DockerAPI.Error.t()}
Link to this function

list!(conn, params \\ %{}, headers \\ [])

View Source (since 0.4.0) 
@spec list!(
  conn :: DockerAPI.Connection.t(),
  params :: DockerAPI.Connection.params(),
  headers :: DockerAPI.Connection.headers()
) :: [t(), ...]
Link to this function

list(conn, params \\ %{}, headers \\ [])

View Source (since 0.4.0) 
@spec list(
  conn :: DockerAPI.Connection.t(),
  params :: DockerAPI.Connection.params(),
  headers :: DockerAPI.Connection.headers()
) :: {:ok, [t(), ...]} | {:error, DockerAPI.Error.t()}
Link to this function

logs!(container, params, headers)

View Source 
@spec logs!(
  _container :: t(),
  _params :: DockerAPI.Connection.params(),
  _headers :: DockerAPI.Connection.headers()
) :: :none
Link to this function

new(id, conn)

View Source
Link to this function

path_for()

View Source
Link to this function

path_for(path)

View Source
Link to this function

path_for(struct, path)

View Source
Link to this function

pause!(container, params \\ %{}, body \\ nil, headers \\ [])

View Source (since 0.4.0) 
@spec pause!(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  body :: DockerAPI.Connection.body(),
  headers :: DockerAPI.Connection.headers()
) :: :ok
Link to this function

pause(container, params \\ %{}, body \\ nil, headers \\ [])

View Source (since 0.4.0) 
@spec pause(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  body :: DockerAPI.Connection.body(),
  headers :: DockerAPI.Connection.headers()
) :: :ok | {:error, DockerAPI.Error.t()}
Link to this function

prune!(conn, params \\ %{}, body \\ nil, headers \\ [])

View Source (since 0.4.0) 
@spec prune!(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  body :: DockerAPI.Connection.body(),
  headers :: DockerAPI.Connection.headers()
) :: term()
Link to this function

prune(conn, params \\ %{}, body \\ nil, headers \\ [])

View Source (since 0.4.0) 
@spec prune(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  body :: DockerAPI.Connection.body(),
  headers :: DockerAPI.Connection.headers()
) :: {:ok, term()} | {:error, DockerAPI.Error.t()}
Link to this function

put_archive!(container, params \\ %{}, body \\ nil, headers \\ [])

View Source (since 0.4.0) 
@spec put_archive!(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  body :: DockerAPI.Connection.body(),
  headers :: DockerAPI.Connection.headers()
) :: :ok
Link to this function

put_archive(container, params \\ %{}, body \\ nil, headers \\ [])

View Source (since 0.4.0) 
@spec put_archive(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  body :: DockerAPI.Connection.body(),
  headers :: DockerAPI.Connection.headers()
) :: :ok | {:error, DockerAPI.Error.t()}
Link to this function

remove!(container, params \\ %{}, headers \\ [])

View Source (since 0.4.0) 
@spec remove!(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  headers :: DockerAPI.Connection.headers()
) :: :ok
Link to this function

remove(container, params \\ %{}, headers \\ [])

View Source (since 0.4.0) 
@spec remove(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  headers :: DockerAPI.Connection.headers()
) :: :ok | {:error, DockerAPI.Error.t()}
Link to this function

rename!(container, params \\ %{}, body \\ nil, headers \\ [])

View Source (since 0.4.0) 
@spec rename!(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  body :: DockerAPI.Connection.body(),
  headers :: DockerAPI.Connection.headers()
) :: :ok
Link to this function

rename(container, params \\ %{}, body \\ nil, headers \\ [])

View Source (since 0.4.0) 
@spec rename(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  body :: DockerAPI.Connection.body(),
  headers :: DockerAPI.Connection.headers()
) :: :ok | {:error, DockerAPI.Error.t()}
Link to this function

resize!(container, params \\ %{}, body \\ nil, headers \\ [])

View Source (since 0.4.0) 
@spec resize!(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  body :: DockerAPI.Connection.body(),
  headers :: DockerAPI.Connection.headers()
) :: :ok
Link to this function

resize(container, params \\ %{}, body \\ nil, headers \\ [])

View Source (since 0.4.0) 
@spec resize(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  body :: DockerAPI.Connection.body(),
  headers :: DockerAPI.Connection.headers()
) :: :ok | {:error, DockerAPI.Error.t()}
Link to this function

restart!(container, params \\ %{}, body \\ nil, headers \\ [])

View Source (since 0.4.0) 
@spec restart!(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  body :: DockerAPI.Connection.body(),
  headers :: DockerAPI.Connection.headers()
) :: :ok
Link to this function

restart(container, params \\ %{}, body \\ nil, headers \\ [])

View Source (since 0.4.0) 
@spec restart(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  body :: DockerAPI.Connection.body(),
  headers :: DockerAPI.Connection.headers()
) :: :ok | {:error, DockerAPI.Error.t()}
Link to this function

start!(container, params \\ %{}, body \\ nil, headers \\ [])

View Source (since 0.4.0) 
@spec start!(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  body :: DockerAPI.Connection.body(),
  headers :: DockerAPI.Connection.headers()
) :: :ok
Link to this function

start(container, params \\ %{}, body \\ nil, headers \\ [])

View Source (since 0.4.0) 
@spec start(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  body :: DockerAPI.Connection.body(),
  headers :: DockerAPI.Connection.headers()
) :: :ok | {:error, DockerAPI.Error.t()}
Link to this function

stats!(container, params \\ %{}, headers \\ [])

View Source (since 0.4.0) 
@spec stats!(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  headers :: DockerAPI.Connection.headers()
) :: term()
Link to this function

stats(container, params \\ %{}, headers \\ [])

View Source (since 0.4.0) 
@spec stats(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  headers :: DockerAPI.Connection.headers()
) :: {:ok, term()} | {:error, DockerAPI.Error.t()}
Link to this function

stop!(container, params \\ %{}, body \\ nil, headers \\ [])

View Source (since 0.4.0) 
@spec stop!(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  body :: DockerAPI.Connection.body(),
  headers :: DockerAPI.Connection.headers()
) :: :ok
Link to this function

stop(container, params \\ %{}, body \\ nil, headers \\ [])

View Source (since 0.4.0) 
@spec stop(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  body :: DockerAPI.Connection.body(),
  headers :: DockerAPI.Connection.headers()
) :: :ok | {:error, DockerAPI.Error.t()}
Link to this function

top!(container, params \\ %{}, headers \\ [])

View Source (since 0.4.0) 
@spec top!(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  headers :: DockerAPI.Connection.headers()
) :: term()
Link to this function

top(container, params \\ %{}, headers \\ [])

View Source (since 0.4.0) 
@spec top(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  headers :: DockerAPI.Connection.headers()
) :: {:ok, term()} | {:error, DockerAPI.Error.t()}
Link to this function

unpause!(container, params \\ %{}, body \\ nil, headers \\ [])

View Source (since 0.4.0)
Link to this function

unpause(container, params \\ %{}, body \\ nil, headers \\ [])

View Source (since 0.4.0) 
@spec unpause(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  body :: DockerAPI.Connection.body(),
  headers :: DockerAPI.Connection.headers()
) :: :ok | {:error, DockerAPI.Error.t()}
@spec unpause(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  body :: DockerAPI.Connection.body(),
  headers :: DockerAPI.Connection.headers()
) :: :ok
Link to this function

update!(container, params \\ %{}, body \\ nil, headers \\ [])

View Source (since 0.4.0) 
@spec update!(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  body :: DockerAPI.Connection.body(),
  headers :: DockerAPI.Connection.headers()
) :: term()
Link to this function

update(container, params \\ %{}, body \\ nil, headers \\ [])

View Source (since 0.4.0) 
@spec update(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  body :: DockerAPI.Connection.body(),
  headers :: DockerAPI.Connection.headers()
) :: {:ok, term()} | {:error, DockerAPI.Error.t()}
Link to this function

wait!(container, params \\ %{}, body \\ nil, headers \\ [])

View Source (since 0.4.0) 
@spec wait!(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  body :: DockerAPI.Connection.body(),
  headers :: DockerAPI.Connection.headers()
) :: term()
Link to this function

wait(container, params \\ %{}, body \\ nil, headers \\ [])

View Source (since 0.4.0) 
@spec wait(
  container :: t(),
  params :: DockerAPI.Connection.params(),
  body :: DockerAPI.Connection.body(),
  headers :: DockerAPI.Connection.headers()
) :: {:ok, term()} | {:error, DockerAPI.Error.t()}