DockerAPI v0.4.0

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

Engines can be clustered together in a swarm. Refer to the swarm mode documentation for more information.

official-document

 Official document

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

Link to this section Summary

Functions

bang!(arg1)
handle_json_response(error)
handle_no_response(error)
initialize!(conn, params \\ %{}, body \\ nil, headers \\ [])
initialize(conn, params \\ %{}, body \\ nil, headers \\ [])
inspect!(conn, params \\ %{}, headers \\ [])
inspect(conn, params \\ %{}, headers \\ [])
join!(conn, params \\ %{}, body \\ nil, headers \\ [])
join(conn, params \\ %{}, body \\ nil, headers \\ [])
leave!(conn, params \\ %{}, headers \\ [])
leave(conn, params \\ %{}, headers \\ [])
new(id, conn)
path_for()
path_for(path)
path_for(struct, path)
unlock!(conn, params \\ %{}, body \\ nil, headers \\ [])
unlock(conn, params \\ %{}, body \\ nil, headers \\ [])
unlock_key!(conn, params \\ %{}, headers \\ [])
unlock_key(conn, params \\ %{}, headers \\ [])
update!(conn, params \\ %{}, body \\ nil, headers \\ [])
update(conn, params \\ %{}, body \\ nil, headers \\ [])

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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