nomad_client v0.12.4

NomadClient.Api.Evaluations (nomad_client v0.12.4)

API calls for all endpoints tagged Evaluations.

Link to this section Summary

Functions

get_allocations_for_evaluation(connection, eval_id, opts \\ [])

lists the allocations created or modified for the given evaluation

get_evaluation(connection, eval_id, opts \\ [])

reads information about a specific evaluation by ID

get_evaluations(connection, opts \\ [])

lists all evaluations

Link to this section Functions

Link to this function

get_allocations_for_evaluation(connection, eval_id, opts \\ [])

Specs

get_allocations_for_evaluation(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, [NomadClient.Model.AllocationListStub.t()]} | {:error, Tesla.Env.t()}

lists the allocations created or modified for the given evaluation

Parameters

  • connection (NomadClient.Connection): Connection to server
  • eval_id (String.t): Specifies the UUID of the evaluation. This must be the full UUID, not the short 8-character one. This is specified as part of the path
  • 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

Link to this function

get_evaluation(connection, eval_id, opts \\ [])

Specs

get_evaluation(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, NomadClient.Model.Evaluation.t()} | {:error, Tesla.Env.t()}

reads information about a specific evaluation by ID

Parameters

  • connection (NomadClient.Connection): Connection to server
  • eval_id (String.t): Specifies the UUID of the evaluation. This must be the full UUID, not the short 8-character one. This is specified as part of the path
  • 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

Link to this function

get_evaluations(connection, opts \\ [])

Specs

get_evaluations(Tesla.Env.client(), keyword()) ::
  {:ok, [NomadClient.Model.Evaluation.t()]} | {:error, Tesla.Env.t()}

lists all evaluations

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
    • :prefix (String.t): Specifies a string to filter jobs on based on an index prefix. This is specified as a query string parameter

      Returns

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