docker_engine_api

# NOTE: This class is auto generated by the swagger code generator program.
# https://github.com/swagger-api/swagger-codegen.git
# Do not edit the class manually.

defmodule DockerEngineAPI.Api.System do
  @moduledoc """
  API calls for all endpoints tagged `System`.
  """

  alias DockerEngineAPI.Connection
  import DockerEngineAPI.RequestBuilder

  @doc """
  Check auth configuration
  Validate credentials for a registry and, if available, get an identity token for accessing the registry without password.

  ## Parameters

  - connection (DockerEngineAPI.Connection): Connection to server
  - opts (KeywordList): [optional] Optional parameters
    - :auth_config (AuthConfig): Authentication to check

  ## Returns

  {:ok, %DockerEngineAPI.Model.SystemAuthResponse{}} on success
  {:error, info} on failure
  """
  def system_auth(connection, opts \\ []) do
    optional_params = %{
      :authConfig => :body
    }

    %{}
    |> method(:post)
    |> url("/auth")
    |> add_optional_params(optional_params, opts)
    |> Enum.into([])
    |> (&Connection.request(connection, &1)).()
    |> decode(%DockerEngineAPI.Model.SystemAuthResponse{})
  end

  @doc """
  Get data usage information

  ## Parameters

  - connection (DockerEngineAPI.Connection): Connection to server
  - opts (KeywordList): [optional] Optional parameters
    - :type ([String.t]): Object types, for which to compute and return data.

  ## Returns

  {:ok, %DockerEngineAPI.Model.SystemDataUsageResponse{}} on success
  {:error, info} on failure
  """
  def system_data_usage(connection, opts \\ []) do
    optional_params = %{
      :type => :query
    }

    %{}
    |> method(:get)
    |> url("/system/df")
    |> add_optional_params(optional_params, opts)
    |> Enum.into([])
    |> (&Connection.request(connection, &1)).()
    |> decode(%DockerEngineAPI.Model.SystemDataUsageResponse{})
  end

  @doc """
  Monitor events
  Stream real-time events from the server.  Various objects within Docker report events when something happens to them.  Containers report these events: `attach`, `commit`, `copy`, `create`, `destroy`, `detach`, `die`, `exec_create`, `exec_detach`, `exec_start`, `exec_die`, `export`, `health_status`, `kill`, `oom`, `pause`, `rename`, `resize`, `restart`, `start`, `stop`, `top`, `unpause`, `update`, and `prune`  Images report these events: `delete`, `import`, `load`, `pull`, `push`, `save`, `tag`, `untag`, and `prune`  Volumes report these events: `create`, `mount`, `unmount`, `destroy`, and `prune`  Networks report these events: `create`, `connect`, `disconnect`, `destroy`, `update`, `remove`, and `prune`  The Docker daemon reports these events: `reload`  Services report these events: `create`, `update`, and `remove`  Nodes report these events: `create`, `update`, and `remove`  Secrets report these events: `create`, `update`, and `remove`  Configs report these events: `create`, `update`, and `remove`  The Builder reports `prune` events

  ## Parameters

  - connection (DockerEngineAPI.Connection): Connection to server
  - opts (KeywordList): [optional] Optional parameters
    - :since (String.t): Show events created since this timestamp then stream new events.
    - :until (String.t): Show events created until this timestamp then stop streaming.
    - :filters (String.t): A JSON encoded value of filters (a `map[string][]string`) to process on the event list. Available filters:  - `config=<string>` config name or ID - `container=<string>` container name or ID - `daemon=<string>` daemon name or ID - `event=<string>` event type - `image=<string>` image name or ID - `label=<string>` image or container label - `network=<string>` network name or ID - `node=<string>` node ID - `plugin`=<string> plugin name or ID - `scope`=<string> local or swarm - `secret=<string>` secret name or ID - `service=<string>` service name or ID - `type=<string>` object to filter by, one of `container`, `image`, `volume`, `network`, `daemon`, `plugin`, `node`, `service`, `secret` or `config` - `volume=<string>` volume name

  ## Returns

  {:ok, %DockerEngineAPI.Model.EventMessage{}} on success
  {:error, info} on failure
  """
  def system_events(connection, opts \\ []) do
    optional_params = %{
      :since => :query,
      :until => :query,
      :filters => :query
    }

    %{}
    |> method(:get)
    |> url("/events")
    |> add_optional_params(optional_params, opts)
    |> Enum.into([])
    |> (&Connection.request(connection, &1)).()
    |> decode(%DockerEngineAPI.Model.EventMessage{})
  end

  @doc """
  Get system information

  ## Parameters

  - connection (DockerEngineAPI.Connection): Connection to server
  - opts (KeywordList): [optional] Optional parameters

  ## Returns

  {:ok, %DockerEngineAPI.Model.SystemInfo{}} on success
  {:error, info} on failure
  """
  def system_info(connection, _opts \\ []) do
    %{}
    |> method(:get)
    |> url("/info")
    |> Enum.into([])
    |> (&Connection.request(connection, &1)).()
    |> decode(%DockerEngineAPI.Model.SystemInfo{})
  end

  @doc """
  Ping
  This is a dummy endpoint you can use to test if the server is accessible.

  ## Parameters

  - connection (DockerEngineAPI.Connection): Connection to server
  - opts (KeywordList): [optional] Optional parameters

  ## Returns

  {:ok, %DockerEngineAPI.Model.String.t{}} on success
  {:error, info} on failure
  """
  def system_ping(connection, _opts \\ []) do
    %{}
    |> method(:get)
    |> url("/_ping")
    |> Enum.into([])
    |> (&Connection.request(connection, &1)).()
    |> decode(false)
  end

  @doc """
  Ping
  This is a dummy endpoint you can use to test if the server is accessible.

  ## Parameters

  - connection (DockerEngineAPI.Connection): Connection to server
  - opts (KeywordList): [optional] Optional parameters

  ## Returns

  {:ok, %DockerEngineAPI.Model.String.t{}} on success
  {:error, info} on failure
  """
  def system_ping_head(connection, _opts \\ []) do
    %{}
    |> method(:head)
    |> url("/_ping")
    |> Enum.into([])
    |> (&Connection.request(connection, &1)).()
    |> decode(false)
  end

  @doc """
  Get version
  Returns the version of Docker that is running and various information about the system that Docker is running on.

  ## Parameters

  - connection (DockerEngineAPI.Connection): Connection to server
  - opts (KeywordList): [optional] Optional parameters

  ## Returns

  {:ok, %DockerEngineAPI.Model.SystemVersion{}} on success
  {:error, info} on failure
  """
  def system_version(connection, _opts \\ []) do
    %{}
    |> method(:get)
    |> url("/version")
    |> Enum.into([])
    |> (&Connection.request(connection, &1)).()
    |> decode(%DockerEngineAPI.Model.SystemVersion{})
    |> dbg()
  end
end