DockerAPI v0.4.0

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

Images

official-document

 Official document

https://docs.docker.com/engine/api/v1.41/#tag/Image

Link to this section Summary

Types

id()
t()

Functions

bang!(arg1)
build!(conn, params \\ %{}, body \\ nil, headers \\ [])
build(conn, params \\ %{}, body \\ nil, headers \\ [])
commit!(conn, params \\ %{}, body \\ nil, headers \\ [])
commit(conn, params \\ %{}, body \\ nil, headers \\ [])
create!(conn, params \\ %{}, body \\ nil, headers \\ [])
create(conn, params \\ %{}, body \\ nil, headers \\ [])
handle_json_response(error)
handle_no_response(error)
history!(image, params \\ %{}, headers \\ [])
history(image, params \\ %{}, headers \\ [])
inspect!(image, params \\ %{}, headers \\ [])
inspect(image, params \\ %{}, headers \\ [])
list!(conn, params \\ %{}, headers \\ [])
list(conn, params \\ %{}, headers \\ [])
load!(conn, params \\ %{}, body \\ nil, headers \\ [])
load(conn, params \\ %{}, body \\ nil, headers \\ [])
new(id, conn)
path_for()
path_for(path)
path_for(struct, path)
prune_cache!(conn, params \\ %{}, body \\ nil, headers \\ [])
prune_cache(conn, params \\ %{}, body \\ nil, headers \\ [])
prune_image!(conn, params \\ %{}, body \\ nil, headers \\ [])
prune_image(conn, params \\ %{}, body \\ nil, headers \\ [])
push!(image, params \\ %{}, body \\ nil, headers \\ [])
push(image, params \\ %{}, body \\ nil, headers \\ [])
remove!(image, params \\ %{}, headers \\ [])
remove(image, params \\ %{}, headers \\ [])
search!(conn, params \\ %{}, headers \\ [])
search(conn, params \\ %{}, headers \\ [])
tag!(image, params \\ %{}, body \\ nil, headers \\ [])
tag(image, 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.Image{
  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

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

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

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

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

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

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

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

View Source (since 0.4.0) 
@spec commit(
  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

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
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 | {: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

history!(image, params \\ %{}, headers \\ [])

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

history(image, params \\ %{}, headers \\ [])

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

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

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

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

View Source (since 0.4.0) 
@spec inspect(
  image :: t(),
  params :: DockerAPI.Connection.params(),
  headers :: DockerAPI.Connection.headers()
) :: {:ok, term()} | {: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

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

View Source (since 0.4.0)
Link to this function

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

View Source (since 0.4.0) 
@spec load(
  conn :: DockerAPI.Connection.t(),
  params :: DockerAPI.Connection.params(),
  body :: DockerAPI.Connection.body(),
  headers :: DockerAPI.Connection.headers()
) :: :ok | {:error, DockerAPI.Error.t()}
@spec load(
  conn :: DockerAPI.Connection.t(),
  params :: DockerAPI.Connection.params(),
  body :: DockerAPI.Connection.body(),
  headers :: DockerAPI.Connection.headers()
) :: :ok
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

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

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

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

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

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

View Source (since 0.4.0)
Link to this function

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

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

push!(image, params \\ %{}, body \\ nil, headers \\ [])

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

push(image, params \\ %{}, body \\ nil, headers \\ [])

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

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

View Source (since 0.4.0)
Link to this function

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

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

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

View Source (since 0.4.0)
Link to this function

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

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

tag!(image, params \\ %{}, body \\ nil, headers \\ [])

View Source (since 0.4.0)
Link to this function

tag(image, params \\ %{}, body \\ nil, headers \\ [])

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