NomadClient.Api.Variables (nomad_client v0.13.1)
API calls for all endpoints tagged Variables
.
Link to this section Summary
Functions
Parameters
connection
(NomadClient.Connection): Connection to serverpath
(String.t): A path to a Nomad Variablevariable
(Variable):opts
(keyword): Optional parameters:region
(String.t): Filters results based on the specified region.:namespace
(String.t): Filters results based on the specified namespace.:x_nomad_token
(String.t): A Nomad ACL token.:idempotency_token
(String.t): Can be used to ensure operations are only run once.:cas
(integer()): A compare-and-set parameter for Nomad Variables
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
Parameters
connection
(NomadClient.Connection): Connection to serverpath
(String.t): A path to a Nomad Variableopts
(keyword): Optional parameters:region
(String.t): Filters results based on the specified region.:namespace
(String.t): Filters results based on the specified namespace.:index
(integer()): If set, wait until query exceeds given index. Must be provided with WaitParam.:wait
(String.t): Provided with IndexParam to wait for change.:stale
(String.t): If present, results will include stale reads.:prefix
(String.t): Constrains results to jobs that start with the defined prefix:x_nomad_token
(String.t): A Nomad ACL token.:per_page
(integer()): Maximum number of results to return.:next_token
(String.t): Indicates where to start paging for queries that support pagination.
Returns
{:ok, NomadClient.Model.Variable.t}
on success{:error, Tesla.Env.t}
on failure
Parameters
connection
(NomadClient.Connection): Connection to serveropts
(keyword): Optional parameters:region
(String.t): Filters results based on the specified region.:namespace
(String.t): Filters results based on the specified namespace.:index
(integer()): If set, wait until query exceeds given index. Must be provided with WaitParam.:wait
(String.t): Provided with IndexParam to wait for change.:stale
(String.t): If present, results will include stale reads.:prefix
(String.t): Constrains results to jobs that start with the defined prefix:x_nomad_token
(String.t): A Nomad ACL token.:per_page
(integer()): Maximum number of results to return.:next_token
(String.t): Indicates where to start paging for queries that support pagination.
Returns
{:ok, [%VariableMetadata{}, ...]}
on success{:error, Tesla.Env.t}
on failure
Parameters
connection
(NomadClient.Connection): Connection to serverpath
(String.t): A path to a Nomad Variablevariable
(Variable):opts
(keyword): Optional parameters:region
(String.t): Filters results based on the specified region.:namespace
(String.t): Filters results based on the specified namespace.:x_nomad_token
(String.t): A Nomad ACL token.:idempotency_token
(String.t): Can be used to ensure operations are only run once.:cas
(integer()): A compare-and-set parameter for Nomad Variables
Returns
{:ok, NomadClient.Model.Variable.t}
on success{:error, Tesla.Env.t}
on failure
Parameters
connection
(NomadClient.Connection): Connection to serverpath
(String.t): A path to a Nomad Variablevariable
(Variable):opts
(keyword): Optional parameters:region
(String.t): Filters results based on the specified region.:namespace
(String.t): Filters results based on the specified namespace.:x_nomad_token
(String.t): A Nomad ACL token.:idempotency_token
(String.t): Can be used to ensure operations are only run once.:cas
(integer()): A compare-and-set parameter for Nomad Variables
Returns
{:ok, NomadClient.Model.Variable.t}
on success{:error, Tesla.Env.t}
on failure
Link to this section Functions
Link to this function
delete_variable(connection, path, variable, opts \\ [])
@spec delete_variable( Tesla.Env.client(), String.t(), NomadClient.Model.Variable.t(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
parameters
Parameters
connection
(NomadClient.Connection): Connection to serverpath
(String.t): A path to a Nomad Variablevariable
(Variable):opts
(keyword): Optional parameters:region
(String.t): Filters results based on the specified region.:namespace
(String.t): Filters results based on the specified namespace.:x_nomad_token
(String.t): A Nomad ACL token.:idempotency_token
(String.t): Can be used to ensure operations are only run once.:cas
(integer()): A compare-and-set parameter for Nomad Variables
returns
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
Link to this function
get_variable_query(connection, path, opts \\ [])
@spec get_variable_query(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:ok, NomadClient.Model.Variable.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
connection
(NomadClient.Connection): Connection to serverpath
(String.t): A path to a Nomad Variableopts
(keyword): Optional parameters:region
(String.t): Filters results based on the specified region.:namespace
(String.t): Filters results based on the specified namespace.:index
(integer()): If set, wait until query exceeds given index. Must be provided with WaitParam.:wait
(String.t): Provided with IndexParam to wait for change.:stale
(String.t): If present, results will include stale reads.:prefix
(String.t): Constrains results to jobs that start with the defined prefix:x_nomad_token
(String.t): A Nomad ACL token.:per_page
(integer()): Maximum number of results to return.:next_token
(String.t): Indicates where to start paging for queries that support pagination.
returns
Returns
{:ok, NomadClient.Model.Variable.t}
on success{:error, Tesla.Env.t}
on failure
Link to this function
get_variables_list_request(connection, opts \\ [])
@spec get_variables_list_request( Tesla.Env.client(), keyword() ) :: {:ok, nil} | {:ok, [NomadClient.Model.VariableMetadata.t()]} | {:error, Tesla.Env.t()}
parameters
Parameters
connection
(NomadClient.Connection): Connection to serveropts
(keyword): Optional parameters:region
(String.t): Filters results based on the specified region.:namespace
(String.t): Filters results based on the specified namespace.:index
(integer()): If set, wait until query exceeds given index. Must be provided with WaitParam.:wait
(String.t): Provided with IndexParam to wait for change.:stale
(String.t): If present, results will include stale reads.:prefix
(String.t): Constrains results to jobs that start with the defined prefix:x_nomad_token
(String.t): A Nomad ACL token.:per_page
(integer()): Maximum number of results to return.:next_token
(String.t): Indicates where to start paging for queries that support pagination.
returns
Returns
{:ok, [%VariableMetadata{}, ...]}
on success{:error, Tesla.Env.t}
on failure
Link to this function
post_variable(connection, path, variable, opts \\ [])
@spec post_variable( Tesla.Env.client(), String.t(), NomadClient.Model.Variable.t(), keyword() ) :: {:ok, nil} | {:ok, NomadClient.Model.Variable.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
connection
(NomadClient.Connection): Connection to serverpath
(String.t): A path to a Nomad Variablevariable
(Variable):opts
(keyword): Optional parameters:region
(String.t): Filters results based on the specified region.:namespace
(String.t): Filters results based on the specified namespace.:x_nomad_token
(String.t): A Nomad ACL token.:idempotency_token
(String.t): Can be used to ensure operations are only run once.:cas
(integer()): A compare-and-set parameter for Nomad Variables
returns
Returns
{:ok, NomadClient.Model.Variable.t}
on success{:error, Tesla.Env.t}
on failure
Link to this function
put_variable(connection, path, variable, opts \\ [])
@spec put_variable( Tesla.Env.client(), String.t(), NomadClient.Model.Variable.t(), keyword() ) :: {:ok, nil} | {:ok, NomadClient.Model.Variable.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
connection
(NomadClient.Connection): Connection to serverpath
(String.t): A path to a Nomad Variablevariable
(Variable):opts
(keyword): Optional parameters:region
(String.t): Filters results based on the specified region.:namespace
(String.t): Filters results based on the specified namespace.:x_nomad_token
(String.t): A Nomad ACL token.:idempotency_token
(String.t): Can be used to ensure operations are only run once.:cas
(integer()): A compare-and-set parameter for Nomad Variables
returns
Returns
{:ok, NomadClient.Model.Variable.t}
on success{:error, Tesla.Env.t}
on failure