NomadClient.Api.Scaling (nomad_client v0.13.0)
API calls for all endpoints tagged Scaling.
Link to this section Summary
Functions
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, [%ScalingPolicyListStub{}, ...]}on success{:error, Tesla.Env.t}on failure
Parameters
connection(NomadClient.Connection): Connection to serverpolicy_id(String.t): The scaling policy identifier.opts(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.ScalingPolicy.t}on success{:error, Tesla.Env.t}on failure
Link to this section Functions
Link to this function
get_scaling_policies(connection, opts \\ [])
@spec get_scaling_policies( Tesla.Env.client(), keyword() ) :: {:ok, nil} | {:ok, [NomadClient.Model.ScalingPolicyListStub.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, [%ScalingPolicyListStub{}, ...]}on success{:error, Tesla.Env.t}on failure
Link to this function
get_scaling_policy(connection, policy_id, opts \\ [])
@spec get_scaling_policy(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:ok, NomadClient.Model.ScalingPolicy.t()} | {:error, Tesla.Env.t()}
parameters
Parameters
connection(NomadClient.Connection): Connection to serverpolicy_id(String.t): The scaling policy identifier.opts(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.ScalingPolicy.t}on success{:error, Tesla.Env.t}on failure