nomex v0.0.4 Nomex.Allocations

Methods in this module are used to interact with Nomad’s Allocations HTTP API. More information here:

https://www.nomadproject.io/api/allocations.html

Link to this section Summary

Functions

issues a GET request to <NOMAD_HOST>/v1/allocation/<param_id>

issues a GET request to <NOMAD_HOST>/v1/allocation/<param_id>

issues a GET request to <NOMAD_HOST>/v1/allocations

issues a GET request to <NOMAD_HOST>/v1/allocations?prefix=<prefix>

issues a GET request to <NOMAD_HOST>/v1/allocations

issues a GET request to <NOMAD_HOST>/v1/allocations?prefix=<prefix>

Link to this section Functions

Link to this function allocation(param_id)
allocation(String.t()) :: Nomex.Response.tuple_t()

issues a GET request to <NOMAD_HOST>/v1/allocation/<param_id>

returns a tuple with status (:ok, :error) and the %Nomex.Response{}

Link to this function allocation!(param_id)
allocation!(String.t()) :: Nomex.Response.t()

issues a GET request to <NOMAD_HOST>/v1/allocation/<param_id>

returns a %Nomex.Response{} or raises exception

Link to this function allocations()
allocations() :: Nomex.Response.tuple_t()

issues a GET request to <NOMAD_HOST>/v1/allocations

returns a tuple with status (:ok, :error) and the %Nomex.Response{}

Link to this function allocations(prefix)
allocations(String.t()) :: Nomex.Response.tuple_t()

issues a GET request to <NOMAD_HOST>/v1/allocations?prefix=<prefix>

returns a tuple with status (:ok, :error) and the %Nomex.Response{}

Link to this function allocations!()
allocations!() :: Nomex.Response.t()

issues a GET request to <NOMAD_HOST>/v1/allocations

returns a %Nomex.Response{} or raises exception

Link to this function allocations!(prefix)
allocations!(String.t()) :: Nomex.Response.t()

issues a GET request to <NOMAD_HOST>/v1/allocations?prefix=<prefix>

returns a %Nomex.Response{} or raises exception