DockerEngineAPI.Api.Config (elixir_dea v1.45.7)

API calls for all endpoints tagged Config.

Summary

Functions

config_create(connection, opts \\ [])

Create a config

config_delete(connection, id, opts \\ [])

Delete a config

config_inspect(connection, id, opts \\ [])

Inspect a config

config_list(connection, opts \\ [])

List configs

config_update(connection, id, version, opts \\ [])

Update a Config

Functions

Link to this function

config_create(connection, opts \\ [])

@spec config_create(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:ok, DockerEngineAPI.Model.IdResponse.t()}
  | {:error, Tesla.Env.t()}

Create a config

Parameters

  • connection (DockerEngineAPI.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :body (ConfigCreateRequest):

Returns

  • {:ok, DockerEngineAPI.Model.IdResponse.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

config_delete(connection, id, opts \\ [])

@spec config_delete(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil}
  | {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:error, Tesla.Env.t()}

Delete a config

Parameters

  • connection (DockerEngineAPI.Connection): Connection to server
  • id (String.t): ID of the config
  • opts (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

config_inspect(connection, id, opts \\ [])

@spec config_inspect(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:ok, DockerEngineAPI.Model.Config.t()}
  | {:error, Tesla.Env.t()}

Inspect a config

Parameters

  • connection (DockerEngineAPI.Connection): Connection to server
  • id (String.t): ID of the config
  • opts (keyword): Optional parameters

Returns

  • {:ok, DockerEngineAPI.Model.Config.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

config_list(connection, opts \\ [])

@spec config_list(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:ok, [DockerEngineAPI.Model.Config.t()]}
  | {:error, Tesla.Env.t()}

List configs

Parameters

  • connection (DockerEngineAPI.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :filters (String.t): A JSON encoded value of the filters (a map[string][]string) to process on the configs list. Available filters: - id=<config id> - label=<key> or label=<key>=value - name=<config name> - names=<config name>

Returns

  • {:ok, [%Config{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

config_update(connection, id, version, opts \\ [])

@spec config_update(Tesla.Env.client(), String.t(), integer(), keyword()) ::
  {:ok, nil}
  | {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:error, Tesla.Env.t()}

Update a Config

Parameters

  • connection (DockerEngineAPI.Connection): Connection to server
  • id (String.t): The ID or name of the config
  • version (integer()): The version number of the config object being updated. This is required to avoid conflicting writes.
  • opts (keyword): Optional parameters
    • :body (ConfigSpec): The spec of the config to update. Currently, only the Labels field can be updated. All other fields must remain unchanged from the ConfigInspect endpoint response values.

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure