DockerAPI v0.4.0

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

Secrets are sensitive data that can be used by services. Swarm mode must be enabled for these endpoints to work.

Link to this section Summary

Types

id()
t()

Functions

bang!(arg1)
create!(conn, params \\ %{}, body \\ nil, headers \\ [])
create(conn, params \\ %{}, body \\ nil, headers \\ [])
delete!(secret, params \\ %{}, headers \\ [])
delete(secret, params \\ %{}, headers \\ [])
handle_json_response(error)
handle_no_response(error)
inspect!(secret, params \\ %{}, headers \\ [])
inspect(secret, params \\ %{}, headers \\ [])
list!(conn, params \\ %{}, headers \\ [])
list(conn, params \\ %{}, headers \\ [])
new(id, conn)
path_for()
path_for(path)
path_for(struct, path)
update!(secret, params \\ %{}, body \\ nil, headers \\ [])
update(secret, 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.Secret{
  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

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

delete!(secret, params \\ %{}, headers \\ [])

View Source (since 0.4.0)
Link to this function

delete(secret, params \\ %{}, headers \\ [])

View Source (since 0.4.0) 
@spec delete(
  secret :: t(),
  params :: DockerAPI.Connection.params(),
  headers :: DockerAPI.Connection.headers()
) :: :ok | {:error, DockerAPI.Error.t()}
@spec delete(
  secret :: t(),
  params :: DockerAPI.Connection.params(),
  headers :: DockerAPI.Connection.headers()
) :: :ok
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!(secret, params \\ %{}, headers \\ [])

View Source (since 0.4.0)
Link to this function

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

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

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

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

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

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

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