NomadClient.Api.System (nomad_client v0.12.4)

API calls for all endpoints tagged System.

Link to this section Summary

Functions

force_gc(connection, opts \\ [])

initializes a garbage collection of jobs, evaluations, allocations, and nodes. This is an asynchronous operation

reconcile_summary(connection, opts \\ [])

reconciles the summaries of all registered jobs

Link to this section Functions

force_gc(connection, opts \\ [])

Specs

force_gc(Tesla.Env.client(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}

initializes a garbage collection of jobs, evaluations, allocations, and nodes. This is an asynchronous operation

Parameters

connection (NomadClient.Connection): Connection to server
opts (KeywordList): [optional] Optional parameters
- :namespace (String.t):
- :region (String.t): Make a request across regions to the given region
- :index (integer()): index used for blocking requests
- :wait (String.t): wait time used for blocking requests
  Returns

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

reconcile_summary(connection, opts \\ [])

Specs

reconcile_summary(Tesla.Env.client(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

reconciles the summaries of all registered jobs

Parameters

connection (NomadClient.Connection): Connection to server
opts (KeywordList): [optional] Optional parameters
- :namespace (String.t):
- :region (String.t): Make a request across regions to the given region
- :index (integer()): index used for blocking requests
- :wait (String.t): wait time used for blocking requests
  Returns

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