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

System

official-document

Official document

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

Link to this section Summary

Link to this section Functions

Link to this function

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

View Source (since 0.4.0)
Link to this function

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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