NomadClient.Api.Regions (nomad_client v0.12.4)

API calls for all endpoints tagged Regions.

Link to this section Summary

Link to this section Functions

Link to this function

get_regions(connection, opts \\ [])

Specs

get_regions(Tesla.Env.client(), keyword()) ::
  {:ok, [String.t()]} | {:error, Tesla.Env.t()}

list all known regions

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