NomadClient.Api.Regions (nomad_client v0.13.0)

API calls for all endpoints tagged Regions.

Link to this section Summary

Functions

get_regions(connection, opts \\ [])

Parameters

connection (NomadClient.Connection): Connection to server
opts (keyword): Optional parameters

Returns

{:ok, [%String{}, ...]} on success
{:error, Tesla.Env.t} on failure

Link to this section Functions

get_regions(connection, opts \\ [])

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

parameters
Parameters

connection (NomadClient.Connection): Connection to server
opts (keyword): Optional parameters

returns
Returns

{:ok, [%String{}, ...]} on success
{:error, Tesla.Env.t} on failure